General

This section describes the general settings, settings for the Transformation server and for general 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 setting in editable mode, but is not allowed to save the changes.

Note You must restart the Kofax TotalAgility services for the settings to take effect.

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 which does not have an unique email ID.

Enable multilingual processes

Allows opening the form in the correct locale when the browser is set to a different language.

Restrict job access

Restricts resources from accessing job properties, viewing associated milestones, variables, states, roles, history and map details.

When this setting is selected, 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.

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.

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)
Note
  • 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.

Max number of activities to return
The maximum number of activity rows to retrieve at a time. (Default: 50)
Note
  • 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:

    1. 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.

    2. 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)
Note
  • The number of job rows cannot exceed 500. At runtime you can retrieve only 500 rows in a work queue even when 600 jobs exists.

  • On upgrade the maximum number of jobs is set to 200.

Note 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 number of 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)

Note SQL Script will be provided to the user by Technical Support when requested by a user.

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.
Enable custom sorting
Enables sorting of columns in work queue, System and Job list queries.

Core Worker

Auto activity reset limit

Allows you to define the maximum number of attempts to reset an automatic activity. (Default: 5)

Note 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)

Note 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 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.

Note 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 also activate or delete a worker task.

Capture data clean-up worker

Operation time limit
The operation time limit for 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 work queue, System and Job list queries.

Browser tab icon

Allows you to upload a browser tab icon that appears in the browser tab of TotalAgility Designer and 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.

Note
  • 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.