What are the advanced options for setup of KTM Server

Issue

What are the advanced options for setup of Kofax Transformation Modules Server

Solution

The supported method of configuring the Kofax Transformation Server Service is performed through the KTM Server Configuration application. Default values for each configuration piece are included, below:

There are various advanced options that can be enabled or modified to change the behavior of the KTM Server process (Server Scheduler process).

These changes can be made to the following Registry Keys:

32-Bit Machine
HKEY_LOCAL_MACHINE: SOFTWARE\Kofax\Transformation\4.0\Server\

64-Bit Machine
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Kofax\Transformation\4.0\Server\

Registry Key	Set	Default Value	Type	Description
SchedulerCommunicationPort	Yes	5000	REG_SZ	Defines the port number for the Server Scheduler service (Server communication) if the default port number is already blocked by other programs or services
ExtractionProcessPath	Yes	-	REG_SZ	Defines the path where the executable for the extraction process of Server is located
BatchProcessingExePath	Yes	-	REG_SZ	Defines the path where the executable for the batch processing (mailroom) of Server is located
AutoStartBatchProcessing	Yes	Set to <0>*	REG_DWORD	Enables the executable for the Server batch processing (mailroom) to be run automatically
MaxUsedCores	Yes	Depends on the actual number of CPUs available to the system*	REG_SZ	Restricts the number of CPUs used by the Server Scheduler service
MaxUsedPartitions	Yes	Depends on the value of MaxUsedCores	REG_SZ	Restricts the number of partitions used by the Server Scheduler service to process batches related to different projects simultaneously
MaxMemoryUsageInMB	Yes	Depends on the actual value and uses 80% of the physical memory of the system*	REG_SZ	Restricts the amount of system memory that is used by the Server Scheduler service (in MB)
MaxUsedBatches	Yes	No limitation	REG_SZ	Defines the maximum number of simultaneously-running mailroom processes
LogfilePath	Yes	-	REG_SZ	Defines the path where the extended log file of Server is saved to disk
LogLevel	Yes	3*	REG_DWORD	Defines how detailed the information in the log file is Fatal - designates severe error events that presumably lead the application to terminate Error - designates error events that may allow the application to continue running Warning - designates potentially harmful situations Info - designates informational messages that highlight the progress of the application at a coarse-grained level Debug - designates fine-grained informational events that are useful to application debugging
ExtractionProcessRetryOnError	No	2	REG_SZ	Defines the number of attempts to re-start the extraction process after abnormal termination (for example OCR or network problems)
MailroomProcessRetryOnError	No	2	REG_SZ	Defines the number of attempts to re-start the mailroom process after abnormal termination (for example network problems)
MailroomProcessRestartCounter	No	1000	REG_SZ	Determines the number of batches after which the mailroom process is automatically re-started
ExtractionProcessRestartCounter	No	1000	REG_SZ	Determines the number of documents after which the extraction process is automatically re-started
LifeTimePerformanceCounter	No	30	REG_SZ	Projects a total for the selected performance counters in an hour, based on the average count measured in the given time [minutes]

* You can run the KTM Service Configuration Tool to restore the default value after configuration.

Level of Complexity

Moderate

Applies to

Product	Version	Build	Environment	Hardware
Transformation	6.3; 6.4	N/A	N/A	N/A