Configuration file parameters

The configuration files for the Decipher IDP components contain a range of parameters which give you access to additional settings. While some parameters are set up during installation, and others can be configured via the Decipher IDP user interface, some options are only accessible via the configuration files.

Caution is advised when updating these settings. It is recommended that you engage with Blue Prism support, and test any updates in a Development environment before changes are applied to a Production system.

This page contains details of the parameters in each of the following components:

To edit the parameters, open the configuration file in a text editor as an admin.

The component must be restarted after the configuration file is updated for the changes to take effect.

Application Server

The parameters for the Application Server config file, which by default is located in: C:\Program Files (x86)\Blue Prism\Decipher Server\SsiServer.exe.config

Node

Parameter name

Description

Set up during install?

Set up in UI?

connectionStrings

SsiServerDb

The connection string to the application database. This value can be encrypted if required. The connection string is automatically configured during installation using details from the Database Server Configuration and Configure Server Settings screens of the Decipher Server installer.

 

SsiServerDbReporting

The connection string to the reporting database. This value can be encrypted if required.

 

SsiServerDbPublic

An optional connection string used by the Web Client to retrieve reports directly from the database. This value can be encrypted if required. This setting can also be configured using the ExternalDBConnectionString parameter in the Web Client config file. If not populated, the Web Client first looks for the connection string in SsiServerDbPublic, and then in SsiServerDb.

 

 

ServerConfig

Port

The port for the application server. In the installer, this is the Port field.

 

MaxRequestLength

The maximum allowed TCP socket request length, in kilobytes. The default is 70,000 KB. It is not recommended to alter this setting.

 

 

SendBufferSize

The size of the TCP send buffer. The default is 256 KB. It is not recommended to alter this setting.

 

 

RecieveBufferSize

The size of the TCP receive buffer. The default is 256 KB. It is not recommended to alter this setting.

 

 

CertificateFile

The certificate file used to establish an encrypted SSL channel to the application server.

 

 

DirectoryConfig

ImageStorageRoot

The root folder for image storage where documents are stored. In the installer, this is the Image Storage Path.

 

EncryptedStorage

When set to true, the files in the image storage are encrypted and the extracted document data is stored in the database. In the installer, this is the Encrypt All Data At Rest checkbox.

 

EncryptedKey

When set to true, the image storage encryption key is encrypted.

 

 

StorageEncryptionKey

The image storage encryption key.

 

 

DataCacheEnabled

Determines whether data caching is enabled. It is not recommended to alter this setting.

 

 

UseThumbnailCache

Determines whether the thumbnails used during data verification are created in advance to speed up processing. It is not recommended to alter this setting.

 

 

UseAbsoluteStoragePaths

Determines whether the path to images are stored as absolute paths in the database, as opposed to relative to the ImageStorageRoot folder.

 

 

ImageStorageType

Configures how the images and files are stored. This can be set to FileSystem or MongoDb. If set to MongoDb, you must configure a connection string using the ImageStorageConnectionString parameter.

 

 

ImageStorageConnectionString

The connection string for the MongoDB database, if ImageStorageType is set to MongoDb.

 

 

LicenseConfig

VolumeLicenseKey

Not used.

 

 

FeatureLicenseKey

Not used.

 

 

FeatureLicenseFile

Not used.

 

 

ProxyServer

Not used.

 

 

LicenseConsumptionThresholdPercent

Not used.

 

 

TimeoutConfig

BatchUserSendTimeoutMinutes

The timeout in minutes for submitting a batch to the server. In the user interface, this is the Batch send timeout option on the Configuration page.

 

BatchUserReceiveTimeoutMinutes

The timeout in minutes for downloading a batch into data verification. In the user interface, this is the Batch receive timeout option on the Configuration page.

 

BatchUserProcessTimeoutMinutes

The timeout in minutes for processing a batch in class and/or data verification. In the user interface, this is the Batch process timeout option on the Configuration page.

 

UserSessionTimeoutMinutes

The timeout in minutes for a user session after logging in. In the user interface, this is the User session timeout option on the Configuration page.

 

BatchImageStorageTimeoutDays

How long source files for completed batches are kept. After the specified number of days, the files will be deleted. In the user interface, this is the Retention period settings on the Configuration page.

 

OcrPerPageTimeoutSeconds

The timeout in seconds for OCR to be carried out on a page. In the user interface, this is the OCR per page timeout option on the Configuration page.

 

DataCapturePerPageTimeoutSeconds

The timeout in seconds for Data Capture processing to be carried out on a single page. In the user interface, this is the Data capture per page timeout option on the Configuration page.

 

