Operator Console OC timeout settings in DX UIM 20.x versions
search cancel

Operator Console OC timeout settings in DX UIM 20.x versions

book

Article ID: 202536

calendar_today

Updated On:

Products

DX Unified Infrastructure Management (Nimsoft / UIM) CA Unified Infrastructure Management On-Premise (Nimsoft / UIM) CA Unified Infrastructure Management SaaS (Nimsoft / UIM)

Issue/Introduction

Is it possible to modify the user session timeout settings for the Operator Console?

Environment

Releases:

  • UIM 20.1
  • UIM 20.3.2
  • UIM 20.4

Cause

  • Guidance for OC end-user/browser session timeout settings

Resolution


UIM 20.1 and earlier


Please follow the steps below:

== Session TimeOut configuration at the following file system location:

...\Nimsoft\probes\service\wasp\webapps\root\web-inf\classes\portal-ext.properties

Default values:

session.timeout= | session.timeout.warning=|   session.timeout.auto.extend=true

(This will timeout after 5 minutes and automatically request an extension after one minute as long as the user is currently browsing.


== Also to the file nimsoft\probes\service\wasp\webapps\root\web-inf\web.xml

<session-config> 

  <session-timeout>30</session-timeout> 

   </session-config>

 

UIM 20.3


This functionality is only available in OC v20.3.2 - it was overlooked in 20.3 and 20.3.1

UIM 20.3.2 or higher:

You can look in the Operator Console robot in the following location:

Windows:  ...\Program Files (x86)\Nimsoft\probes\service\wasp\conf\
Linux:  /opt/nimsoft/probes/service/wasp/conf/

In this location, you will find a file called config.properties which you can edit with the Text Editor of your choice.

Look for this section:

# Time out after five minutes, but automatically request an extension after one
# minute as long as the user is currently browsing to a portal page.
# The timeout is really configured in ../web.xml.

session.timeout=5
session.timeout.warning=1
session.timeout.auto.extend=true

Change the timeouts here, and then change the following setting in the wasp.cfg on the Operator Console to match:

oc.jwt.expiryInSecs = <###>

This is set in seconds and should match the setting in config.properties (which is in minutes).

In other words, if you set config.properties to 15 for a 15-minute timeout, set oc.jtw.expiryInSecs to 900.

OR

To configure 24-hour session, please make the following changes.

Open wasp.cfg in any text editor within Operator Console server(s). Update the following keys with highlighted values.

    oc.jwt.expiryInSecs = 86400
    oc.jwt.refreshInterval = 3600

You must also configure the Tomcat Session timeout in the web.xml file

1. On the Operator-Console server(s), open {UIMInstallFolder}\probes\service\wasp\webapps\operatorconsole_portlet\WEB-INF\web.xml file in any text editor.
2. Add session-config section (highlighted below) under web-app tag. 

    <web-app xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" id="WebApp_ID" version="2.4" xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">

    <!-- EXISTING SECTIONS -->

       <session-config>
            <session-timeout>1440</session-timeout>
        </session-config>    
    </web-app>

3. Save and close the file.

4. Cold start the wasp probe (Deactivate-Activate).