Enabling cached and precomputed data for scheduled update files

Disk caching and precomputations of data shorten the time it takes for a scheduled update file to reopen in a Spotfire Web Player after the Web Player is restarted. This feature is disabled by default. It is enabled at the service level by editing the Spotfire.Dxp.Worker.Web.config file for each installed web client service.

About this task

The cache stores linked data to disk to reduce the time it takes to fetch the data again, if the analysis is unexpectedly closed. However, if data is embedded or stored within the analysis, it already exists in the DXP file and there is no need to store any data in the cache. Therefore, if all data is embedded, there will be no cache for that analysis. Note that there are other things that might take time when opening a DXP file. Common examples of time-consuming actions include visualizations that are computing their contents, or running scripts.

You have the option of turning the caching feature off for individual files (see Disallowing cached and precomputed data in individual scheduled update files).

Note: The scheduled updates cache is not available when running a Web Player service on Linux. This means that if a Linux node running scheduled updates is restarted, scheduled updates must load the data from the sources again, rather than reading data from the cache on disk.

Procedure

Open a command line and export the service configuration by using the export-service-config command.

Open the Spotfire.Dxp.Worker.Web.config file in a text editor or XML editor and locate the following section. By default, the exported configuration file is saved to the <installation dir>\tomcat\spotfire-bin\config\root directory.

<scheduledUpdates concurrentUpdates="2" updateIntervalSeconds="60">
        <forcedUpdate enabled="true" maximumRejectedUpdates="2"/>
        <cacheSettings enabled="false" path="" maxDiskSizeMb="0" maxAgeMinutes="1440"/>
      </scheduledUpdates>

In the line <cacheSettings enabled="false" path="" maxDiskSizeMb="0" maxAgeMinutes="1440"/>, make these changes:
- Set cacheSettings enabled to "true".
- Set path to the path on disk where the data is to be stored.
For information on the other settings, see Spotfire.Dxp.Worker.Web.config.
Import the configuration back into Spotfire Server by using the import-service-config command.
Assign the edited service configuration to the Spotfire Server by using the set-service-config command.
Example:
```
config set-service-config --service-id=6610a31b-1a2a-4497-b146-cee797f9b6a7
```
Tip: Use the list-services command to obtain the service ID.