ReportService.CacheHours

<< Click to Display Table of Contents >>

EQuIS 7  >>  Configuration > ST_CONFIG Entries > EarthSoft.Reports >

ReportService.CacheHours

Report Caching is a performance feature of the EQuIS Enterprise Web Application. It allows the web application to save the output of a report, and then return that data when another request is made within the cache limit. This can improve the responsiveness of the web application tremendously. For example, if a dashboard references the same user report in four (4) different widgets and report caching is disabled, the web application has to run the same report four (4) times before the dashboard can be displayed. Report Caching allows that report to be run once and referenced 4 times.

 

EQuIS Version: v6.3 and later

 

Namespace: EarthSoft.Server

 

Products Affected: Enterprise

 

Requires Module: Enterprise Web Application

 

ST_CONFIG

VALUE

REMARK

VALID VALUES

CONFIG_SECTION

ReportService

Required


CONFIG_KEY

CacheHours

Required


OBJECT_TYPE

user_id

Optional

string literal 'user_id'

OBJECT_VALUE

<user_id>

Optional


STRING_VALUE

positive integer value

Required

Integer value >= 0 where 0 means no caching should be performed.

 

Remarks:

 

No default setting is defined. Caching is disabled by default and must be enabled by each user through their profile or an EQuIS administrator by adding a record in ST_CONFIG manually. An EQuIS Administrator may set a default cache time for all users that have not specified one for them self by creating an entry with only config_section, config_key and string_value populated.

 

Report caching works by making a creating a checksum of all report parameters at run time. If a report parameter is set to a macro value like CURRENT DATE the checksum is computed with the actual date at the time the report was run.

 

A cached report is identified based on three factors: (1) the underlying report (report_id), (2) the user who executed the report, and (3) the checksum of all parameter values when the report is run. User A will not be sent the output of user B's report, even though the same parameter values are used. It does not matter where the report is referenced. If user A referenced the same user report on multiple widgets spread across multiple dashboards, so long as the cached report has not expired, it will be used for all references.

 

Note: There is a bug in EQuIS Enterprise 6.3 web application that incorrectly displays 0 for the cache expiration. Setting the value will still work correctly, even though it is displayed incorrectly. If troubleshooting report cache issues, EQuIS 6.3 users should review ST_CONFIG to determine the actual value.

 

Example: Set the default cache to four (4) hours. The user with user_id=12345 has disabled caching through their EQuIS Enterprise Web Application user profile.

 

config_section

config_key

object_type

object_value

string_value

ReportService

CacheHours



4

ReportService

CacheHours

user_id

12345

0