ABBYY_FlexiCapture_12 user libraries specification

The ABBYY_FlexiCapture_12 set contains five user libraries. Each one lists its input and output parameters.

Configure.ums5

This library specifies the settings for connecting to ABBYY FlexiCapture for the CreateBatch, GetBatchStage, GetBatchVerificationURLs, and FetchBatchResult libraries.

The Configure scenario must precede the other ABBYY_FlexiCapture_12 libraries in the workflow.

Direction	Name	Description
In	Server URL	ABBYY FlexiCapture Application Server address.
In	Company	ABBYY FlexiCapture tenant name. Optional.
In	User name	ABBYY FlexiCapture user name.
In	Password	ABBYY FlexiCapture user password.
In	Project	ABBYY FlexiCapture project name.

CreateBatch.ums5

This library sends all files from the specified folder to ABBYY FlexiCapture for processing, and returns the ID of the batch created for them. A single batch is created for all of the files.

Direction	Name	Description
In	Batch type	ABBYY FlexiCapture batch type name. Optional. If left blank, the Default batch type is used.
In	Input folder	The full path to the images to be sent to ABBYY FlexiCapture.
Out	Batch ID	ID of the created batch.

GetBatchStage.ums5

This library gets information about the current stage of a batch.

Direction	Name	Description
In	Batch ID	Batch identifier.
Out	Stage type	A number denoting the current stage type of the batch.
Out	Stage name	The name of the current batch stage.
Out	Details	A detailed description of the current stage. For batches in the Exceptions stage, error descriptions are provided.

For more information about the stage type numbers, see Processing stage types.

GetBatchVerificationURLs.ums5

This library returns Web Verification Station task URLs for a batch.

Direction	Name	Description
In	Batch ID	Batch identifier.
Out	Verification URLs	Collection of links separated by `;`.

FetchBatchResult.ums5

This library gets batch processing results.

Direction	Name	Description
In	Batch ID	Batch identifier.
In	Output folder	The folder where batch processing results are saved.
Out	Number of documents	The number of documents in the batch.
Out	Document IDs	A string containing batch document IDs separated by `;`.
Out	Document definitions	A string containing batch document names separated by `;`.

Export files are saved to the output folder using this structure:

<Output folder>/<Batch ID>/<Document ID>/<Name of the exported file>

UiPath

Blue Prism

Automation Anywhere

WinActor

Appian

Pega

M-Files

Laserfiche

NX Manager

ABBYY_FlexiCapture_12 user libraries specification

Configure.ums5

CreateBatch.ums5

GetBatchStage.ums5

GetBatchVerificationURLs.ums5

FetchBatchResult.ums5

​Configure.ums5

​CreateBatch.ums5

​GetBatchStage.ums5

​GetBatchVerificationURLs.ums5

​FetchBatchResult.ums5

Configure.ums5

CreateBatch.ums5

GetBatchStage.ums5

GetBatchVerificationURLs.ums5

FetchBatchResult.ums5