Using the Decipher VBO

This section can be used as a reference when using the Decipher VBO to create your own SS&C | Blue Prism® Decipher IDP processes. For details on setting up the VBO, see Install and configure Blue Prism Enterprise.

The Decipher VBO contains the following actions:

This version of the VBO is only supported in Decipher IDP 2.3 or later.

Overview

When creating batches, the batch is sent to Decipher IDP via a Decipher IDP-specific queue in Blue Prism Enterprise. Runtime resources interact with Decipher IDP through the Decipher VBO actions and the SsiDecipherHelper.dll, which is downloaded and set up as part of the installation process. For more information, see Add the Decipher DLL. The Decipher VBO provides you with the common actions used when creating, processing, and managing batches.

Documents should be sent to Decipher IDP in batches containing between one and 15 documents. A maximum of 15 documents per batch is current best practice, but is not mandatory.

Create Connection

The Create Connection action creates a new connection instance with Decipher IDP using the connection details and user credentials provided in the inputs. This action must be run before any subsequent actions can be attempted. Once run, and the connection has been successfully created, this action does not need to be run again (subject to any timeout configuration).

The Create Connection action creates the connection with Decipher IDP, but doesn't create a session. This is done in each action separately as they automatically log in and log out, ensuring no sessions are left open.

The previous version of the VBO contained both Set Up and Log In actions – the Create Connection action replaces both of these actions. This is because RabbitMQ is no longer utilized as part of the VBO.

Create Connection inputs

Decipher IP

The IP address of the Decipher Server.

Decipher Port

The port number of the Decipher Server.

Username

The user's username.

Password

The user's password.

Create Connection outputs

Success

A flag indicating if the connection has been successfully created.

Message

The error message returned by Blue Prism Enterprise if the Success flag is False.

Create New Batch

The Create New Batch action creates a new batch, adds the specified files, and submits it for verification.

The Create New Batch action uploads all supported file types from the defined Folder Path, including previously uploaded documents. Ensure you delete or move all uploaded files once processed.

The previous version of the VBO contained individual Create Batch, Add Files to Batch, and Submit Batch actions – the Create New Batch action replaces all of these actions.

Create New Batch inputs

New Batch Details

A collection consisting of the following fields:

  • Batch Type (required) – The batch type name.

  • Batch Name (required) – The batch name.

  • Batch Description – A description for the batch.

  • Document Type Name – The document type name.

  • Priority – The priority for the batch.

  • Document Split Mode – The document split mode for the batch. This can be set to:

    • 0 – Uses intelligent document splitting, as configured as part of a linked classification model.

    • 1 – Each input file is one document.

    • 4 – Defers to the value defined in the Split Page Count parameter.

  • Split Page Count – After how many pages a document should be split. For example, if set to 2, a 10 page document would be split into 5 files.

  • Disable Auto-Orientation – Indicates if page auto-orientation is enabled.

  • Folder Path (required) – The folder path to the batch documents.

  • Files Per Batch – How many files to process per batch. If left blank, all files in the specified file location are added to a single batch.

Batch Metadata

The batch metadata.

The VBO does not include the obfuscateFileName functionality which was included in the VBO for Decipher IDP version 2.2 and earlier. It is the user's responsibility to ensure file names do not disclose information which could be considered sensitive.

Create New Batch outputs

Batch IDs

The batch IDs of the newly created batches. This is used as an input for the Get Batch Details and Mark Batch Complete actions.

File List

The files that have been added to the batch.

Total File Count

The total file count for the batch.

Success

A flag indicating if the batch has been successfully created.

Message

The error message returned by Blue Prism Enterprise if the Success flag is False.

Get Batches Awaiting Class Verification

The Get Batches Awaiting Class Verification action retrieves a list of batches that are currently waiting for manual class verification. If required, you can filter the list to only return a specific batch type.

Get Batches Awaiting Class Verification inputs

Batch Type Name

The batch type name. If specified, only batches with the specified batch type are returned.

Max Batch Count

The maximum number of batches that will be returned. The default is 50.

