Setting the TM1 Web session timeout

The default TM1® Web session timeout is 20 minutes. When TM1 websheets are deployed to IBM® Planning Analytics Workspace, you might encounter TM1 Web session timeouts. You can modify this setting in your environment.

About this task

When TM1 websheets are deployed to Planning Analytics Workspace, the recommended session timeout is 60 minutes.

Note: As of IBM Planning Analytics Local version 2.0.6, you must not change the session-timeout value in the web.xml file.

In IBM Planning Analytics Local version 2.0.6, there is a parameter in the tm1web_config.xml file called HttpSessionTimeout. You can use this parameter to customize the session timeout (in minutes) of the HTTP session for TM1 Web.

If the HttpSessionTimeout parameter is not specified (missing or blank), the value is less than 1 or not a numerical value, the default session-timeout that is defined in the web.xml file is used.

If you are using IBM Planning Analytics Local version 2.0.6 or later, to customize the session timeout for TM1 Web, set the HttpSessionTimeout parameter in tm1web_config.xml. See step 1.

If you are using IBM Planning Analytics Local version 2.0.5 or earlier, to change the default session timeout, set the <session-timeout> parameter in web.xml. See step 2.

Procedure

To customize the session timeout, follow these steps.
1. Open thetm1web_config.xml in a text editor.
  The tm1web_config.xml file is located in your <pa_installation_directory>\webapps\tm1web\WEB-INF\configuration directory.
  For example, C:\Program Files\IBM\cognos\tm1_64\webapps\tm1web\WEB-INF\configuration.
2. Change the HttpSessionTimeout to 60 or a value that is required by your environment.
```
<add key="HttpSessionTimeout" value="60" />
```
3. Save and close the tm1web_config.xml.
If you are using IBM Planning Analytics Local version 2.0.5 or earlier, to change the default session timeout, follow these steps.
1. Open web.xml in a text editor.
  The web.xml file is located in your <pa_installation_directory>\webapps\tm1web\WEB-INF directory.
  For example, C:\Program Files\IBM\cognos\tm1_64\webapps\tm1web\WEB-INF.
2. Change the <session-timeout> value to 60 or a value that is required by your environment.
```
<session-config>
    <session-timeout>20</session-timeout>
</session-config>
```
3. Save and close web.xml.
Restart the IBM TM1 Application Server service.