Skip to main content
The FlexiCapture 12 – Multitask VBO offers all the functionality required for working with ABBYY FlexiCapture 12. It has two built-in actions, Initialize and Clean Up, plus the following actions for working with ABBYY FlexiCapture:
To learn more about the business object definition, launch Process Studio in Blue Prism, open the properties of the Action item, select FlexiCapture 12 – Multitask VBO, and click the information icon.

Configure

This action initializes the FlexiCapture 12 – Multitask VBO with the settings required to connect to ABBYY FlexiCapture 12. Always run it before any other action in the VBO.
Screenshot of the Configure action of the FlexiCapture 12 – Multitask VBO in Blue Prism, showing the connection settings used to connect to FlexiCapture 12.
The action accepts the ABBYY FlexiCapture server address, the tenant name (optional), the user name, the password, and the ABBYY FlexiCapture project name. It saves these settings to the data items so the other actions in the VBO can use them.
The ABBYY FlexiCapture user must have the Scanning Operator and Verification Operator roles for the given project, or the Administrator role. The administrator grants these roles in the ABBYY FlexiCapture Administration and Monitoring Console.

Connect through a proxy server

The action also accepts optional parameters for connecting through a proxy: the proxy server address, user name, and password. What you pass depends on the authentication the proxy requires.

Create Batch

This action sends files to ABBYY FlexiCapture 12 for processing. ABBYY FlexiCapture creates a batch with a unique ID for those files, with one document per input file. It processes the batch and returns the batch ID to Blue Prism.
Screenshot of the Create Batch action in Blue Prism, showing its BatchTypeName, Files, and RegProperties input parameters.
Screenshot of the Create Batch action in Blue Prism returning the ID of the newly created FlexiCapture batch.

Get Batch Stage

This action gets information about the current stage of a batch by its ID. It accepts only the BatchId variable, of type Number, as input.
Screenshot of the Get Batch Stage action in Blue Prism, showing the BatchId number variable accepted as input.
For the list of values corresponding to the predefined processing stages, see ProcessingStage.
Screenshot of the Get Batch Stage action outputs in Blue Prism, showing the Type, Name, and Details values for a batch.

Decide what to do next based on the stage

The current stage of a batch tells you what to do with it next. For example:
  • At the Import stage (Type 100), check the status again after a while.
  • At the Verification stage (Type 500), call the Get Batch Verification URLs action for the batch.
  • At the Processed stage (Type 900), call the Fetch Batch Results action for the batch.
The following outputs show a batch that has arrived at the verification stage.
Screenshot of the Get Batch Stage outputs in Blue Prism populated for a batch at the Verification stage.

Get Batch Verification URLs

This action gets a set of URLs pointing to the Web Verification Station, where a batch can be verified by its ID. Call it when a batch arrives at the verification stage. It accepts only the BatchId variable, of type Number, as input.
Screenshot of the Get Batch Verification URLs action in Blue Prism, showing the BatchId number variable accepted as input.
The output is a collection of verification URLs for the batch, returned to Blue Prism.
Screenshot of the Get Batch Verification URLs action in Blue Prism, showing the output collection of verification URLs for the batch.

Fetch Batch Results

This action gets batch processing results and provides them to Blue Prism for use in a subsequent workflow. Call it when a batch arrives at the Processed stage. It accepts only the BatchId variable, of type Number, as input.
Screenshot of the Fetch Batch Results action in Blue Prism, showing the BatchId number variable accepted as input.
The action outputs a collection of registration parameters with Name and Value fields, plus a collection of document processing results named DocumentResults:
Screenshot of the batch processing results outputs in Blue Prism, showing the registration parameters and document results collections.

Save Batch Results

This action gets batch processing results and stores them locally. Call it when a batch arrives at the Processed stage. It is an alternative to Fetch Batch Results that saves the result files to disk instead of returning their binary content.
Screenshot of the Save Batch Results action in Blue Prism, showing its BatchId and OutputDirectoryPath input parameters.
The outputs match those of Fetch Batch Results: a collection of registration parameters with Name and Value fields, plus a DocumentResults collection with DocumentId, DocumentDefinition, and Files fields.
Screenshot of the batch processing results outputs in Blue Prism, showing the registration parameters and document results collections.

Check If Configured

This auxiliary action checks whether the Configure action has already been called. The Create Batch, Get Batch Stage, Fetch Batch Results, and Get Batch Verification URLs actions use it.
Screenshot of the Check If Configured action in Blue Prism, an auxiliary action that verifies whether the Configure action has already been called.