Welcome > Process batches with Server > Using advanced options > Registry keys

Registry keys

When browsing to HKEY_LOCAL_MACHINE: SOFTWARE\Kofax\Transformation\4.0\Server\ you can find the following Kofax Transformation - Server module registry keys:

Note On an X64 operating system, browse to HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Kofax\Transformation\4.0\Server\.
Registry Key Set Default Value Type Description

SchedulerCommunicationPort

No

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

No

Depends on the value of Max UsedCores

REG_SZ

Restricts the number of partitions used by the Server Scheduler Service to process batches related to different projects simultaneously

MaxUsedMemory

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

No

No limitation

REG_SZ

Defines the maximum number of simultaneously-running mailroom processes

MinUsedBatches

No

-

REG_SZ

Controls the minimum count of batch processing 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

  1. Fatal - designates severe error events that presumably lead the application to terminate

  2. Error - designates error events that may allow the application to continue running

  3. Warning - designates potentially harmful situations

  4. Info - designates informational messages that highlight the progress of the application at a coarse-grained level

  5. 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 Service Configuration Tool to restore the default value after configuration.

Note If you use the log levels “Info” or “Debug”, be aware that the log file report can be very extensive. The log file name is “ServerScheduler.txt”. The location to which the log file is saved to disk depends on the path to the Kofax Capture log folder.