Get Batches Awaiting Class Verification outputs

Batch List

The list of returned batches. This is a collection containing the following fields:

  • Batch ID

  • Batch Type Name

  • Batch Name

  • Batch Description

  • Priority

  • Document Count

  • Page Count

  • Created On

  • Last Processed

Batch Count

The number of batches returned.

Success

A flag indicating if the batches have been successfully returned.

Message

Contains the error message returned by Blue Prism if the Success flag is False.

Get Batches Awaiting Data Verification

The Get Batches Awaiting Data Verification action retrieves a list of batches that are currently waiting for manual data verification. If required, you can filter the list to only return a specific batch type.

Get Batches Awaiting Data Verification inputs

Batch Type Name

The batch type name. If specified, only batches with the specified batch type are returned.

Max Batch Count

The maximum number of batches that will be returned. The default is 50.

Get Batches Awaiting Data Verification outputs

Batch List

The list of returned batches. This is a collection containing the following fields:

  • Batch ID

  • Batch Type Name

  • Batch Name

  • Batch Description

  • Priority

  • Document Count

  • Page Count

  • Created On

  • Last Processed

Batch Count

The number of batches returned.

Success

A flag indicating if the batches have been successfully returned.

Message

The error message returned by Blue Prism Enterprise if the Success flag is False.

Get Batches Awaiting Export

The Get Batches Awaiting Export action retrieves a list of batches that are currently ready to be exported. If required, you can filter the list to only return a specific batch type.

Get Batches Awaiting Export inputs

Batch Type Name

The batch type name. If specified, only batches with the specified batch type are returned.

Max Batch Count

The maximum number of batches that will be returned. The default is 50.

Get Batches Awaiting Export outputs

Batch List

The list of returned batches. This is a collection containing the following fields:

  • Batch ID

  • Batch Type Name

  • Batch Name

  • Batch Description

  • Priority

  • Document Count

  • Page Count

  • Created On

  • Last Processed

Batch Count

The number of batches returned.

Success

A flag indicating if the batches have been successfully returned.

Message

The error message returned by Blue Prism Enterprise if the Success flag is False.

Get Active Batches

The Get Active Batches action retrieves a list of all batches currently being processed by Decipher IDP, including deleted and exported batches. If required, you can filter the list to only return a specific batch type.

Only batches with the state 4 (UserProcessing) or 5 (ReadyForProcessing) are considered active and returned by this action.

Batches with an active status are also returned by this action. Status is a combination of the current state, last processing role, and next processing role, and the number of statuses in a system can vary depending on the number of active roles. An active batch status, for example, would be OCR performed - ready for Data Capture.

For more information on batch states and roles, see Batches.

Get Active Batches inputs

Batch Type Name

The batch type name. If specified, only batches with the specified batch type are returned.

Max Batch Count

The maximum number of batches that will be returned. The default is 50.

Get Active Batches outputs

Batch List

The list of returned batches. This is a collection containing the following fields:

  • Batch ID

  • Batch Type Name

  • Batch Name

  • Batch Description

  • Status

  • Priority

  • Document Count

  • Page Count

  • Created On

  • Last Processed

Batch Count

The number of batches returned.

Success

A flag indicating if the batches have been successfully returned.

Message

The error message returned by Blue Prism Enterprise if the Success flag is False.

Get Batch Details

The Get Batch Details action retrieves information on a specified batch.

Get Batch Details inputs

Batch ID

The batch ID for the relevant batch. This can be retrieved from the Batch IDs output of the Create New Batch action.

Get Batch Details outputs

Batch Details

The batch details. This is a collection containing the following fields:

  • Batch Name

  • Batch Description

  • Batch Type Name

  • Created On

  • Last Processed

  • Priority

  • Batch Split

  • Additional Batches

Document List

The documents contained in the batch. This is a collection containing the following fields:

  • Document ID

  • Document Type

  • Page Count

  • Exception

  • Exception Detail

  • File Name

Batch Metadata

The batch metadata.

Document Count

The number of documents in the batch.

