Customizing the timeout warning in an application

You can configure the session timeout warning individually for each application by configuring the optional timeout-warning element.

About this task

Optionally, configure the timeout-warning element in the application configuration XML file, which has the extension .app. If you configure the timeout-warning element in the application, the values takes precedence over both the values that are configured in the system application configuration properties and the default values.

Procedure

Configure the following attributes as required in an application's configuration file:
title

Configures the title that is displayed on the timeout warning dialog.

user-message

Configures the message that is displayed to the user before the session expires.

expired-user-message

Configures the message that is displayed to the user after the session expires.

quit-button

Configures the text that is displayed on the Quit button in the modal dialog that is displayed to the user before the session expires.

continue-button

Configures the text that is displayed on the Continue button in the modal dialog that is displayed to the user before the session expires.

timeout

Configures the notice period that users are given in seconds, through the display of the session timeout warning, that their browser session is about to time out. For example, if the default browser session length is 30 minutes, and the timeout attribute value is configured to 120, which corresponds to a value of 2 minutes, the session timeout warning is displayed after 28 minutes of inactivity. Then, users must click a button in the user interface to prevent the session from automatically timing out.

width

Configures the width of the session timeout warning modal in pixels.

height

Configures the height of the session timeout warning modal in pixels.

For an application in Universal Access, you can enable a specific logout page to be associated with the Quit button for a modal dialog. On the logout banner menu item that is on the person banner menu, you must set the logout attribute to true, as shown in the following example:

<ac:banner-menu type="person" title="person.title" page-id="somPageID"/>
<ac:menu-item id="logout" title="menu.logout.title" text="menu.logout.text" 
page-id="LogoutWrapper" logout="true"/>
<ac:banner-menu/>
<ac:timeout-warning title="timeout.title"
user-message="timeout.user-message"
expired-user-message = "timeout.expired-message"
continue-button="timeout.continue"
quit-button="timeout.logout"
timeout="300"
width="650"
height="300"/>

Example

The following example demonstrates how to specify values for the timeout-warning attributes:

<ac:timeout-warning title="timeout.title"
user-message="timeout.user-message"
expired-user-message = "timeout.expired-message"
continue-button="timeout.continue"
quit-button="timeout.logout"
timeout="300"
width="580"
height="200"/>