Element Details: Session+Timeout
 Back


Available in: Logi Info Source code name: SessionTimeoutIntroduced in: v11.4.046

When a user works with an Info application, then leaves the browser session inactive for some time, the server-side session may timeout and end. This can cause problems with pages which need the session state to stay alive. The SessionTimeout element makes it easy to prevent errors caused by session timeouts.

There are two modes, depending on the setting of SessionAutoKeepAlive. When "True", the session remains alive for as long as the browser is open. This is done by automatically "pinging" the server from the browser, thus informing the server that the browser is still open. Once the browser closes, the server-side session times-out after some period.

With SessionAutoKeepAlive="False", which is the default, the user is prompted with a popup window asking if the session should remain open. The prompt appears some minutes before the timeout. If the user clicks the button, the session is kept alive and the user may continue working. If the popup is ignored for some minutes, the browser session is redirected to another web page, such as a login.

This element does not control the server-side session timeout setting. For Windows IIS, the session timeout is set using either the IIS Management Console or web.config file, with the default value being 20 minutes.



ATTRIBUTES

Click attribute Name to drill down for more information.

NamePossible ValuesDescription
SessionAutoKeepAlive
True
False
When "True", the session remains alive for as long as the browser is open. This is done by automatically "pinging" the server from the browser, thus informing the server that the browser is still open. Once the browser closes, the server-side session times-out after some period. The default is "False".
SessionEndedUrl
UserDefined
The browser redirects to the SessionEndedUrl once the session ends. Set this to a URL showing the user that the session has timed out. The default is rdLogout.aspx.
SessionKeepAliveCaption
UserDefined
SessionKeepAliveCaption is the text for the button warning popup. Clicking the button keeps the session alive. The default is "Continue the Session".
SessionKeepAliveCaptionClass
UserDefined
SessionKeepAliveCaptionClass may be used to set the style of the SessionKeepAliveCaption text.
SessionWarningCaption
UserDefined
SessionKeepAliveWarning is the text for the warning popup. The default is "Your session will automatically end soon."
SessionWarningClass
UserDefined
SessionKeepAliveWarningClass may be used to set the style of the SessionKeepAliveWarning text.
SessionWarningDuration
UserDefined
SessionWarningDuration sets the amount of time the warning popup remains displayed before the user is redirected to the SessionEndedPage. The value is minutes. The warning popup appears 2 minutes before the session timeout period minus the SessionWarningDuration. For example, if the session timeout is 20 minutes and SessionWarningDuration="3", the warning popup appears after 15 minutes of inactivity. The default is 3 minutes.
TemplateModifierFile
UserDefined
Some elements employ a definition file as a template. The definition contains language and culture specific Caption attributes that you may want to change. Or you may simply want to change the captions to better suit your application. The TemplateModifierFile is an XML file with elements pointing to other elements in the template to be changed. All other attributes get applied in the template. For example, the Dashboard2 element has a template file (rdTemplate\rdDashboard\rdDashboard2Template.lgx) several Label elements. One has an ID="lblAddPanelsTitle". The Caption can be changed with the following XML in the TemplateModifierFile: You can set attributes for any number of elements. Examine the template file to learn the ID and Caption attributes you may want to modify. The above example shows how to identify template elements with an ID attribute. Alternatively, you can also identify elements with an XPath expression. In this example, we change an attribute of the InteractivePaging element: For a more detailed list of modifier actions see the following DevNet article. TemplateModifierFiles can be in any folder accessable to the web application. When a directory location is not specified, the default location is the _SupportFiles folder.



PARENT ELEMENTS

Click element to drill down for more information.

Setting


CHILD ELEMENTS

Click element to drill down for more information.



 Back to top