Batch types

A batch is a collection or batch of documents. Batch types are defined in advance, and can contain more than one document type, with their corresponding document form definitions – enabling you to process documents of different types all in the same batch. Most settings are defined at the batch type level which gives you the flexibility to define different configurations for different document groups.

Batch types can only be created if there are already document types in the system.

A batch type contains:

  • Settings - import, export, language, etc.
  • One or more configured document types.
  • A Classification model (optional).

You can add batch types by dragging a .BDT file onto this page. Once uploaded, you can use it to process documents. Batch types can also be edited to further tailor them to requirements.

You can also create batch types. Click Add batch type to open the Add batch type page.

The following three actions are available for listed batch types:

  • Edit
  • Download
  • Delete

Configuring batch types

New and existing batch types can be configured in the Add/Edit Batch Type dialog. From Admin Panel > Batch Types, click Add batch type, or edit an existing batch type.

Batch type details

Batch type name

The name of your new batch type, for example Invoices.


An optional text description for your batch type.

Classification model

Select the classification model used to classify documents in this batch type. Leave this blank if you don’t want to automatically classify documents for this batch type.

Included document types

Select all document types that you want to include in this batch type. Often a batch will only contain a single document type, however, as each document type references a single document form definition if you add multiple document types to your batch type, you can add a variety of documents needing different templates to a single batch.

General settings

Primary recognition language

The primary language to use when processing documents using this batch type. If configured, this setting will be overridden by the equivalent document type setting.

Primary locale

The primary locale is used to validate dates and parse addresses during processing using this batch type. If configured, this setting will be overridden by the equivalent document type setting.

Secondary recognition language

An additional language to be used for processing this type of documents. If configured, this setting will be overridden by the equivalent document type setting.

Secondary locale

An additional locale for this document type. If configured, this setting will be overridden by the equivalent document type setting.

Date display format

Any captured date will be converted to this format and displayed in the Form View for the operator to change or approve. If set to Original the dates will not be re-formatted.

Default priority

Six levels of priority are available from highest to lowest.

SLA (hours)

This is the maximum time for a batch to get processed. Administrators of the system can generate a report to see whether any batches have been processed slower.

Separate documents

The following options are available:

  • Separate exception documents in new batches – Documents with an exception state are automatically separated into a new batch so the workflow can continue normally.

  • Separate documents with high confidence types in new batches before class verification – High confidence documents are added to a new batch before class verification.

  • Separate documents with high confidence types in new batch before data verification – High confidence documents are added to a new batch before data verification.

Automatically skip Class Verify

Batches with documents of a high confidence automatically skip class verification. This can be configured to On, Off, or System Default. If System Default is selected, Decipher IDP defers to the Automatically skip user modules settings as configured in the Admin Panel.

Automatically skip Data Verify

Batches with documents of a high confidence automatically skip data verification. This can be configured to On, Off, or System Default. If System Default is selected, Decipher IDP defers to the Automatically skip user modules settings as configured in the Admin Panel.

Blank page detection configuration

The following options improve the detection and handling of blank pages:

  • Ignore margins (mm) – Defines the depth of the page margin, in millimeters, which will be ignored by the blank page detection algorithm. This is useful when scanned images contain a large border.

  • Use black threshold – Determines if the Percentage of allowed black content setting is used and enables the input field.

  • Percentage of allowed black content – A minimum percentage value of black content on a page. If a page is detected to contain black content above this value, it is automatically classified as not blank. Any color different to the background color is classed as black.

Classification mode

  • Disable – No document classification will be done for documents in this batch type. Classification models do not need to be created and trained if using a batch type with only one document type.
  • Semantic – Documents will be classified based on their content. You need to select a classification model.

Perform internal document separation

Automatically separates document based on a classification model. Enable this option if the batch type contains more than one document type.

Validation lists

Watch a video about validation lists.

Lists are used to validate and increase the success rate of data capture. For example, you can import a list of all the vendor names, country or state codes, authorized signatories, or similar, if they are known in advance. Then if the OCR engine misreads text, Decipher IDP can correct that error by looking for that value in the list. If a value is captured that is not in the list the software will highlight it for the operator to correct.

You need to specify and connect to the database that contains the validation list. To configure:

  1. Select a Database connection type from the drop-down.

  2. Enter the Connection string, including server name, database name, and relevant credentials where required.

    Database connection type

    For a validation list held in a database, select a database type of SQL Server or ODBC. The connection string format added below must match the connection type selected.

    Connection string

    Add a connection string to connect to the database containing the validation list. For example:

    SQL Server connection string:

    • Windows authentication: Server=myServerAddress;Database=myDataBase;Trusted_Connection=True;
    • SQL Server authentication: Server=myServerAddress;Database=myDataBase;User Id=myUsername;Password=myPassword;

    ODBC connection string:

    • Windows authentication: Driver={SQL Server};Server=myServerAddress;Database=myDataBase;Trusted_Connection=Yes
    • SQL Server authentication: Driver={SQL Server};Server=myServerAddress;Database=myDataBase;Uid=myUsername;Pwd=myPassword;

  3. Use the Test connection button to ensure the connection is valid.

  4. If the connection is successful, click Add new list.

  5. Populate the Add New List form, entering a List name, and specifying the location of the list in the database using the Table and Column drop-down fields.

    List name

    Enter a name for this validation list.


    Select the table that contains the validation data.


    Select the column that contains the validation data.

    ID column

    If applicable, select the ID of the table column containing the validation data. This is used if operating with the IdErpList flag enabled on the document form definition. For more information, see Field options for document form definition files.


    Enter a WHERE SQL clause to filter the list, if required.


    Enable this option to allow items to be added to, or removed from, the list during data verification. For more information, see Add values to validation lists.

  6. Click Create list.

