General
This topic describes the general settings, settings for the Transformation Server, and system-related settings.
A user should have sufficient access permissions to view or edit the general system settings. For a user with read-only permissions, the System settings dialog displays all settings in editable mode but is not allowed to save the changes.
General
- Use business calendar
-
Allows calculating all job durations and due dates based on the business calendar which is selected separately for each scheduled job.
- Allow duplicate email addresses
- Allows using the same email address by multiple resources.
If this setting is clear, you cannot create or edit (individual, group, external resource), or import a resource that does not have a unique email ID.
- Enable multilingual processes
-
Allows opening the form in the correct locale when the browser is set to a different language.
If this option is not enabled, you can translate a process, but the process will only appear in the base language at runtime.
- Restrict job access
-
When this setting is selected, it restricts resources from accessing job properties, viewing associated milestones, variables, states, roles, history, and map details at the process level using view job details functional access.
When functional access prevents viewing job details, the job is not visible in job search results. However, users can still create and restart jobs, view the work type, and take and complete activities.
- Heartbeat inactive interval
- The interval beyond which, if the Core Worker, Transformation, or Export services remain inactive, the status of the
corresponding entry in the Machine names table is updated as "inactive". (Default: 60 minutes, Range: Minimum=1 minute and
Maximum=1 day)
-
The "Heartbeat inactive interval" should be greater than the "Activity reset timeout interval" of Core worker, Export worker and Transformation services.
-
This option is not available for On-premise multi-tenancy and Azure environments.
-
- Inactive machine retention
-
The interval beyond which if the Core Worker, Transformation, or Export services remain inactive, the corresponding entry is deleted from the Machines table of the database so that you can only view the machines that are active in your deployment. (Default: 365 days, Range: Minimum=1 day and Maximum=5000 days)
This option is not available for On-premise multi-tenancy and Azure environments.
- Max number of activities to return
- The maximum number of activity rows to retrieve at a time. (Default: 50)
-
The number of activity rows cannot exceed 200. At runtime you can retrieve only 200 rows in a work queue even when 1000 activities exist.
-
When you upgrade Kofax TotalAgility from previous versions:
-
If the maximum number of activities is greater than 200, the max value is set to 200. For example, if the max number of activities is 237, the max value is set to 200.
-
If the maximum number of activities is less than 200, the max value is set to the existing value. For example, if the max number of activities is 50, the value is set to 50 itself (existing value).
-
-
- Max number of jobs to return
- The maximum number of job rows to retrieve at a time. (Default: 200)
-
The number of job rows cannot exceed 500. At runtime you can retrieve only 500 rows in a work queue even when 600 jobs exist.
-
On upgrade the maximum number of jobs is set to 200.
-
When you set the retrieval limit globally (through System settings) and locally (through APIs such as getjobs, getactivities, or getworkqueues) the system sets the lowest retrieval limit value among the two settings.
By default, the maximum number of activity rows and jobs to retrieve at a time is 50 and 200 respectively. To return more activities and rows up to a maximum of 32,767, do the following:
-
Run the UpdateIgnoreWQJobListMaxRows.sql. Running the SQL will automatically set the value of IgnoreWQJobListMaxRows setting to true. This setting is available in the server_setting.xml from the server_data table.
-
You can now increase the number of activities and jobs to return. (Maximum is 32767)
Transformation server
- Reject documents on exceptions
- If this setting is selected, the system rejects the document or page on exceptions. If clear, 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: 5)
For an Azure environment, the default Auto activity reset limit is 1. - Restrict looping in synchronous
-
Allows the process to be synchronous so that it only has automatic activities and does not have any manual activities. If this setting is selected, you cannot set maximum loop counts.
By default, this setting is not enabled and allows you to define the Maximum loop count. (Default: 1000)
For an Azure environment, this setting is read-only with a default value of 10,000.Continuous looping in a synchronous job or business rule can cause a high workload on the TotalAgility server. The Maximum loop count allows you to define the number of times an activity can be executed in a synchronous job or business rule to prevent continuous looping. When the loop count reaches the defined limit, the synchronous job is suspended at runtime.
You can set the maximum loop count at system level or process level. The maximum loop count set at process level takes precedence over the system setting. See Process properties. - Worker task retry count
- Allows you to set the maximum number of retries for a worker task. If the maximum number of retries is reached, the worker task is put into an error state. (Default: 5 and Maximum: 100)
- You can view the failed worker tasks from the TotalAgility Workspace and activate or delete a worker task.
Capture data clean-up worker
- Operation time limit
- The operation time limit for the capture data clean-up worker task when deleting large binary data. (Default: 2 Hrs)
- Chunk size
- Allows you to set the number of binaries to be deleted. (Default: 500 binaries)
Enable custom sorting
Enables sorting of columns in the work queue, System, and Job list queries.
Appearance
Allows you to upload a Browser tab icon that appears in the browser tab of TotalAgility Designer and TotalAgility Workspace. It also applies to on-premise multi-tenancy and Azure environments. This icon helps to visually differentiate the environments. You can customize the icon on the browser tab.
-
The preferred size for the image is 32x32 pixels. The maximum file size allowed for the image is 28.4 MB.
-
Images in only GIF, PNG or ICO formats are supported.
-
If you do not provide any custom icon, the default Kofax TotalAgility icon is used.
-
If the icon does not display automatically, you may have to clear your browser's cache and reopen your browser for the changes to take effect.
Application analytics
Allows you to opt-out of sending telemetry data. (Default: Clear)
RTTS warm-up job
Allows you to select a warm-up process and upload an image. TotalAgility automatically starts a warm-up job on the uploaded process on launching TotalAgility. During warm-up, the uploaded image is used to start up the Transformation Server and pull the project and execute it, so next time the Transformation Server is ready for use.