> ## 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.

# UiPath Activity Package

> Reference for the ABBYY FlexiCapture Multi-Task activities in UiPath: FlexiCapture Project Scope, Create Batch, Get Batch Stage, and Fetch Batch Result.

The **Abbyy.UiPath.FlexiCapture.MultiTaskActivities.nupkg** activities package offers all the functionality you need to work with FC 12. It includes the following activities for working with ABBYY FlexiCapture:

* [FlexiCapture Project Scope](#flexicaptureprojectscope)
* [Create Batch](#createbatch)
* [Get Batch Stage](#getbatchstage)
* [Get Batch Verification URLs](#getbatchverificationurls)
* [Fetch Batch Result](#fetchbatchresults)

## <a id="flexicaptureprojectscope" />FlexiCapture Project Scope

This activity is used for initializing the other activities in the package through the FC 12 connection settings. These other activities are placed in the child activity area to give them access to the FC connection settings.

<Frame>
  <img src="https://mintcdn.com/abbyy/jk6a9TGm7KRcVxRI/images/flexi-capture/connectors/UiCon_20.png?fit=max&auto=format&n=jk6a9TGm7KRcVxRI&q=85&s=5cce87a5dd6a0e8140133d113331d4e0" alt="Screenshot of the FlexiCapture Project Scope activity Properties panel in UiPath Studio, showing its FlexiCapture Connection Settings fields for Company, Password, Project name, Server URL, and Username, plus the optional Proxy Settings." width="343" height="390" data-path="images/flexi-capture/connectors/UiCon_20.png" />
</Frame>

The following is a list of activity parameters that are inherited by child activities:

| **Category**                     | **Display Name** | **Type**     | **Description**                     |
| -------------------------------- | ---------------- | ------------ | ----------------------------------- |
| FlexiCapture Connection Settings | Server URL       | Uri          | Server address (without the tenant) |
| FlexiCapture Connection Settings | Company          | String       | Server tenant name (optional)       |
| FlexiCapture Connection Settings | Username         | String       | User name                           |
| FlexiCapture Connection Settings | Password         | SecureString | User password                       |
| FlexiCapture Connection Settings | Project name     | String       | Project name                        |
| Proxy Settings (optional)        | Server URL       | Uri          | Proxy server address                |
| Proxy Settings (optional)        | Username         | String       | User name                           |
| Proxy Settings (optional)        | Password         | SecureString | User password                       |

The FlexiCapture Project Scope designer allows you to manage connection settings and child activities:

<Frame>
  <img src="https://mintcdn.com/abbyy/jk6a9TGm7KRcVxRI/images/flexi-capture/connectors/UiCon_21.png?fit=max&auto=format&n=jk6a9TGm7KRcVxRI&q=85&s=9d19251d6e449e3bfcae7b99dad86d35" alt="Screenshot of the FlexiCapture Project Scope activity designer in UiPath Studio, showing the FlexiCapture 12 connection settings fields and the Do container holding a child Create Batch activity." width="346" height="513" data-path="images/flexi-capture/connectors/UiCon_21.png" />
</Frame>

If you are using a proxy:

1. Create the following variables:
   * A variable of type **Uri** named **ProxyAddress** with the following value:

**New UriBuilder ("[http://proxyserver:8080").Uri](http://proxyserver:8080"\).Uri)**. In place of **"[http://proxyserver:8080](http://proxyserver:8080)"**, specify the address and port of the proxy server.

* A variable of type **NetworkCredential** named **ProxyCredential** with the following value:

**New System.Net.NetworkCredential("proxyuser", "proxypass")**. In place of **"proxyuser"** and **"proxypass"**, specify the proxy credentials separated by a comma. Create this variable if your proxy uses Basic authentication.

<Frame>
  <img src="https://mintcdn.com/abbyy/jk6a9TGm7KRcVxRI/images/flexi-capture/connectors/UiCon_63.png?fit=max&auto=format&n=jk6a9TGm7KRcVxRI&q=85&s=e2ef6573119c0606e9e53423e2510781" alt="Screenshot of the Variables tab in UiPath Studio, showing the Uri-type ProxyAddress variable and the NetworkCredential-type ProxyCredential variable defined with their proxy server address and credentials." width="740" height="96" data-path="images/flexi-capture/connectors/UiCon_63.png" />
</Frame>

2. Use the variables created in step 1 to pass the proxy connection settings to the FlexiCapture Project Scope activity (click **FlexiCapture Project Scope → Proxy Settings (optional)**). Depending on the authentication type required by the proxy, do the following:
   * If a transparent proxy is used, in the **Server URL** field, pass the proxy server address and port as the value of the **ProxyAddress** variable and leave the **Username** and **Password** fields empty.
   * If the proxy uses NTLM authentication, in the **Server URL** field, pass the proxy server address and port as the value of the **ProxyAddress** variable and leave the **Username** and **Password** fields empty. The credentials under which the UiPath process is running will be used.
   * If the proxy uses Basic authentication, in the **Server URL** field, pass the proxy server address and port as the value of the **ProxyAddress** variable. In the **Username** and **Password** fields, pass the proxy credentials as the values of the corresponding properties of the **ProxyCredential** variable.

     <Frame>
       <img src="https://mintcdn.com/abbyy/jk6a9TGm7KRcVxRI/images/flexi-capture/connectors/UiCon_64.png?fit=max&auto=format&n=jk6a9TGm7KRcVxRI&q=85&s=101e1d318f68a57ed54e4314d9b91a26" alt="Screenshot of the FlexiCapture Project Scope activity Properties panel in UiPath Studio with the Proxy Settings (optional) section expanded, showing the Server URL, Username, and Password fields populated from the ProxyAddress and ProxyCredential variables." width="395" height="233" data-path="images/flexi-capture/connectors/UiCon_64.png" />
     </Frame>

<Note>
  These proxy server settings will be inherited by all the child activities of this Project Scope.
</Note>

## <a id="createbatch" />Create Batch

This activity is used to send files to FC 12 for processing. ABBYY FlexiCapture creates a batch with a unique identifier for all documents sent by this activity. This identifier is then returned as the **Batch ID** output argument.

<Frame>
  <img src="https://mintcdn.com/abbyy/jk6a9TGm7KRcVxRI/images/flexi-capture/connectors/UiCon_22.png?fit=max&auto=format&n=jk6a9TGm7KRcVxRI&q=85&s=1c4adb120c97ef0a0b21ad7a8e539d89" alt="Screenshot of the Create Batch activity Properties panel in UiPath Studio, showing its Input parameters for Batch files, Batch registration parameters, and Batch type name, and the Batch ID output parameter." width="678" height="259" data-path="images/flexi-capture/connectors/UiCon_22.png" />
</Frame>

Activity parameters:

| **Category** | **Display Name**              | **Type**                                     | **Description**                                                                                                                                                                       |
| ------------ | ----------------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Input        | Batch type name               | String                                       | Name of the batch type for the batch that is being created (optional)                                                                                                                 |
| Input        | Batch registration parameters | IEnumerable\<KeyValuePair\< String,String >> | A collection of registration parameters for the batch that is being created, specified in the following format: Registration parameter name — Registration parameter value (optional) |
| Input        | Batch files                   | IEnumerable\<KeyValuePair\<String,Byte\[]>>  | A collection of input files for the batch that is being created, specified in the following format: File name — Byte content                                                          |
| Output       | Batch ID                      | Int32                                        | ID of the created batch                                                                                                                                                               |

## <a id="getbatchstage" />Get Batch Stage

This activity is used to get information about the current batch stage. Values describing the batch state can be used, for example, to group batches for processing by their current stage.

<Frame>
  <img src="https://mintcdn.com/abbyy/jk6a9TGm7KRcVxRI/images/flexi-capture/connectors/UiCon_23.png?fit=max&auto=format&n=jk6a9TGm7KRcVxRI&q=85&s=b6e5877567c4832d577c381a6fb0ae07" alt="Screenshot of the Get Batch Stage activity Properties panel in UiPath Studio, showing the Batch ID input and the Details, Stage name, and Stage type outputs." width="655" height="259" data-path="images/flexi-capture/connectors/UiCon_23.png" />
</Frame>

Activity parameters:

| **Category** | **Display Name** | **Type** | **Description**                                                                |
| ------------ | ---------------- | -------- | ------------------------------------------------------------------------------ |
| Input        | Batch ID         | Int32    | Batch ID                                                                       |
| Output       | Stage type       | Enum     | [Processing stage](/flexi-capture/api/structures/t-processing-stage-type) type |
| Output       | Stage name       | String   | Processing stage name                                                          |
| Output       | Details          | String   | Additional information about the state of the batch                            |

## <a id="getbatchverificationurls" />Get Batch Verification URLs

This activity is used to get a set of links to the FC Web Verification Station for batch verification (uses the batch ID).

<Frame>
  <img src="https://mintcdn.com/abbyy/jk6a9TGm7KRcVxRI/images/flexi-capture/connectors/UiCon_24.png?fit=max&auto=format&n=jk6a9TGm7KRcVxRI&q=85&s=a5b7ae8728adda730fc320ef871cf424" alt="Screenshot of the Get Batch Verification URLs activity Properties panel in UiPath Studio, showing the Batch ID input and the Verification URLs output that returns links to verification tasks in the FlexiCapture Web Verification Station." width="655" height="209" data-path="images/flexi-capture/connectors/UiCon_24.png" />
</Frame>

Activity parameters:

| **Category** | **Display Name**  | **Type**           | **Description**                  |
| ------------ | ----------------- | ------------------ | -------------------------------- |
| Input        | Batch ID          | Int32              | Batch ID                         |
| Output       | Verification URLs | IEnumberable\<Uri> | A set of batch verification URLs |

## <a id="fetchbatchresults" />Fetch Batch Result

This activity is used to get the batch processing results.

<Frame>
  <img src="https://mintcdn.com/abbyy/jk6a9TGm7KRcVxRI/images/flexi-capture/connectors/UiCon_25.png?fit=max&auto=format&n=jk6a9TGm7KRcVxRI&q=85&s=45650b866af19080e7eeb8fa27afea16" alt="Screenshot of the Fetch Batch Result activity Properties panel in UiPath Studio, showing the Batch ID input and the Batch registration parameters and Document processing results outputs." width="784" height="234" data-path="images/flexi-capture/connectors/UiCon_25.png" />
</Frame>

Activity parameters:

| **Category** | **Name**                    | **Display Name**              | **Type**                                   | **Description**                      |
| ------------ | --------------------------- | ----------------------------- | ------------------------------------------ | ------------------------------------ |
| Input        | BatchId                     | Batch ID                      | Int32                                      | Batch ID                             |
| Output       | BatchRegistrationParameters | Batch registration parameters | IEnumerable\<KeyValuePair\<String,String>> | Batch registration parameter set     |
| Output       | DocumentProcessingResults   | Document processing results   | IEnumerable\<DocumentProcessingResult>     | Batch document processing result set |

*DocumentProcessingResult* class properties:

| **Name**           | **Type**                                    | **Description**                         |
| ------------------ | ------------------------------------------- | --------------------------------------- |
| DocumentId         | Int32                                       | Document ID                             |
| DocumentDefinition | String                                      | Name of the matched document definition |
| Files              | IEnumerable\<KeyValuePair\<String,Byte\[]>> | Export files                            |
