Skip to main content
Below is a description of all the ABBYY_FlexiCapture_12 libraries.

Configure.ums5

This library specifies the settings for connecting to FC for the following libraries: CreateBatch, GetBatchStage, GetBatchVerificationURLs, and FetchBatchResult. The Configure scenario should precede the other ABBYY_FlexiCapture_12 libraries in the workflow.
NameDescription
InServer URLFC Application Server address.
InCompanyFC tenant name (optional).
InUser nameFC user name.
InPasswordFC user password.
InProjectFC project name.

CreateBatch.ums5

This library sends all files from the specified folder to FC for processing and returns the ID of the batch that was created for the sent files. A single batch is created for all of these files.
NameDescription
InBatch typeFC batch type name (optional). If this parameter is left blank, the “Default” batch type is used.
InInput folderThe full path to the images to be sent to FC.
OutBatch IDID of the created batch.

GetBatchStage.ums5

This library gets information about the current stage of a batch.
NameDescription
InBatch IDBatch identifier.
OutStage typeA number denoting the current stage type of the batch. For more information about stage types in FC, see FlexiCapture Online Help.
OutStage nameThe name of the current batch stage.
OutDetailsA detailed description of the current stage. For batches in the Exceptions stage, error descriptions will be provided.

GetBatchVerificationURLs.ums5

This library returns Web Verification Station task URLs for a batch.
NameDescription
InBatch IDBatch identifier.
OutVerification URLsCollection of links separated by ”;”.

FetchBatchResult.ums5

This library gets batch processing results.
 

Name

Description

In

Batch ID

Batch identifier.

In

Output folder

The folder where batch processing results are saved. Export files are saved to this folder as follows:

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

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 ”;”.