How to configure the maximum age of cached calculations, using the QueryCacheEntryMaxAge setting (Versions 7.0 and lower). – Revvity Signals

Date Posted: 2018-11-20
Product: TIBCO Spotfire®

Problem:

How to configure the maximum age of cached calculations, using the QueryCacheEntryMaxAge setting (Versions 7.0 and lower).

Solution:

Spotfire versions 5.0 to 7.0 try to use more RAM to improve performance by caching calculation results. On the TIBCO Spotfire Web Player, this cache memory is released when necessary (in low memory situations). When Scheduled Updates loads a report, the calculations and data table relations for the initial state of the report will be cached here as well.

The entry “Memory Used For Caching Calculations” under the “Web Server” tab on the Web Player Server diagnostics page displays the amount of memory currently in use by cached calculations. Note: for Spotfire 5.0 this requires client hotfix TS 5.0.1 HF-009 or higher, and for Spotfire 5.5 it requires client hotfix TS 5.5.0 HF-002 or higher. The default maximum age of this cache is 1 hour, but this can be modified in the web.config file as described below.

Note: For Spotfire 7.5 and higher, see KBA 000030592:

How to configure the maximum age of cached calculations, using the QueryCacheEntryMaxAge setting:
https://support.tibco.com/s/article/How-to-configure-the-maximum-age-of-cached-calculations-using-the-QueryCacheEntryMaxAge-setting

The default value for the QueryCacheEntryMaxAge setting is 1 hour.

To configure the QueryCacheEntryMaxAge setting, follow these steps:

1. Edit the web.config file in a plain text editor (like Notepad)

2. Find the following section:

<applicationSettings>
    <!-- You normally shouldn't edit these settings. -->

3. Add the following (this example sets a QueryCacheEntryMaxAge of 1 day, using the time span format D.HH:MM:SS):

<Spotfire.Dxp.Data.Cxx.Properties.Settings>
     <setting name="QueryCacheEntryMaxAge" serializeAs="String">
       <value>1.00:00:00</value>
     </setting>
   </Spotfire.Dxp.Data.Cxx.Properties.Settings>

Resulting in:

<applicationSettings>
   <Spotfire.Dxp.Data.Cxx.Properties.Settings>
     <setting name="QueryCacheEntryMaxAge" serializeAs="String">
       <value>1.00:00:00</value>
     </setting>
   </Spotfire.Dxp.Data.Cxx.Properties.Settings>
    <!-- You normally shouldn't edit these settings. -->

You can modify the maximum cache age as required. For example, if you have a report that is cached in Scheduled Updates once per day, then this QueryCacheEntryMaxAge could be set to 1 day, to ensure that these calculated relations are maintained in cache for the entire length of time the report is available in the cache. Note that this cache will be cleared on any low memory condition, even if the maximum cache age is not reached.

For Spotfire 7.5 and higher, see:

KB: 000030592 How to configure the maximum age of cached calculations, using the QueryCacheEntryMaxAge setting:

https://support.tibco.com/s/article/How-to-configure-the-maximum-age-of-cached-calculations-using-the-QueryCacheEntryMaxAge-setting