Service Configuration window

You can use the Service Configuration window to change settings for the Server and Knowledge Base Learning Server services.

Log On Account for Services

Be sure that the log on account used to run the services has full Windows administrative privileges for the local system.

To process documents from a network drive, make sure that the log on account provides network access. Otherwise, processing stops and an error message is added to the error log file.

If the SecurityBoost feature is enabled within Kofax Capture, a process may run as a different user than the logged on user. As a result, correct permissions may need to be set for the SecurityBoost user in the Windows Services window.

This group has the following settings.

Server Scheduler Service

This is a read-only setting that displays the name of the logged on user account for the Server Scheduler.

In the Server Scheduler Service group, you can define the performance settings for this service by adjusting the number of used CPUs and the value of the maximum memory available.

Knowledge Base Learning Service

This is a read-only setting that displays the name of the logged on user account for the Knowledge Base Learning Service.

Configure

Click this button to open the Windows Services window where you can configure the startup type, the start parameters and the log on account for the Server Scheduler Service and the Knowledge Base Learning Service.

User Profile for Services Used to Log On to Kofax Capture

To use a Kofax Capture user profile for the Server Scheduler Service and Knowledge Base Learning Service services to log on to Kofax Capture provide a user name and password, and add the <Services ShareCredentials="0" /> entry to the ACConfig.xml file. For more information on editing the ACConfig.xml file, see the Kofax Transformation Modules Installation Guide.

This group has the following settings.

Username: Type the user name. For additional information regarding Kofax Capture user profiles, contact your Kofax Capture administrator.
Password/Confirm password: Type the password.

If you are using a Kofax Capture user profile to log on, ensure that the username and password are valid. The Kofax Capture user profile data cannot be validated within this tool. If you are using a log on account for the Server Scheduler Service and Knowledge Base Learning Service services, this account must be configured to run as a service.

Any errors are added to the Kofax Transformation - Server log file.

Server and Application Settings

The following settings can be set for both Logging and the Server.

Logging

You can configure the following logging settings.

Log Aggregation

When set to False, each process of a Kofax Transformation Modules module application generates its own separate log file. (Default: False)

When set to True, the logs for an individual module are aggregated into a single log, even when there are multiple concurrent processes for a module instance. This can lead to log information being lost.

Log file path

Defines the path where the log files for Server, Knowledge Base Learning Service, Server Scheduler, and the User Modules are saved to disk.

Log level for Correction

Defines the level of log information recorded for the Correction module. This value can be Error, Warning, Info, or Debug. (Default: Error)

Log level for Document Review

Defines the level of log information recorded for the Document Review module. This value can be Error, Warning, Info, or Debug. (Default: Error)

Log level for Knowledge Base Learning Service

Defines the level of log information recorded for the Knowledge Base Learning Service. This value can be Error, Warning, Info, or Debug. (Default: Error)

Log level for Server

Defines the level of log information recorded for the Server. This value can be Error, Warning, Info, or Debug. (Default: Error)

Log level for Server Scheduler Service

Defines the level of log information recorded for the Server Scheduler. This value can be Error, Warning, Info, or Debug. (Default: Error)

Log level for Validation

Defines the level of log information recorded for the Validation module. This value can be Error, Warning, Info, or Debug. (Default: Error)

Log level for Verification

Defines the level of log information recorded for the Verification module. This value can be Error, Warning, Info, or Debug. (Default: Error)

Purge log entries older than (days)

Deletes log entries older than the specified number of days. This ensures that the log files are not too large and the storage space allocation does not need to keep growing. (Default: 30)

Server

You can configure the following Server settings.

Active Server instances

Defines which instances of Server poll the queue for batches. Each instance of Server is assigned an instance ID of either 1 or 2, so depending on which instances you are using, enter the appropriate value or values. (Default: 1 + 2)

Automatically start batch processing

If this setting is set to Yes, the Server Scheduler Service automatically polls for batches and starts batch processing each time the Server Scheduler Service is started. (Default: No)

This setting is enabled automatically when you install Kofax Transformation Modules in Quiet Mode.

Extraction process timeout

Defines how many minutes the extraction process is given to successfully perform an operation. (Default: 1440)

Idle time before terminating extraction process [min]

Enables you to specify how long to wait before terminating an idle extraction process. (Default: 1)

Language

Defines the language for all messages generated by the Server. For example, field validation rules. (Default: Operating system language)

Lifetime performance counter

Defines the length of time, in minutes, for how long the performance counters are calculated. (Default: 30)

Maximum memory used [MB]

You can restrict the system memory that is used by the Server Scheduler Service and any automatically-started extraction or recognition processes by adjusting this value. The default value is eighty percent of the physical memory; the minimum value is 200 MB. You can select a higher value than the actual value for the physical memory, but doing so can slow overall system performance due to extensive paging.

If the server hardware runs an extensive number of extraction processes or other applications and services, be careful to select a value that leaves sufficient system memory.

Maximum number of batch processing processes

Defines the maximum number of simultaneously-running mailroom processes that are allowed. (Default: 0)

A value of 0 indicates that the maximum number of mailroom processes depend on the maximum number of CPUs available.

Maximum number of CPUs used

Restricts the number of CPUs used by the Server Scheduler Service. (Default: 0)

A value of "0." indicates that the maximum number of CPUs available on the system are used.

The number of CPUs available on the system is also displayed.

Minimum number of batch processing processes

Defines the minimum number of mailroom processes that are used for batch processing. (Default: 1)

Restart counter for batch processing process

Defines how many batches are processed before the mailroom process is restarted automatically. (Default: 1000)

Restart counter for extraction process

Defines how many documents are processed before the extraction process is restarted automatically. (Default: 1000)

Retry on error counter for batch processing process

Defines the number of attempts made to restart the mailroom process after it fails with an abnormal termination. For example, network problems. (Default: 2)

Retry on error counter for extraction process

Defines the number of attempts that are made to restart the extraction process after it fails with an abnormal termination. For example, OCR errors or network problems. (Default: 2)

Server Scheduler Service communication port

Defines the port number for the Server Scheduler Service. Modify this value if the default port number is blocked by other programs or services. (Default: 5000)

The following buttons are provided at the bottom of the window:

Restart Services

Click this button to restart the Server Scheduler Service and the Knowledge Base Learning Service to load the changed settings.

For the restart, services that are processing a batch are stopped, if possible. (This behavior is the same as when you suspend a batch within Kofax Transformation - Server.) If for any reason the service cannot be stopped within 30 seconds, an error message is displayed. If this happens, you must stop the services manually before you can restart the services with new settings.

Apply

This button applies your changes without closing the window. To restart the services with new settings, click Restart.

OK

This button closes the window and saves your changes. You must stop the services manually before you can restart the services with new settings.

Cancel

This button closes the window without saving your changes.

Help

This button Help icon displays the help for the window.