Welcome > System > System settings > User sessions

User sessions

A user should have sufficient access permissions to view or edit the user session settings. For a user with read-only permissions, the User sessions dialog displays all setting in editable mode, but is not allowed to save the changes.

  1. Navigate to System > System settings > Logon and authentication > User sessions.
    The User sessions dialog box is displayed.
  2. In the System group, configure the following settings.

    System session ID

    Allows execution of any secure SDK call. For each installation of TotalAgility, a unique system session ID is generated. You can regenerate the system session ID or manually set its value. See Change the system session ID.

    Limited user session ID

    Displays the default limited session ID and allows to generate a new limited user session ID. See Change the limited user session ID

  3. In the User group, configure the following settings.

    Session timeout

    The timeframe in hours and minutes after which the system automatically invalidates a user session. The session timeout occurs when this period exceeds the user's last active date. (Default: 1 Hrs 0 Mins)

    Note Every time a user performs an action in TotalAgility that requires a valid session, TotalAgility records the user's last active date (timestamp).

    If you use session timeout, the session has a limited lifetime and expires after a period of time. We recommend that you set the value appropriately for the purpose and nature of the application, to balance security and usability, so that the user can comfortably complete operations without the session expiring frequently.

    We also recommend that you set the session timeout considering the time user takes to complete the tasks. For example, to complete a manual activity, if the user must take the activity and then telephone a customer, a one-hour session timeout may not be appropriate. Adequate time must be given to allow the user to perform the necessary tasks.

    The session timeout only comes in effect when:

    • The Process Session Timeouts system task is active. See System tasks for more information.

    • The TotalAgility Core Worker Service is running.

    Batch session timeout

    The timeframe in hours and minutes after which the batch times out. This interval is specifically used when performing capture-related work, such as, scanning and creating jobs, performing a Scan or Validation activity and others. (Default: 0 Hrs 30 Mins)

    A batch is a temporary storage for all the documents/folder data changes you made when working in the capture form. If this times out, you will lose all your changes and may have to start from scratch. You will have to launch the Scan Create New Job form again or take the Scan activity or Validation activity again.

    If you want Capture batches to timeout, set the appropriate value or disable the Process Capture Timeouts system task.

    The batch can timeout independently from the session timeout. It basically indicates how long the user has to complete the capture activity. If the batch times out when performing an activity, you can still cancel the taken activity and take it again from the work queue.

    See Kofax TotalAgility Best Practices Guide for more information.

    Timeout warning period

    The period of time before which a warning is displayed to inform that the user session is going to time out. (Default: 5 Mins)

    For example, if the system session timeout=1 hour, batch session timeout=30 minutes and warning session timeout=5 minutes, and if you take a capture activity and leave idle for 30 minutes, the warning message appears after 25 minutes (5 minutes before batch session timeout of 30 minutes).

    Note If you are on a Take activity form and the session times out, the activity gets cancelled if you have one session or remains taken if you have multiple sessions.

    Session timeout form

    A TotalAgility form that informs you that the user session has timed out and provides a link for you to log in again.

    For example, when a user is on a Create new job form and does not perform any action after the session timeout message appears, the message appears until the session times out, based on the timings set in the system settings. If the user clicks OK in the message, the session is reset and the user can perform further actions on the form. Otherwise, the session times out and the user is redirected to the SessionTimeout form.

    Note If you are on a Take activity form and the session times out, the activity gets cancelled if you have one session or remains taken if you have multiple sessions.

    Resource idle timeframe

    Determines how long the system should allow a resource to be idle before raising an event. For example, two hours after a resource declines an activity, an event can be raised to re-offer the same activity to the resource. (Default: 0 Hrs 0 Mins)

  4. Click Save.
    Note Restart the Kofax TotalAgility services for the settings to take effect.