Altair® Panopticon

 

Automatic Logout of Users on Timeout to Save Unused Licenses

Users who have no activity and leave their browsers open may be logged out and their license units are checked out by setting the following properties in the Panopticon.properties file:

 

 

Property

Timeout Session

Attribute

timeout.session.enabled

Description

Boolean value stating if timeout functionality should be used or not.

Default Value

false

Property

Timeout Session

Attribute

timeout.session.exception.delimiter

Description

The delimiter to use for the usernames stated in the timeout.session.exception.usernames property.

Default Value

, (comma)

Property

Timeout Session

Attribute

timeout.session.exception.usernames

Description

Usernames that should be excluded from the timeout functionality. Separated by the delimiter stated in the timeout.session.exception.delimiter property.

Default Value

 

Property

Timeout Session

Attribute

timeout.session.minutes

Description

Minutes of inactivity before a user session is terminated by logging out the user.

Default Value

480

Property

Timeout Session

Attribute

timeout.session.notification.minutes

Description

Minutes before a timeout that a notification about session timeout is sent to the user.

Default Value

1

 

 NOTE

·         The timeout functionality is only enabled if property timeout.session.enabled is set to true.

·         Each time a user actively interacts with the server, the timeout timer for that user is reset. Just sitting idle on a tab in the UI or having a dashboard open will not reset the timer.

·         If timeout.session.notification.minutes has been set to a value > 0, a notification will be sent to the user on an established notification subscription on the websocket, X minutes before the timeout happens. This is the format of the timeout notification:

{"TimeoutNotification":{"minutesUntilTimeout":1}}

·         When a session times out, a logout notification will be sent on an established notification subscription on the WebSocket. This is the format of the logout notification:

{"LogoutNotification":{"reason":"Logged out due to session timeout"}}

·         To abort a session timeout, all that is required is that the user interacts with the server. To facilitate the process there is a new service that can be called using GET on URL /rest/user/timeout/reset that will reset the timeout for the calling user. The service itself does not do anything, but the layers the message interacts with before reaching the service will count it as a user activity and resets the timeout.