How to configure the maximum age of cached calculations using the QueryCacheEntryMaxAge setting.

How to configure the maximum age of cached calculations using the QueryCacheEntryMaxAge setting.

Spotfire tries to use more RAM to improve performance by caching calculation results. On the TIBCO Spotfire Web Player Instance, 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 default value for the QueryCacheEntryMaxAge setting is infinity for Spotfire 7.5+. The QueryCache increases over time and this can be changed setting the QueryCacheEntryMaxAge. Setting the value to one hour may give slightly longer response times for cases where cached calculations are cleaned but should keep the QueryCache smaller so the heap and the amount to page to disk will be smaller. To configure the QueryCacheEntryMaxAge setting in the web.config file, follow these steps.

1). Open a command-line interface on the TIBCO Spotfire Server and export the service configuration by using the export-service-config command. Specify the Web Player capability and the deployment area:

   export-service-config --capability=WEB_PLAYER --deployment-area=Production
  
By default, the output files are located in the <install dir>\tomcat\bin\config\root directory if you do not specify a source directory

2). Create a back up of the Spotfire.Dxp.Worker.Host.exe.config file.

3). Open the Spotfire.Dxp.Worker.Host.exe.config in a text or XML editor.

4). Find the "<sectionGroup name="applicationSettings" type="System.Configuration.ApplicationSettingsGroup, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">" tag. 

Add the following below it.

   <section name="Spotfire.Dxp.Data.Cxx.Properties.Settings" type="System.Configuration.ClientSettingsSection, System, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false"/> 

5). Find the "<applicationSettings>" tag. 

Add the following below it.

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

6). Save.

7). In the command-line interface, import the configuration file back into Spotfire Server and name the configuration by using the import-service-config command.

   import-service-config --config-name=WebPlayerConfiguration

8). Assign the created configuration to your service.

Option 1:  In the command-line interface, assign the created Spotfire Web Player configuration to the Spotfire Server to make it possible to use for the service:
set-service-config --service-id=value --config-name=WebPlayerConfiguration

Option 2: In the Spotfire Server web interface:
- Nodes & Services > Nodes > Select your service on the left > Click Edit
- In the "Edit service" dialog, select your imported configuration in the "Configuration" drop down.
- Click Update (Note: This will trigger a restart of the instances). Doc:Manually editing the service configuration files

• https://docs.tibco.com/pub/spotfire_server/7.11.1/doc/html/TIB_sfire_server_tsas_admin_help/GUID-958A3AB5-7243-4837-9AEA-78AA274A6F7E.html

Doc: export-service-config

• https://docs.tibco.com/pub/spotfire_server/7.11.1/doc/html/TIB_sfire_server_tsas_admin_help/GUID-5462A06E-20CC-4F42-BCB8-0A66C8EC1C18.html

Doc: import-service-config

• https://docs.tibco.com/pub/spotfire_server/7.11.1/doc/html/TIB_sfire_server_tsas_admin_help/GUID-6D37ADC8-824A-4FC6-9028-94A0CB0061B5.html

From Spotfire 7.0 or lower, see:

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

• https://support.tibco.com/s/article/ka11a000000HrzmAAC/Tibco-KnowledgeArticle-Article-44426