38.2 Analytics settings

Analytics settings

Setting

Description

Default relative period for analysis

Defines the relative period to use by default in analytics app: Data Visualizer , Event Reports , Event Visualizer , GIS and Pivot Table apps. The relative period will be automatically selected when you open these apps.

Recommended setting: the most commonly used relative period among your users.

Financial year relative start month Defines which month (April, July or October) the the relative financial year in the analytics apps should begin on.

Cacheability

Sets whether analytics data responses should be served with public or private visibility.

Private : Any node or server between the DHIS2 server and the end user which has the ability to cache can NOT cache the web page. This is useful if the page served can or do contain sensitive information. This means that each time you want a web page, either you get a new page from the DHIS2 server, or the DHIS2 server caches the page. No other server than the DHIS2 server are allowed to cache the page.

Public : Any node or server between the DHIS2 server and the end user which has the ability to cache can cache the web page. This relives the traffic to the DHIS2 server and potentially speeds up the subsequent page loading speed.

Cache strategy

Decides for how long reports analytics responses should be cached.

If you use the scheduled, nightly analytics update, select Cache until 6 AM tomorrow . This is because data in reports change at that time, and you can safely cache data up to the moment when the analytics tables are updated.

If you are loading data continuously into the analytics tables, select No cache .

Max number of years to hide unapproved data in analytics

Sets whether and for how long back in time analytics should respect the approval level of the data. Typically, data which is several years old would be considered to be approved by default. In order to speed up analytics requests, you can choose to ignore the actual approval level of historical data.

Never check approval : no data will be hidden, irrespective of its data approval status.

Check approval for all data : approval status will always be checked.

Other options, for example Last 3 years : approval status will be checked for data which is newer than 3 years old; older data will not be checked.

Threshold for analytics data caching

Sets whether to enable caching data older than the specified number of years only.

This allows for returning the most recent data directly with no caching, while serving cached version of older data for performance concerns.

Respect category option start and end date in analytics table export

This setting controls whether analytics should filter data which is associated with a category option with a start and end date, but which is not associated with a period within the category options interval of validity.

Put analytics in maintenance mode

Places the analytics and web API of DHIS2 in maintenance mode. This means that “503 Service Unavailable” will be returned for all requests.

This is useful when you need to perform maintenance on the server, for example rebuilding indexes while the server is running in production, in order to reduce load and more efficiently carry out the maintenance.