AUTO_LOGOUT

Selects the AUTO_LOGOUT mechanism to be used for an application. It takes the attribute Using, where you can reference a predefined AUTO_LOGOUT_COMPONENT (to inherit the auto logout parameters of that component).

If the AUTO_LOGOUT is set, the application will get a log out message after the time in seconds specified by the TIMEOUT (for auto logout) element has elapsed.

For Genero Web Client for JavaScript (GWC-JS) applications, you will get a log out page.
For GDC applications, you will get a pop-up window.

By default the ending page or pop-up window shows the following message when auto logout occurs : You have been logged out.

Note: The auto logout feature is not supported on the legacy Genero Web Client applications using the HTML5 theme.

Syntax

<AUTO_LOGOUT Using="auto_logout_component_Id"></AUTO_LOGOUT>

Usage example - using an auto logout component

When your applications reference the default application defaultwa, they inherit its AUTO_LOGOUT settings, which use the default AUTO_LOGOUT_COMPONENT identified by the Id value "cpn.wa.autologout", as shown in the examples from the GAS configuration file.

<APPLICATION Id="defaultwa" Abstract="TRUE">
   <!-- This is the "default" application.
    It is not used directly: it is used for defining a "root" application. -->
   <EXECUTION Using="cpn.wa.execution.local"/>
   <AUTO_LOGOUT Using="cpn.wa.autologout"/>
   ...
</APPLICATION>

<COMPONENT_LIST>
   ...
   <AUTO_LOGOUT_COMPONENT Id="cpn.wa.autologout">
      <TIMEOUT>0</TIMEOUT>
      <!--COMMAND Timeout="20">auto-logout-allowed.sh</COMMAND-->
   </AUTO_LOGOUT_COMPONENT>
   ...
</COMPONENT_LIST>

Note: The default timeout duration set to 0 seconds means the auto logout is ignored and applications keep running.

Usage example - defining the auto logout directly

If you want to set auto logout directly in your application configuration file (xcf), you can add an AUTO_LOGOUT element.

<APPLICATION Parent="defaultwa">
    <EXECUTION>
	   <PATH>my_app_dir</PATH>
	   <MODULE>my_module</MODULE>
	</EXECUTION/>
    <AUTO_LOGOUT>
       <TIMEOUT>30</TIMEOUT>
       <!--COMMAND Timeout="20">auto-logout-allowed.sh</COMMAND-->
    </AUTO_LOGOUT>
    ...
 </APPLICATION>

Child elements

There are no child elements.

Parent elements

This element is a child of the following element: APPLICATION (for an application)

Auto logout and child applications

As long as the parent application or any of its child applications have user activity, the auto logout is not triggered.

Important: If an application has child applications running when the AUTO_LOGOUT is triggered, the following describes the logout process:

An auto logout ending page or pop-up window will be generated and returned for all child applications.
The proxy will stay alive until the last child application has shown its ending page before closing the fglrun application.

Note: The order that applications close can not be determined by the AUTO_LOGOUT process as it depends mainly on when the auto logout is initiated in the front-end. If the order your applications close at auto logout is important, you will need to handle this in your application's code.