ClassifyPerPageTimeoutSeconds

The timeout in seconds for classifying a single page. In the user interface, this is the Classification per page timeout option on the Configuration page.

 

ExportPerPageTimeoutSeconds

The timeout in seconds for exporting a single page. In the user interface, this is the Export per page timeout option on the Configuration page.

 

ImageProcessingPerFileTimeoutSeconds

The timeout in seconds per file for processing a file using the Image Processing Client. In the user interface, this is the Image processing per file timeout option on the Configuration page.

 

FieldTemplateMappingsLockTimeoutSeconds

The timeout in seconds for update lock on the mappings. In the user interface, this is the Mappings update lock option on the Configuration page.

 

CaptureModelLockTimeoutSeconds

 It is not recommended to alter this setting. This parameter is for internal development use only.

 

 

ClassificationModelLockTimeoutSeconds

 It is not recommended to alter this setting. This parameter is for internal development use only.

 

 

TemplateMergeLockTimeoutSeconds

 It is not recommended to alter this setting. This parameter is for internal development use only.

 

 

TemplateMergeItemStoreTimeoutDays

 It is not recommended to alter this setting. This parameter is for internal development use only.

 

 

LogFileStorageTimeoutDays

The number of days the log files are kept for.

 

 

PasswordLifeCycleTimeoutDays

How often passwords must be changed.

This setting also applies to the passwords of the Automated Clients. If the Automated Clients' passwords expire, the system will not be operational.

 

 

PerformDatabaseCleanupWithImageStorage

When set to true, the system automatically clears data for completed batches from the database when deleting the images for those batches from the image storage folder. In the user interface, this is the Retention period settings on the Configuration page.

 

WorkflowConfig

AutoSkipClassVerify

When set to true, batches skip class verification for documents with high confidence. In the user interface, this is the Automatically skip Class Verify options on the Batch types page.

 

AutoSkipDataVerify

When set to true, batches skip data verification for documents with high confidence, and all required fields populated. In the user interface, this is the Automatically skip Data Verify option on the Batch types page.

 

UseReportingDatabase

When set to true, a separate reporting database is used for long-term storage of usage data and metrics. In the installer, this is the Enable reporting database checkbox.

 

SyncOldDataToReportingDatabase

When set to true, the server gradually copies data from the application database to the reporting database after the reporting database is enabled on a system for the first time.

 

 

Automated Client Manager

The parameters for the Automated Client Manager config file, which by default is located in: C:\Program Files (x86)\Blue Prism\Decipher Automated clients\SsiAutoClientManager.exe.config.

Node

Parameter name

Description

appSettings

ImageProcessingClientCount

The number of clients that are run. When set to -1, the Automated Client Manager automatically determines a suitable number of clients based on the machine's capabilities (CPU, RAM, and so on).

OcrClientCount

ClassificationClientCount

DataCaptureClientCount

ExportClientCount

CrashTimeoutMinutes

If a client fails, the Automated Client Manager will restore the required number of clients within the specified time. The default is 20 minutes.

HangTimeoutMinutes

If a client has not communicated with the server within the specified time, the Automated Client Manager will stop and restart the processes.

Generic client parameters

The following parameters are present in all of the Automated Clients: Image Processing Client, OCR Client, Classification Client, Data Capture Client, and Export Client. See each client section for additional parameters specific to the clients.

Node

Parameter name

Description

Set up during install?

Set up in UI?

appSettings

ServerIp

The IP of the application server the client will connect to. In the installer, this is the Server IP/URL field.

 

ServerPort

The port of the application server the client will connect to. In the installer, this is the Port field.

 

UserName

The username the client will use when connecting to the application server. Users and automated clients must have credentials in order to connect to the server. Decipher IDP has a predefined user, named generaluser with the password user, with sufficient permissions for the automated clients to operate.

If required, the users can be edited in the Admin panel, but the generaluser account should not be changed or deleted without configuring a suitable replacement.

In the installer, this is the Username field. In the interface, this is updated via the Users page.

Password

The password for the user the client will use when connecting to the server. If the password is changed by an administrator in the Admin panel, this parameter must also be updated.

In the installer, this is the Password field. In the interface, this is updated via the Users page.

ConnectionRetrySeconds

How long the client will wait to reconnect if the application server is unresponsive. Alternatively, if a client encounters an unexpected error, it will disconnect from the Server and reconnect after the specified time.

 

 

OcrSdkLogVerbosity

The level of detail contained in SDK logs for the OCR, Classification, and Data Capture Client. It can be set to a maximum of 9, which is recommended when troubleshooting.

 

 

