Configuring the Settings to Extend User Sessions

Last updated
Save as PDF
Share
1. Share
2. Tweet
3. Share

Introduction

Primo allows signed-in users to extend their sessions by configuring the following extension options:

Extend the session – When enabled, users will receive the following warning prompt 60 seconds before timeout, and it will enable them to extend their sessions for another session.

Extend Session Prompt

If users select Yes, Keep Me Signed In, their sessions are extended without interruption.

If users select No, Sign Me Out, they are signed out, their screens are refreshed, and they are redirected to the configured URL for timeouts.

If users do not respond before timeout, they will receive the following toast message, indicating that their session has timed out:

Session Timed Out
Extend the session to maximum – When enabled, users will receive a message 60 seconds before timeout (see messages above), allowing them to extend their sessions on all devices to the maximum period (which is 7 days and is not configurable). If users do not want to continue their session, they are signed out, the screen is refreshed, and the UI redirects to the configured URL for timeouts.
Automatic session extension – When enabled, this parameter adds the Automatically extend my session option to the My Library Card > Personal Details and Settings tab, which enables users to automatically extend their sessions without being prompted to extend their sessions.

Automatically Extend My Session Option

After enabling/disabling the Automatically extend my session option, users must sign out and sign in again to apply the change.

If the session times out while the Automatically extend my session option is disabled, users will receive the following toast message and be prompted to either sign in or dismiss the message:

Personal Settings Reminder

Configuration Options

This functionality is not enabled by default and requires configuration at the institution level. The following table lists the required and optional configuration associated with this functionality.

Configuration Element	Description
Institution Properties mapping table (Primo Home > General > Mapping Tables)	The following parameters configure the extension of user sessions: enable_extending_the_session – By default, this field is set to false. enable_extending_the_session_to_maximum – By default, this field is set to false. If both of the above parameters are enabled, enable_extending_the_session_to_maximum has precedence. allow_user_extend_session_personal_settings – By default, this field is set to false. When set to true, the display_user_settings parameter must also be set to true. For more details, see Configuring Institution Properties in Primo.
User Tile code table (Primo Home > General > Code Tables)	The following codes were added to support the display functionality for this enhancement: default.nui.eshelf.signin.timeoutWarningTitle – Session Timeout default.nui.eshelf.signin.timeoutWarning – Your session is about to timeout. Do you want to stay signed in? default.nui.eshelf.signin.timeoutExtendSession – Yes, keep me signed in default.nui.eshelf.signin.timeoutExtendSessionNo – No, sign me out default.nui.login.sessionTimedOut – Your session has timed out default.nui.login.sessionTimedOutPersonalSettings – Your session has timed out. Note that you can choose to automatically extend your session under your Personal Settings
My preferences Tile (Primo Home > General > Code Tables)	The following codes were added to support the display functionality for this enhancement: default.nui.mypref.label.extendMySession – Automatically extend my session default.nui.mypref.label.extendMySessionShowMore – (Show more info) default.nui.mypref.label.extendMySessionInfo – When enabling this setting, your session will be automatically extended and won't be timed out from any device you are logged in from. In order for this setting to take effect you must log out and login again or refresh the page
aria Labels code table (Primo Home > General > Code Tables)	The following codes were added to support accessibility for this enhancement: default.nui.aria.session.keepMeSigndIn – Yes, keep me signed in default.nui.aria.session.signMeOut – No, sign me out default.nui.aria.session.sessionTimedOut – Your session was timed out due to inactivity

Analytics - Extend Session Options

Primo Analytics tracks the following actions in the Action Usage subject area to support this functionality:

Group	Subgroup	Action	Description
General	General	Enable extending the session automatically for the user	The user enabled the setting to extend the session automatically.
		Disable extending the session automatically for the user	The user disabled the setting to extend the session automatically.
		Click on Show more info for extend my session setting	The user selected (Show more info) to display information about the setting.
		Extend the session	The user selected to extend the session.