How to set inactivity timeout in Spotfire Web Player Services

How to set inactivity timeout in Spotfire Web Player Services

InactivityTimeout specifies the time that an analysis session can be alive when no user activity has been detected, excluding pings. The default value is 02:00:00 (2 Hours).

This article describes how to set inactivity timeout setting in Spotfire for Web Player Services. There is an option to set inactivity timeout for the Web Player Services in 'Spotfire.Dxp.Worker.Web.config' file.

Follow the below steps:
==========================
1) Go to Spotfire Server and open a command line interface to export the service configuration files from Spotfire Server, specifying the Web Player capability and the deployment area.

Export command:-  <install_dir>\tomcat\bin\config export-service-config --capability=WEB_PLAYER --deployment-area=Production

This will create a folder called "config" under the path  C:\Tibco\tss\7.x.x\tomcat\bin\


2) Specify the length of time, in the format HH:MM:SS, that an analysis session can be alive when no user activity has been detected, excluding pings. The range is 00:01:00 to Infinite.
   The default value is 02:00:00 (2 Hours)

   >> Open file C:\Tibco\tss\7.x.x\tomcat\bin\config\root\Spotfire.Dxp.Worker.Web.config in a text editor (Notepad/Notepad++)
   >> Search for the attribute "inactivityTimeout" under "analysis" section as shown below, and set appropriate value.

  ========
<analysis
        antiAliasEnabled="true"
        useClearType="true"
        documentStateEnabled="true"
        closedTimeout="120"
        checkClosedInterval="60"
        inactivityTimeout="02:00:00"
        checkInactivityInterval="300"
        regularPollChangesInterval="500"
        maxPollChangesInterval="3000"
        pollLoadInterval="1000"
        needsRefreshInterval="15"
        privateThreadPoolEnabled="true"
        privateThreadPoolWorkerCount="1"
        toolTipDelay="1000"
        undoRedoEnabled="true"
        maxRenderTimeMs="60000"
        maxAnalysisShutdownInformations="1024"/>
=======

 >> Save the Spotfire.Dxp.Worker.Web.config file.

3) After editing the configuration, run import-service-config command to import the configuration files to Spotfire Server and give the configuration name.

Import command:-  <install_dir>\tomcat\bin\config import-service-config --config-name="inactivityTimeout"

4) Log into Spotfire Admin UI as administrator and navigate to "Nodes & Services". Edit the Web Player Service to use the updated configuration. Look for the "config-name" value that you entered while importing the service configuration and save it.
OR
5) Run set-server-service-config command to set the configuration for a service running in Spotfire Server.

Note: After setting the configuration, you must restart the Spotfire Server and Node Manager Server.

Example command:-  config set-server-service-config --capability=WEB_PLAYER --config-name="inactivityTimeout"
==========================

Note: This setting is Web Player specific and it applies at the service level. It is only applicable for the Web Player Analysis pages.
Note: In Spotfire Versions 10.3 and higher the service config commands need to be executed from "<installation folder>\tss\10.3.0\tomcat\spotfire-bin" export-service-config
https://docs.tibco.com/pub/spotfire_server/7.10.2/doc/html/TIB_sfire_server_tsas_admin_help/GUID-5462A06E-20CC-4F42-BCB8-0A66C8EC1C18.html

import-service-config
https://docs.tibco.com/pub/spotfire_server/7.10.2/doc/html/TIB_sfire_server_tsas_admin_help/GUID-6D37ADC8-824A-4FC6-9028-94A0CB0061B5.html

set-server-service-config
https://docs.tibco.com/pub/spotfire_server/7.10.2/doc/html/TIB_sfire_server_tsas_admin_help/GUID-2F303E7A-DAD8-4615-B7F8-423B18375AD0.html