LogRoot

The root folder where client log files are stored. This is appended with the LogPath parameter. Windows environment path variables can be used, for example %public%. The path must be accessible to the Windows user the client is running under.

 

 

LogPath

The file path where the client log files are stored. This is prefixed with the LogRoot parameter.

 

 

LogLayout

The layout of the log files. NLog layout renderers are used. For more information, refer to the NLog documentation.

 

 

LogsKeepForDays

The number of days log files are kept before being deleted. The client must be running for the log files to be deleted.

 

 

MinLogLevel

The log level. This can be set to: Fatal, Error, Warn, Info, Debug, Trace, or Off. It is recommended to set it to Debug when troubleshooting.

 

 

Classification Client

The parameters for the Classification Client config file, which by default is located in: C:\Program Files (x86)\Blue Prism\Decipher Automated Clients\SsiClassificationClient.exe.config.

Refer to the Generic Client parameters for details on parameters that are present in all the client config files.

Node

Parameter name

Description

appSettings

MaxWorkerCount

The number of Classification Clients to run. If set to the default value of -1, this is controlled by the ClassificationProcessingClientCount parameter in the Automated Client Manager config file.

MaxOcrWorkersPerClient

The number of OCR processes run by the client. If set to the default value of -1, a suitable value is selected based on the capabilities of the machine.

ClassifySdkLogVerbosity

The level of detail contained in SDK logs. It can be set to a maximum of 9, which is recommended when troubleshooting.

Data Capture Client

The parameters for the Data Capture Client config file, which by default is located in: C:\Program Files (x86)\Blue Prism\Decipher Automated Clients\SsiDataCaptureClient.exe.config.

Refer to the Generic Client parameters for details on parameters that are present in all the client config files.

Node

Parameter name

Description

appSettings

RefreshTemplatesInMinutes

Deprecated.

EnableModelTrainingML

When set to true, the Data Capture Client will process training data. Training may consume system resources and impact performance. It is advised that this setting is only enabled on a separate machine, for example, a machine with the NLP plugin and a GPU.

DisableSelectiveTrainingDataUpdate

Deprecated.

ClientSettingsProvider.ServiceUri

Not used.

Export Client

The parameters for the Export Client config file, which by default is located in: C:\Program Files (x86)\Blue Prism\Decipher Automated Clients\SsiExportClient.exe.config.

Refer to the Generic Client parameters for details on parameters that are present in all the client config files.

Node

Parameter name

Description

ExportSettings

xmlExport

A Blue Prism process is used to extract data, these parameters are not used.

csvExport

tiffExport

pdfExport

Image Processing Client

The parameters for the Image Processing Client config file, which by default is located in: C:\Program Files (x86)\Blue Prism\Decipher Automated Clients\SsiImageProcessingClient.exe.config.

Refer to the Generic Client parameters for details on parameters that are present in all the client config files.

Node

Parameter name

Description

appSettings

MaxWorkerCount

The number of Image Processing Clients to run. If set to the default value of -1, this is controlled by the ImageProcessingClientCount parameter in the Automated Client Manager config file.

EnableBorderLineRemoval

Not used.

AutoOrientationMode

Determines whether to use OCR processing data to automatically adjust page orientation. The document is analyzed as an image, and orientation is determined based on the direction in which characters protrude over a line, either above or below. In Latin-based and Cyrillic languages, characters tend to protrude below the line and this determines the orientation of the page. Some pages may be incorrectly orientated if they include all capital letters or numbers. In these cases you can use limited OCR processing, but this will impact processing time.

This parameter can be set to:

  • 0 – No OCR is used.

  • 1 – Use OCR tie breaker.

  • 2 – Use aggressive OCR tie breaker.

OCR Client

The parameters for the OCR Client config file, which by default is located in: C:\Program Files (x86)\Blue Prism\Decipher Automated Clients\SsiOcrClient.exe.config.

Refer to the Generic Client parameters for details on parameters that are present in all the client config files.

Node

Parameter name

Description

appSettings

MaxWorkerCount

The number of OCR Clients to run. If set to the default value of -1, this is controlled by the OCRProcessingClientCount parameter in the Automated Client Manager config file.

OcrRefreshTimeoutMinutes

How often the OCR engine is reset. It is not recommended to alter this setting.

BarcodeDetectionMode

Determines which barcode types are recognized. Updating this setting may improve barcode processing.

ExcludeBarcodeTypes

Determines which barcode types are not recognized. Updating this setting may improve barcode processing.

BarcodeEngine

Not used.

Web Client

The parameters for the Web Client config file, which by default is located in: C:\Program Files (x86)\Blue Prism\Decipher Web\Web.config.

