General
- Session ID
-
Displays the default session ID and allows to generate a new session ID. See Change the system session ID.
- Limited User Session ID
-
Displays the default limited session ID and allows to generate a new limited session ID.
- Security Key
-
Displays the default key that protects sensitive data between client and server so that variable values stored on the client machine are encrypted when viewed.
You can generate a new security key if required. - PI Job Category
-
Displays the category in the Job table of the PI database:
- Allow Multiple Logon
-
Allows multiple logons using the same session. For example, you can logon to both TotalAgility and TotalAgility Workspace, or use multiple browser Windows in the same session to logon to TotalAgility Workspace.
- Password Format
-
A format that all passwords must adhere to. The password format can be a regular expression or an inline value.
Examples of regular expression for password format:
- Password Hashing Algorithm
-
Used to verify the integrity of passwords. It includes two settings:
If you change the password hashing algorithm, all existing user passwords become invalid on saving the changes. Therefore, you must specify the default password, and also specify if the password must be updated for all users or only for the current user.
-
Default Password: Specify the default password. Once you save the settings, passwords for resources get updated to the default password.
-
Update Password: Specify if the password must be updated for all users or only for the current user:
-
- Allow Duplicate Email Addresses
-
Allows sending the same email to multiple resources with the same email address.
- Allow Multilingual Processes
-
Allows opening the form in the correct locale when the browser is set to a different language.
You can set the browser locale either from the browser setting or from the language selector. When upgrading from a supported version prior to 7.2.0, the property is turned off.
- Disable Logon without Password
- A message appears when an unauthorized user invokes any of the Logon SDK methods to acquire the session ID. This setting is not available for Azure and on-premise multi-tenancy environments.
- User Sessions
-
-
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.
Every time a user performs an action in TotalAgility that requires a valid session, TotalAgility records his/her last active date (timestamp).Sessions must have a limited lifetime and expire after a period of time. They should be set according to the purpose and nature of the application, and should balance security and usability, so that the operations can be completed without the session expiring frequently.
We recommend that you set the session timeout for a user, 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:
-
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.
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.
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.
If sticky session is enabled, then the batch session time-out does not work, instead idle time-out of TotalAgility Application Pool works in IIS. -
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 minutes)
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).
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.
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.
-
- Database
-
-
Write to Audit Log: Maintains an audit log in the database.
-
Archive Finished Jobs: When a job completes (either through natural completion or through termination) it can be archived, automatically or manually, with job details from the live tables to the finished tables to improve performance.(Default: Automatic)
- Automatic: A periodic system task archives the job details from the live to finished tables.
- Manual: Archives the finished jobs when you click the "Move Finished Jobs" link, otherwise the jobs remain in the live jobs table.
When upgrading Kofax TotalAgility, the Archive Finished Jobs property retains the same setting that was set prior to upgrade.See Archive jobs.
-
- Available Space Notification Limit
-
Sets a threshold value, the amount of available free space for the database. Also allows a corresponding business process to create once the amount of available free space in the database is less than or equal to the specified limit. For example, if your database is 150 GB and the available space notification limit is set to 20 GB, the process could send an email to the concerned person when the database is >=130 GB. (Default: 10 GB, Maximum: 50GB)
The process has the following parameters which are populated when a job is created on this process:
- Document Storage Notification Limit
-
Sets a threshold value for the document storage and a corresponding business process to create once the amount of available free space in Azure storage is less than or equal to the specified limit. (Default: 10 GB, Maximum: 2TB)
The Available Space Notification Limit and Document Storage Notification Limit settings only apply to TotalAgility in an Azure environment. - Reporting
-
-
Run Daily From and Run Daily To: The time to run daily report so that the Reporting Server handles the system task (extract/transform/load) for tenant every ten minutes and transforms data from staging to warehouse.
For on-premise multi-tenancy and Azure environments, the system tasks are created per tenant basis with ten minutes interval between the tasks for one tenant. Each task is handled separately and appropriate pair of staging/warehouse databases are processed with one pair per one system task.
You can narrow this transformation to nightly hours of the tenant to improve availability of Warehouse database for customers.The Run Daily From and Run Daily To setting is configured once per TotalAgility installation for an on-premise environment, and per tenant for on-premise multi-tenancy and Azure environments.
-
Data Retention Time: The number of days after which all the data associated with the field is deleted. (Default: Five days)
-
Document Retention Time:The number of days after which all the data associated with the document is deleted. (Default: 3650 days (Ten years))
-
- Transformation Server
-
Reject Document On Exceptions: Allows you to set whether the system should reject the document or page on exceptions. If set to No (default), the system suspends the activity on exception.
- Core Worker
- Auto Activity Reset Limit:Allows you to define the maximum number of attempts to reset an automatic activity. (Default: Five)
- Capture Data Clean-up Task Execution
- Capture Data Operation Time Limit:
Allows you to set the operation time limit for deleting the child capture data. (Default: 00 Hrs: 00 Mins)
Too large intervals between clean-up runs can lead to excessive database growth which causes increased task execution time and high load on the server. Too often clean-up task executions can lead to not optimal resources usage. Configure the operation time limit based on the data growth rate so that it can maintain a balance between manageable data growth and the server load.