Success

A flag indicating if the batch details have been successfully returned.

Message

The error message returned by Blue Prism Enterprise if the Success flag is False.

Get Document Details

The Get Document Details action retrieves information on a specified document.

Get Document Details inputs

Document ID

The document ID for the relevant document. This can be retrieved from the Document ID field in the Doc List output of the Get Batch Details action.

Get Document Details outputs

Document Details

The document details. This is a collection containing the following fields:

  • DFD Name

  • Created On

  • Completed On

  • Status

  • Exception

  • Exception Detail

  • Confidence

  • Validity

  • Table Count

Document Fields

A collection containing the extracted data, with the field confidence and field validity data.

Document Tables

A collection containing the extracted table data, with the field confidence and field validity data.

Success

A flag indicating if the document details have been successfully returned.

Message

The error message returned by Blue Prism Enterprise if the Success flag is False.

Mark Batch As Complete

The Mark Batch As Complete action updates a batch's status to Complete, and can be used after a batch has been processed in Blue Prism Enterprise and the extracted data is stored and for use in subsequent processing. Once marked as complete, batches are removed from the Batches tab in the Admin Panel, and retained as per the system's configured data retention policy.

Mark Batch As Complete inputs

Batch ID

The batch ID for the relevant batch. This can be retrieved from the Batch IDs output of the Create New Batch action.

Mark Batch As Complete outputs

Success

A flag indicating if the batch has been successfully marked as completed.

Message

Contains the error message returned by Blue Prism if the Success flag is False.

Create A New Classification Training Batch

The Create A New Classification Training Batch action creates a new classification training batch, adds the specified files, and submits it for training.

Create A New Classification Training Batch inputs

New Batch Details

A collection consisting of the following fields:

  • Batch Type (required) – The batch type name.

  • Batch Name (required) – The batch name.

  • Batch Description (required) – A description for the batch.

  • Document Type Name – The document type name.

  • Folder Path (required) – The folder path to the batch documents.

Create A New Classification Training Batch outputs

Batch ID

The batch ID for the newly created batch. This is used as an input for the Get Batch Details and Mark Batch Complete actions.

Files Uploaded

The files that have been added to the batch.

Total File Count

The total file count for the batch.

Success

A flag indicating if the training classification batch has been successfully created.

Message

The error message returned by Blue Prism Enterprise if the Success flag is False.

Get Batch Status

The Get Batch Status action retrieves the status of a specified batch, allowing you to track the progress of the batch.

Get Batch Status inputs

Batch ID

The batch ID for the relevant batch. This can be retrieved from the Batch IDs output of the Create New Batch action.

Get Batch Status outputs

Batch Status

The status of the batch.

Batch Role

The current role that is processing the batch. For more information on the role IDs, see Batches.

Document Count

The number of documents in the batch.

Batch Split

A flag indicating if the batch has been split into other batches.

Additional Batch IDs

A collection containing the batch IDs of any other batches that have been created if the original batch is split. This collection is only populated if the Batch Split flag is True.

Success

A flag indicating if the batch status has been successfully returned.

Message

The error message returned by Blue Prism Enterprise if the Success flag is False.

Set Batch Metadata

The Set Batch Metadata action updates the batch's metadata.

Set Batch Metadata inputs

Batch ID

The batch ID for the relevant batch. This can be retrieved from the Batch IDs output of the Create New Batch action.

Metadata

The metadata for the batch.

Set Batch Metadata outputs

Success

A flag indicating if the batch metadata has been successfully updated.

Message

The error message returned by Blue Prism Enterprise if the Success flag is False.

Get Batch Metadata

The Get Batch Metadata retrieves the metadata of a specified batch.

Get Batch Metadata inputs

Batch ID

The batch ID for the relevant batch. This can be retrieved from the Batch IDs output of the Create New Batch action.

Get Batch Metadata outputs

Batch Metadata

The batch's metadata.

Success

A flag indicating if the batch metadata has been successfully returned.

Message

The error message returned by Blue Prism Enterprise if the Success flag is False.