AX1846

Enabling Axiom session timeouts

You can optionally enable and configure session timeout behavior for Axiom, so that user sessions will expire if the application remains open but the user has gone inactive. By default, open Axiom sessions do not time out.

Session timeout behavior can be configured separately for the Desktop Client (Excel and Windows) versus the Web Client (browser). If you enable session timeouts, you can configure:

How long the session must be inactive before the session expires
Whether the user is warned before the session expires, and if so, when to show the warning

Desktop client session timeout

If you want to enable session timeout behavior for the Desktop Client, use the following system configuration settings:

Item	Description
SessionTimeout_DesktopClient	The number of minutes of inactivity before a Desktop Client session expires. If set to 0, then sessions do not time out. The user session will expire if no activity has occurred on the desktop for the configured number of minutes. Activity is defined as mouse motion or key presses in any application on the user's desktop.
SessionTimeoutWarning_DesktopClient	The warning period, in minutes, before the Desktop Client session expires. If defined, then a warning message will be shown to the user to let them know that the session is about to expire. If set to 0, then no warning message displays. If the warning message displays, the user can reset the session timer by clicking OK on the warning message, or by resuming any other activity on the desktop. This setting only applies if the SessionTimeout_DesktopClient is set to a value greater than 0.

Item

Description

SessionTimeout_DesktopClient

The number of minutes of inactivity before a Desktop Client session expires. If set to 0, then sessions do not time out.

The user session will expire if no activity has occurred on the desktop for the configured number of minutes. Activity is defined as mouse motion or key presses in any application on the user's desktop.

SessionTimeoutWarning_DesktopClient

The warning period, in minutes, before the Desktop Client session expires. If defined, then a warning message will be shown to the user to let them know that the session is about to expire. If set to 0, then no warning message displays.

If the warning message displays, the user can reset the session timer by clicking OK on the warning message, or by resuming any other activity on the desktop.

This setting only applies if the SessionTimeout_DesktopClient is set to a value greater than 0.

For example, imagine that the session timeout is set to 30 minutes and the warning is set to 3 minutes. If no activity occurs on the desktop for 27 minutes, the warning message will display. If the user dismisses the warning message or resumes any other activity on the desktop, the session timer is reset. However, if the desktop remains idle, the Axiom session will expire 3 minutes later, when the full 30 minute timeout value is reached. When the session expires, the Axiom Desktop Client is closed and any unsaved changes in the session are lost.

The system configuration settings for the Desktop Client timeout can be viewed using an Axiom query to Axiom.SystemConfiguration and can be edited using Save Type 4. For more information, see System configuration settings.

Web client session timeout

If you want to enable session timeout behavior for the Web Client, use the following system configuration settings:

Item	Description
SessionTimeout_WebClient	The number of minutes of inactivity before a Web Client session expires. If set to 0, then sessions do not time out. The Web Client timeout is tracked for each browser session where the user is viewing an Axiom asset. The session will expire if no activity has occurred in the browser session for the configured number of minutes, across all Axiom tabs in the session. Activity is defined as mouse motion or clicks, key presses, or touch events within that browser session.
SessionTimeoutWarning_WebClient	The warning period, in minutes, before the session expires. If defined, then a warning message will be shown to the user to let them know that the session is about to expire. If set to 0, then no warning message displays. If the warning message displays, the user can reset the session timer by clicking OK on the warning message, or by resuming any other activity in the browser session. This setting only applies if the SessionTimeout_WebClient is set to a value greater than 0.

Item

Description

SessionTimeout_WebClient

The number of minutes of inactivity before a Web Client session expires. If set to 0, then sessions do not time out.

The Web Client timeout is tracked for each browser session where the user is viewing an Axiom asset. The session will expire if no activity has occurred in the browser session for the configured number of minutes, across all Axiom tabs in the session. Activity is defined as mouse motion or clicks, key presses, or touch events within that browser session.

SessionTimeoutWarning_WebClient

The warning period, in minutes, before the session expires. If defined, then a warning message will be shown to the user to let them know that the session is about to expire. If set to 0, then no warning message displays.

If the warning message displays, the user can reset the session timer by clicking OK on the warning message, or by resuming any other activity in the browser session.

This setting only applies if the SessionTimeout_WebClient is set to a value greater than 0.

For example, imagine that the session timeout is set to 30 minutes and the warning is set to 3 minutes. If no activity occurs in the browser session for 27 minutes, the warning message will display. If the user dismisses the warning message or resumes any other activity in the session, the session timer is reset. However, if the browser session remains idle, the Axiom session will expire 3 minutes later, when the full 30 minute timeout value is reached. When the session expires, the browser tab remains open but the content is redirected to the session logout screen. Any unsaved changes in the session are lost.

The system configuration settings for the Web Client timeout are not returned by an Axiom query to Axiom.SystemConfiguration. For on-premise clients, these settings can be viewed and configured using the Axiom Software Manager on the Axiom Application Server (Installation Manager > Configure System Properties). Axiom Cloud clients should contact Axiom Support for assistance if they want to enable session timeout behavior for the Web Client.