SQL Server connections

For validation lists using trusted SQL Server connections, the user (or login) running the Decipher Web SDK service needs read-only access to the Decipher IDP databases. To configure the login running the service and assign the permissions:

  1. Start the Windows Services application (type Services into the Windows search bar).

  2. Locate the Decipher Web SDK service, right-click, then select Properties from the context menu.

  3. Select the Log On tab and select This account. The default login is Network Service. This can be updated to a user account, or set to a service account to enhance your local system security. Enter the relevant user name and related password. The user configured here will need to be added to the SQL Server Logins.

  4. Open Microsoft SQL Server Management Studio and connect to the instance that is hosting your Decipher IDP database.

  5. In Security > Logins, locate the user running the Decipher Web SDK service (for example, NT AUTHORITY\NETWORK SERVICE). Right-click, then select Properties from the context menu.

  6. Click User Mapping.

  7. Select the relevant Decipher IDP database, then enable db_datareader from the bottom pane.

  8. Click OK.

Validation list connections should now be successful. Ensure you select the relevant batch type when previewing your DFD.

Add values to validation lists

You can add or remove values from an existing validation list during data verification. This is only available if the Editable option is enabled for the validation list. To update values in a validation list during data verification:

  1. Highlight the relevant value in the document. The field is shown in red if it is not already part of the validation list.

  2. In the document form definition, right-click the field, and select Add to list.

    The value is added to the database, and displays as an option in the validation list.

  3. To remove a value, select the relevant value from the validation list drop-down.

  4. Right-click the field, and select Remove from list.

    The value is removed from the database, and will no longer display as an option in the validation list.

If the miscellaneous parameter AppendableListDirect is enabled on the field, values which are not already part of the validation list are added automatically. For more information, see Miscellaneous parameters.

Export settings

Only Blue Prism processes can be to used extract data from Decipher IDP. These export settings do not apply to this release of Decipher IDP.

Export decimal separators

You can change the decimal separator used, giving you more flexibility for different locales and currencies. On export, Money or Decimal type fields will be exported with the chosen decimal separator. This is done by configuring the DecimalSeparator setting in the Export Client's config file:

  1. Navigate to the SsiExportClient.exe.config file. The default location is:C:\Program Files (x86)\Blue Prism\Decipher Automated Clients\SsiExportClient.exe.config.

  2. Open the file in a text editor.

  3. In the appSettings section, locate the DecimalSeparator attribute, and update the value to one of the following:

    • 0 – The configured locale settings from the document type are used (default).

    • 1 – A period (.) separator is used.

    • 2 – A comma (,) separator is used.

  4. Save the changes to the SsiExportClient.exe.config file.

For more information, see Configuration file parameters.

User and group assignments

Batches of documents can be assigned to a particular user or user group. This means that only these users will be able to load these batches for processing in class or data verification.

If a batch is assigned to a user or a user group who cannot access it, for example, if they do not have the correct role enabled or if their account is deleted, the batch becomes visible to all users.

Assigned to all groups and users

All users will be able to load batches of this type.

Assigned to specific groups

Select this option and then place a check-mark next to each group of users that will be able to process batches of this type.

Assigned to specific users

Select this option and then place a check-mark next to each user who will be able to process batches of this type.

When viewing or generating reports in the Reports tab, any configured user or group assignments are not used. Any user with permission to access the Reports tab will be able to view the field data for processed batches.

Assignment filters

You can also define additional assignment filters, allowing you to control the visibility of batches to specific users or groups based on the batch name, description, or priority.

  1. From the Assign to selection, choose either Specific users or Specific groups.

  2. Click the filter icon on the relevant user or group.

  3. In the Assignment filters dialog, define an Operator (Equals, Starts with, Contains, Ends with).

  4. Enter a Value.

  5. Click Confirm.

Quality control

To increase accuracy and quality, you can choose to have some of the batches verified by more than one operator. To do that define a certain percentage of batches that will pass through a verification by a second operator. The system will randomly select these batches.

You can define these percentages separately for Class verify and Data verify and also for each user and user group. For example, if there are any novice operators in the team it is a good idea to have their work checked by a more experienced operator.

Exception reasons

Add exception reasons that can be selected when manually setting a document or a batch as an exception. Click Add New Exception and enter an exception reason description from those defined here. Exceptions could include business-specific exceptions, for example "Not authorized by X", or "Dated before payment window" etc.

For more information, see Exceptions.


This video describes how to create and configure validation lists.