How to increase the timeout period for communication between TIBCO Spotfire Automation Services and the TIBCO Spotfire Server

How to increase the timeout period for communication between TIBCO Spotfire Automation Services and the TIBCO Spotfire Server

book

Article ID: KB0083972

calendar_today

Updated On:

Products Versions
Spotfire Automation Services 7.5 and forward

Description

By default this setting is not exposed as a configurable setting but it is possible to change this. The default value for this setting is 3600000 milliseconds. Since this is a large value, there will rarely be a need to increase it. However, if you are working with large or complex analyses that take a lot of time to open and work with, you may not be able to complete the task/job that you have scheduled as the duration of it exceeds the timeout period and communication to the TIBCO Spotfire Server side is killed. If you look in the logs and see a timeout specified as the reason with the above value, it is most likely that this is the timeout that you are hitting. In these cases, you can follow the steps below to increase the timeout period.

Issue/Introduction

This article explains how to increase the timeout period for the communication between the TIBCO Spofire Automation Services server and the TIBCO Spotfire Server. This can be good in cases where you have large, long running tasks that hits a timeout after 3600000 ms.

Resolution

To change this value, follow the steps outlined below.

1). Export the Automation Services configuration, using the command line config tool. For example:
config.bat export-service-config --capability=AUTOMATION_SERVICES --deployment-area=Production
By default, the configuration files are exported in the [TIBCO Spotfire Server installation direcotry]\tomcat\bin\config\root directory.

2). Open the file Spotfire.Dxp.Worker.Core.config in an editor.

3). Find the following section.
<!-- Settings for the communication with the TIBCO Spotfire Server -->
  <Spotfire.Dxp.Services.Settings httpLoggingEnabled="false">
    <!-- Cookies from the TIBCO Spotfire Server that should be sent back on all requests: -->
    <!-- a ; separated list, example: "ARRAffinity;myCookie;myCookie2" -->
    <cookies autoTransfer="" />
  </Spotfire.Dxp.Services.Settings>

4). Add the following section.
<timeout value="X" />
where X is your new timeout value. For example:
<!-- Settings for the communication with the TIBCO Spotfire Server -->
  <Spotfire.Dxp.Services.Settings httpLoggingEnabled="false">
    <!-- Cookies from the TIBCO Spotfire Server that should be sent back on all requests: -->
    <!-- a ; separated list, example: "ARRAffinity;myCookie;myCookie2" -->
    <cookies autoTransfer="" />
	<timeout value="5000000" />
  </Spotfire.Dxp.Services.Settings>

5). In the command-line interface, import the configuration file back into Spotfire Server and name the configuration by using the import-service-config command. Example:
config.bat import-service-config --config-name=AutomationConfiguration

6). In the command-line interface, set the configuration on the Automation Services service that you want using the set-service-config command. Example :
config.bat set-service-config --service-id=value –config-name=AutomationConfiguration
where "value" is service ID.