User sessions
A user should have sufficient access permissions to view or edit the user session settings.
Although the User session settings are displayed in an editable mode for users with read-only permissions, they are not allowed to save the changes.
System
- 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.
- Limited user session ID
- Displays the default limited session ID and allows the generation of a new limited user session ID.
User
- Session timeout
- The timeframe in hours and minutes after which the system automatically invalidates a user session. The session timeout only comes into effect when the Process Session Timeouts system task is active, and 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 temporary storage for all the documents/folder data changes done when working in the capture form. If the batch 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 and indicates the time available 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.
- Timeout warning period
-
The period 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 it idle for 30 minutes, the warning message appears after 25 minutes (5 minutes before batch session timeout of 30 minutes).
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 about the session timeout 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.
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)