Configure user session persistance

 

+

Search Tips   |   Advanced Search

 

With the persistent session state feature, portal users can resume and continue a previously interrupted working session at the same state where they left the session. When the user logs out or the session times out, the portal stores the current navigational state into the database. The administrator can give users the option to resume the navigational state of their last session when logging in again. When the user chooses to resume the last session, the navigational state stored previously is restored, and the user can continue working where the user stopped before.

Example: A user logs in and maximizes some portlets. Afterwards the user logs out. When the user logs in again, all of the previously maximized portlets are still maximized.

Session settings stored by the portal

After a user logs out or the session times out, the portal stores the complete navigational state into the database. This includes the following navigational state information:

• Portlet states:
  • Normal
  • Minimized
  • Maximized
• Portlet modes:
  • config
  • edit_defaults
  • edit
  • view
  • help
• Page selection:
  • The last page that was active before the user logged out.

Resuming the session state is only possible if either the portal theme login link or WAS TAI based authentication is used to login to the portal. Whenever a URL is directly used to login or address a resource, this will overwrite the complete session state that is to be resumed and address the named resource with the default states and modes for its portlets.

For example, this occurs when users use...

../wps/myportal/

...or...

../wps/myportal/name/

...for a URL mapping or friendly name

User option during login

Depending on the configuration defined by the administrator, the user can choose whether to resume the last session or not. If the portal administrator has enabled the resume option for users, the login page displays a check box Resume last session. If the user selects this check box, the previous session is resumed. Otherwise the previous session is not resumed and the user starts as if logging in for the first time. The options that administrators can set are described in the following sections.

How administrators define persistent session options

Administrators can configure the persistent session behavior by setting the following properties:

persistent.session.option

Whether the login portlet (or the login screen respectively) displays a check box that enables the user to decide whether to resume the session or not. For details refer to Giving users the resume option.

persistent.session.level

Which navigational state information should be restored when resuming the session. The administrator can choose from three predefined levels. For details refer to Set the session resume level for users.

timeout.resume.session = (false)

Whether resuming the session after a session timeout requires user authentication. Default is false. If this property is set to false and the user tries to continue working after a session timeout, the portal shows an error message stating that the session has timed out and the user has to log in again. If set to true, the portal ignores the session timeout and does not show the error message. The user can resume the previous session without authentication and continue to work. In both cases the previous session is resumed according to the setting of the persisted.session.level property described above.

Administrators set these properties in Configuration Service, as described in Set service configuration properties. The following sections describe these properties in more detail.

Giving users the resume option

Portal administrators can define whether users have the option to resume their last session during login. They do this by setting the property persistent.session.option in the Configuration Service, as described in Set service configuration properties. They can configure the property to one of two settings: 0 or 1.

The two persistent session option values have the following effects:

persistent.session.option = 0:

The user does not have the choice to resume the last session or not.

persistent.session.option = 1:

At login the user is presented with the option to resume the session in the navigational state of the last session.

The default setting is 0, that is, users have no option to resume their last session.

The defined session preservation settings as described under Set the session resume level for users are in effect, independent of whether the administrator has given users the resume option.

If you give users the resume option, you should set the session resume level to 1 or higher. Otherwise the persistent.session.option property has no effect.

Setting the session resume level for users

The session resume level specifies which navigational state information should be resumed (if any) when the respective user logs in again. Portal administrators can configure the session resume level by setting the property persistent.session.level in Configuration Service, as described in Set service configuration properties. They can configure the property to one of three predefined values: 0, 1, and 2.

If you want the user to benefit from the setting, give users the resume option as described under Giving users the resume option.

However, the defined setting is in effect, independent of whether you give users the resume option.

The three persistent session level values have the following effects:

persistent.session.level = 0:

No persistent session state at all applies to the user session. During logout or session timeout no navigational state information is stored into the database. After a login no navigational state is restored.

persistent.session.level = 1:

The portlet states and the portlet modes are stored in the database and are restored to the user session when the respective user logs in again..

For example, all maximized portlets are still maximized. However, no information about the last active page is stored. This means that the user starts with the default page after a login.

persistent.session.level = 2:

The complete navigational state information is stored. This includes portlet-specific navigational state (portlet states, portlet modes, and render parameters) as well as page selection information mentioned above. In contrast to persistent session level 1 the session now starts with the last page that was active before the user logged out.

persistent.session.level = 3:

Users will stay on the login page after logging in, rather than being redirected to another page.

The default setting is 0, that is, no persistent session state is stored or restored.

The following table gives an overview of the settings and their effect on the user session when the user logs back in to the portal:

Portal navigational state	Persistent session state	Level 0	Level 1	Level 2	Level 3
Portlet states	Normal, minimized, maximized	---	Restored	Restored	---
Portlet modes	configure, edit_defaults, edit, view, help	---	Restored	Restored	---
Pages	The last active page before the user logged out	---	---	Restored	---

Parent topic:

Configure portal behavior