TIBCO Spotfire® Server and Environment - Installation and Administration

Changing the settings that determine when Web Player instances are recycled due to low temporary disk space

By default, Spotfire recycles Web Player instances if their temporary disk space falls below 1500 MB (the "exhausted" level), and remains below that level for one hour. When a service instance is recycled, the corresponding process is restarted; all open analyses on that instance are closed and its temp files are removed. You can change the definition of "exhausted" and the period of time that trigger Web Player recycling.

About this task

Only experienced administrators should edit these values.

Procedure

  1. On the computer running Spotfire Server, open a command line as an administrator and change the directory to the location of the config.bat file (config.sh on Linux). The default location is <server installation dir>/tomcat/spotfire-bin.
  2. On the command line, export the service configuration that you want to modify from Spotfire Server by using the export-service-config command. Specify the service's capability and the deployment area, and optionally the configuration name.
    Important: If you are editing a service configuration that has been applied to an existing service, you must verify the name of the active service configuration before you export it. If the name of the active configuration is not "Default", you must specify the name in the export command.
    Example for exporting the "Default" Web Player configuration that is in the Production deployment area:
    config export-service-config --capability=WEB_PLAYER --deployment-area=Production
    Example for exporting a customized configuration:
    config export-service-config --config-name=WebPlayerConfiguration
    For more information, see Manually editing the service configuration files.
  3. Edit the period of time that the Web Player service must remain exhausted to trigger recycling:
    1. Open the following file in an XML editor or a text editor: <server installation dir>\tomcat\spotfire-bin\config\root\Spotfire.Dxp.Worker.Web.config.
    2. In the file, locate the recycleWhenOutOfDiskEnabled setting:
      Configuration code that starts with "<recoverMemory"
    3. Make sure that the recycleWhenOutOfDiskEnabled setting equals "true".
    4. Edit the time period by changing the value of the recycleWhenOutOfDiskAfter setting in the format "hh:mm:ss".
    5. Save and close the file.
  4. Edit the amount of free disk space below which recycling is triggered (after the time period specified in step 3d):
    1. Open the following file in an XML editor or a text editor: <server installation dir>\tomcat\spotfire-bin\config\root\Spotfire.Dxp.Worker.Host.exe.config.
    2. In the file, locate the "Health_ExhaustedTempDiskMb" setting:
      Configuration text around "Health_ExhaustedTempDiskMb"
    3. Edit the value, in MB, that represents the "exhausted" state by changing the "Health_ExhaustedTempDiskMb" setting.
    4. Save and close the file.
  5. On the command line, import the customized configuration back into Spotfire Server and name the configuration by using the import-service-config command.
    Note: If the configuration to be imported was created from the default configuration, a name must be specified.
    Important: If you are editing already customized configuration files, specifying a name when importing will create a new service configuration. If you import the changed customized configuration without the --config-name parameter, the old customized configuration will be replaced.
    Example
    config import-service-config --config-name=ServiceConfiguration
    When you install a new service or edit an existing one, you can select the new customized configuration.
  6. Optional: To activate the customized configuration for an existing service, enter the following command on the command line:
    config set-service-config --service-id=value --config-name=ServiceConfiguration
    Tip: Use the list-services command to obtain the service ID.
    Note: Activating the configuration for a Spotfire Web Player service causes its instances to restart.