Node

Parameter name

Description

Set up during install?

Set up in UI?

appSettings

SSI.IPAddress

The IP of the application server.

 

 

SSI.PortNumber

The port for the application server.

 

 

ExternalDBConnectionString

An optional connection string used by the Web Client to retrieve reports directly from the database. In the installer, this is the Application Database Connection String field. If not populated, the Web Client looks for the connection string in the application server config file, first in the SsiServerDbPublicparameter, and then SsiServerDb.

The connection string is not encrypted in the Web Client config file, but is encrypted in the application server config file. For enhanced security, the parameters in the application server config file should be used.

 

ClassVerifyThreshold

Deprecated.

 

 

ZoomControlEnabled

When set to true, when you click Alt + Z on your keyboard during data verification, a separate, magnified image of the selected text region will display. In the user interface, this is the Zoom view option in the Admin menu.

 

ChangeDocumentTypeEnabled

When set to true, the Document Type drop-down displays on the Data Verification page.

 

 

LoadValidDocuments

When set to false, valid documents are not loaded in Data Verification. These documents are still part of the batch, but are not presented to the user to verify.

 

 

RequireStrongPassword

When set to true, users must configure a password that is at least eight characters, and include at least three of the following:

  • One uppercase character

  • One lowercase character

  • One number

  • One special character

 

 

FastBatchLoadMode

When set to 1, images are not loaded when a batch is opened, significantly improving loading times. This can be useful for Data Verification users who process batches containing a large number of documents or pages. It is not recommended to enable this parameter when processing training batches, as the images will be loaded on demand.

 

 

RabbitMQHost

If using a remote RabbitMQ instance, the hostname or IP of the RabbitMQ instance.

 

 

RabbitMQUsername

If using a remote RabbitMQ instance, the user name of the RabbitMQ instance.

 

 

RabbitMQPassword

If using a remote RabbitMQ instance, the password of the RabbitMQ instance.

 

 

RabbitMQTLSEnabled

If using a remote RabbitMQ instance, when set to true the RabbitMQ communication is passed through a secure TLS connection. The RabbitMQTLSServerName and RabbitMQTLSPassphrase must also be populated.

 

 

RabbitMQTLSServerName

The name of the RabbitMQ server in the server certificate.

 

 

RabbitMQTLSPassphrase

The password for the certificate, if required.

 

 

system.web

sessionState

The timeout for a user session, in minutes.

 

 

customErrors

Not used.

 

 

httpCookies requireSSL

When set to true, SSL is required and IIS must be configured with a SSL certificate.

 

 

SDK Service

The parameters for the SDK Service config file, which by default is located in:C:\Program Files (x86)\Blue Prism\Decipher Web SDK Service\SdkService\Ssi.SdkService.exe.config

Node

Parameter name

Description

appSettings

MinLogLevel

The log level. This can be set to: Fatal, Error, Warn, Info, Debug, Trace, or Off. It is recommended to set to Debug when troubleshooting.

RabbitMQHost

The hostname or IP for the RabbitMQ instance. If left blank, the default value localhost is used.

RabbitMQUsername

The username for the RabbitMQ instance. If left blank, the default value guest is used. The guest account only works if the RabbitMQ instance is on the local machine, and the guest account enabled in RabbitMQ.

RabbitMQPassword

The password for the RabbitMQ instance. If left blank, the default value guest is used. The guest account only works if the RabbitMQ instance is on the local machine, and the guest account enabled in RabbitMQ.

SDK Wrapper

The parameters for the SDK Wrapper config file, which by default is located in: C:\Program Files (x86)\Blue Prism\Decipher Web SDK Service\SdkWrapper\Ssi.SdkWrapper.exe.config

Node

Parameter name

Description

appSettings

MinLogLevel

The log level. This can be set to: Fatal, Error, Warn, Info, Debug, Trace, or Off. It is recommended to set to Debug when troubleshooting.

OcrSdkLogVerbosity

The level of detail contained in SDK logs. It can be set to a maximum of 9, which is recommended when troubleshooting.

RabbitMQHost

The hostname or IP for the RabbitMQ instance. If left blank, the default value localhost is used.

RabbitMQUsername

The username for the RabbitMQ instance. If left blank, the default value guest is used. The guest account only works if the RabbitMQ instance is on the local machine, and the guest account enabled in RabbitMQ.

RabbitMQPassword

The password for the RabbitMQ instance. If left blank, the default value guest is used. The guest account only works if the RabbitMQ instance is on the local machine, and the guest account enabled in RabbitMQ.