Information on Operator Console timeout and auto logout

Products

• DX Unified Infrastructure Management (Nimsoft / UIM)

Issue/Introduction

We have a requirement to have the Operator Console auto-logout (session timeout) after 15 minutes. Need best method for having a 15 minute logout in OC.

Environment

Release : 20.4

Component : UIM OPERATOR CONSOLE - WASP & CORE

Resolution

UIM now provides the following token parameters in the wasp.cfg file that help administrators efficiently manage the user sessions:

 

oc.jwt.expiryInSecs

 

Allows administrators to specify the appropriate interval (in seconds) after which the session of the inactive users is expired. After the expiry of the session, when the users try to perform any action in the OC UI, they receive a session timeout expiry message along with the login link.

 

oc.jwt.refreshInterval

 

Allows administrators to configure the refresh interval (in seconds). Based on the specified interval, the session is appropriately refreshed if the user is active in the UI. Ensure that the value of the refresh interval is lower than the session expiry (oc.jwt.expiryInSecs) value.

 

OC users can add: 

 

keep-alive=true

 

parameter to the OC URL to continue working in the UI without any interruption. For example, 

 

http://<OC_server>/operatorconsole_portlet/standalone_login.jsp?keep-alive=true

We also need to  configure the Tomcat Session timeout in 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. Restart wasp probe.

 

Additional Information

As of UIM 20.4, this keep-alive parameter does not carry onto other pages when links are clicked.  If you would like to have this functionality implemented, please vote on this idea:
https://community.broadcom.com/idea/operator-console-url-and-the-keep-alivetrue-parameter