Configuration Files

There are two configuration files that can be modified to customize your Kofax Search and Matching Server installation. By upgrading to Kofax Search and Matching Server 6.7, these configuration files replace previous registry settings. These settings are now available in the configuration files to aid in configuration.

Important Any change made to these configuration files take effect only once the service is restarted.
  1. Kofax.KSMS.LoadBalancerService.exe.config

  2. Kofax.KSMS.Service.exe.config

These configuration files are installed alongside their corresponding executables. By default, the installation path is <Program Files>\Kofax\SearchMatchingServer.

Both configuration files have the same options, but they are independent of each other. The options are as follows:

RunningMode

Defines if the server is running in "Normal" mode or "Restricted" mode. The value for this option is set to "Normal" by default. Only use the "Restricted" mode when you want two load balancers to work together without sending contradictory information.

Port

Select the network port that is used to establish communication during search and configuration operations with the server. By default, either 22000 or 22001 are assigned. You can assign any valid port.

Language

The language used for log messages posted by the service. The value for this option is set to "en" by default.

Note For support of additional languages, a language pack for that language is needed.
DataRootDirectory

The path where Kofax Search and Matching Server stores its data. The value for this option is set to C:\ProgramData\Kofax\KSMS by default.

KsmsAdministratorsGroupName

The name of the group that a user must be a member of, in order to configure the services. The value for this option is set to KSMSAdministrators by default.

Important You must change this value in both configuration files.
SecureSearchEnabled

Determines whether the network data that is transmitted for a search request is encrypted or not. The value for this option is set to "true" by default.

Important You must change this value in both configuration files.
LogLevel

There are different levels that determine what kind of messages are written to the log file. The value for this option is set to "WARN" by default. This means that only warnings and errors are logged, and no information messages.

LogfilePath

This setting defines the path where the log file is stored. The value for this option is set to C:\ProgramData\Kofax\KSMS\Logs\KSMS.log by default.

Edit the path as necessary.

RollingLogfileSizeInMB

Defines the size of the log file when it is archived. The value for this option is set to "10" by default. This means that when the log file has reached a size of 10 MB it is stored as an archive file in the same folder and a new log file is created.

RollingLogfileCount

Defines the number of archive files that are stored on the computer. The value for this option is set to "10" by default. This means that the last 10 archive files are available.

LogThreaIDInfo

An optional setting that is used only for bug tracking. It writes the ID from the tread posting a message in the log file. The value for this option is set to "false" by default.

LogMutexInfo

An optional setting used only for dead lock bug tracking. When set to true, an entry is added to the log each time internal mutexes are accessed. The value for this option is set to "false" by default.

WcfThrottlingMaxConcurrentCalls

Indicates the maximum number of parallel connections allowed. The value for this setting must match the value for the WcfThrottlingMaxConcurrentSessions setting below. The value for this option is set to "128" by default.

Note A large value for this setting when the service is already busy can decrease the server performance. Increase this number carefully so that the server does not use all of the machine resources.
WcfThrottlingMaxConcurrentSessions
Indicates the number of queries that are processed in parallel on the server. The value for this setting must match the value for the WcfThrottlingMaxConcurrentCalls setting above. The value for this option is set to "128" by default.
McfThrottlingMaxConcurrentInstances
Analyzes the WCF communications. The value for this option is set to "2147483647" by default. Do not modify the value for this option.