> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# ABBYY_FlexiCapture_12 user libraries specification

> Reference the ABBYY_FlexiCapture_12 UMS5 libraries for WinActor: Configure, CreateBatch, GetBatchStage, GetBatchVerificationURLs, and FetchBatchResult.

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.

|    | **Name**   | **Description**                |
| -- | ---------- | ------------------------------ |
| In | Server URL | FC Application Server address. |
| In | Company    | FC tenant name (optional).     |
| In | User name  | FC user name.                  |
| In | Password   | FC user password.              |
| In | Project    | FC 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.

|     | **Name**     | **Description**                                                                                   |
| --- | ------------ | ------------------------------------------------------------------------------------------------- |
| In  | Batch type   | FC batch type name (optional). If this parameter is left blank, the "Default" batch type is used. |
| In  | Input folder | The full path to the images to be sent to FC.                                                     |
| Out | Batch ID     | ID of the created batch.                                                                          |

## GetBatchStage.ums5

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

|     | **Name**   | **Description**                                                                                                                                                                     |
| --- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| In  | Batch ID   | Batch identifier.                                                                                                                                                                   |
| Out | Stage type | A number denoting the current stage type of the batch. For more information about stage types in FC, see [Processing stage types](/flexi-capture/reports/database/stage-type-enum). |
| 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 will be provided.                                                          |

## GetBatchVerificationURLs.ums5

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

|     | **Name**          | **Description**                       |
| --- | ----------------- | ------------------------------------- |
| In  | Batch ID          | Batch identifier.                     |
| Out | Verification URLs | Collection of links separated by ";". |

## FetchBatchResult.ums5

This library gets batch processing results.

<table width="100%"><tbody><tr><td> </td><td><p><strong>Name</strong></p></td><td><p><strong>Description</strong></p></td></tr><tr><td><p>In</p></td><td><p>Batch ID</p></td><td><p>Batch identifier.</p></td></tr><tr><td><p>In</p></td><td><p>Output folder</p></td><td><p>The folder where batch processing results are saved. Export files are saved to this folder as follows:</p><p>\<Output folder> / \<Batch ID> / \<Document ID> / \< Name of the exported file ></p></td></tr><tr><td><p>Out</p></td><td><p>Number of documents</p></td><td><p>The number of documents in the batch.</p></td></tr><tr><td><p>Out</p></td><td><p>Document IDs</p></td><td><p>A string containing batch document IDs separated by ";".</p></td></tr><tr><td><p>Out</p></td><td><p>Document definitions</p></td><td><p>A string containing batch document names separated by ";".</p></td></tr></tbody></table>
