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

> Reference for the ABBYY FlexiCapture 12 VBO business object in Blue Prism: its Process and Process and Save actions, input and output parameters, and setup.

The ABBYY FlexiCapture 12 VBO appears as a business object to Blue Prism. It sends files to ABBYY FlexiCapture 12 and gets back the processing results.

The VBO has two built-in actions, **Initialize** and **Clean Up**, plus two actions for working with ABBYY FlexiCapture: **Process** and **Process and Save**.

It ships with a sample process named `BPA Process - FlexiCapture 12 Processor.xml`.

## Process action

This action processes an input file in ABBYY FlexiCapture 12. The resulting export files are available as a file collection containing their binary content.

| Input parameter                 | Description                                                                                                                                                                 |
| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **ServerUrl**                   | The address of the ABBYY FlexiCapture server, in the format `http://<ApplicationServer>`.                                                                                   |
| **Company**                     | The name of the ABBYY FlexiCapture tenant. For ABBYY FlexiCapture Cloud, specify the name of your company. Leave empty if you are not working with a tenant.                |
| **Username**                    | The name of the ABBYY FlexiCapture user.                                                                                                                                    |
| **Password**                    | The password of the ABBYY FlexiCapture user.                                                                                                                                |
| **ProjectName**                 | The name of the project on the ABBYY FlexiCapture server.                                                                                                                   |
| **BatchType**                   | The name of the batch type assigned to the batch created in ABBYY FlexiCapture to process the file.                                                                         |
| **FileName**                    | The name of the input file.                                                                                                                                                 |
| **FileContent**                 | The file to send to ABBYY FlexiCapture. Must be stored in a data item of binary data type.                                                                                  |
| **BatchRegistrationParameters** | A collection of objects with **Name** and **Value** text fields. These become batch registration parameters on the ABBYY FlexiCapture side, useful for naming export files. |
| **ProxyServerUrl**              | Optional. The proxy server URL, for example `127.0.0.1:8080`.                                                                                                               |
| **ProxyUsername**               | Optional. The proxy server user name.                                                                                                                                       |
| **ProxyPassword**               | Optional. The proxy user password.                                                                                                                                          |
| **DocumentProcessingTimeout**   | Optional. The maximum wait time for results from ABBYY FlexiCapture before an error is thrown.                                                                              |

<Frame>
  <img src="https://mintcdn.com/abbyy/M5jnw37NmJ-asKkj/images/flexi-capture/connectors/BP31.png?fit=max&auto=format&n=M5jnw37NmJ-asKkj&q=85&s=325b56267896fb00a99f011c00c54dff" alt="Screenshot of the Inputs tab of the Process action in the ABBYY FlexiCapture 12 VBO in Blue Prism, showing its input parameters." width="725" height="631" data-path="images/flexi-capture/connectors/BP31.png" />
</Frame>

| Output parameter       | Description                                                                                                                      |
| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| **DocumentDefinition** | The name of the Document Definition that ABBYY FlexiCapture applied to the input image.                                          |
| **Fields**             | A collection of objects with **Name** and **Value** text fields, holding the names and extracted values of fields.               |
| **Files**              | A collection of objects with a **Name** text field and a **Content** binary field, holding exported image files and their names. |
| **VerificationUrl**    | A text field holding the URL of the document verification page.                                                                  |

<Frame>
  <img src="https://mintcdn.com/abbyy/M5jnw37NmJ-asKkj/images/flexi-capture/connectors/BP32.png?fit=max&auto=format&n=M5jnw37NmJ-asKkj&q=85&s=c3cac7ed46fc9fa8c9f97a407252ff67" alt="Screenshot of the Outputs tab of the Process action in the ABBYY FlexiCapture 12 VBO in Blue Prism, showing its output parameters." width="726" height="632" data-path="images/flexi-capture/connectors/BP32.png" />
</Frame>

<Tip>
  You can have the output data items created automatically by clicking the icon to the left of the value in the **Store In** column.
</Tip>

## Process and Save action

This action processes an input file in ABBYY FlexiCapture 12 and saves the resulting export files to an output directory. Its parameters match the **Process** action, plus **OutputDirectoryPath**.

| Input parameter                 | Description                                                                                                                                                                 |
| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **ServerUrl**                   | The address of the ABBYY FlexiCapture server, in the format `http://<ApplicationServer>`.                                                                                   |
| **Company**                     | The name of the ABBYY FlexiCapture tenant. For ABBYY FlexiCapture Cloud, specify the name of your company. Leave empty if you are not working with a tenant.                |
| **Username**                    | The name of the ABBYY FlexiCapture user.                                                                                                                                    |
| **Password**                    | The password of the ABBYY FlexiCapture user.                                                                                                                                |
| **ProjectName**                 | The name of the project on the ABBYY FlexiCapture server.                                                                                                                   |
| **BatchType**                   | The name of the batch type assigned to the batch created in ABBYY FlexiCapture to process the file.                                                                         |
| **FileName**                    | The name of the input file.                                                                                                                                                 |
| **FileContent**                 | The file to send to ABBYY FlexiCapture. Must be stored in a data item of binary data type.                                                                                  |
| **OutputDirectoryPath**         | The output directory, used to create subdirectories for the document results.                                                                                               |
| **BatchRegistrationParameters** | A collection of objects with **Name** and **Value** text fields. These become batch registration parameters on the ABBYY FlexiCapture side, useful for naming export files. |
| **ProxyServerUrl**              | Optional. The proxy server URL, for example `127.0.0.1:8080`.                                                                                                               |
| **ProxyUsername**               | Optional. The proxy server user name.                                                                                                                                       |
| **ProxyPassword**               | Optional. The proxy user password.                                                                                                                                          |
| **DocumentProcessingTimeout**   | Optional. The maximum wait time for results from ABBYY FlexiCapture before an error is thrown.                                                                              |

<Frame>
  <img src="https://mintcdn.com/abbyy/KEmWsO92hkr7eybZ/images/flexi-capture/connectors/Bp31_1.png?fit=max&auto=format&n=KEmWsO92hkr7eybZ&q=85&s=88ec28b3681ed0e1e76aecef0dda397c" alt="Screenshot of the Inputs tab of the Process and Save action in the ABBYY FlexiCapture 12 VBO in Blue Prism, showing its input parameters." width="1016" height="749" data-path="images/flexi-capture/connectors/Bp31_1.png" />
</Frame>

The output parameters are the same as for the **Process** action: **DocumentDefinition**, **Fields**, **Files**, and **VerificationUrl**.

<Frame>
  <img src="https://mintcdn.com/abbyy/KEmWsO92hkr7eybZ/images/flexi-capture/connectors/Bp32_1.png?fit=max&auto=format&n=KEmWsO92hkr7eybZ&q=85&s=c410da06ffbf1b07056cdc25ccdcf727" alt="Screenshot of the Outputs tab of the Process and Save action in the ABBYY FlexiCapture 12 VBO in Blue Prism, showing its output parameters." width="1020" height="748" data-path="images/flexi-capture/connectors/Bp32_1.png" />
</Frame>

## Install the ABBYY FlexiCapture 12 VBO

To make the VBO and its usage example available on the Blue Prism side, import the `BPA Object - FlexiCapture 12 VBO.xml` and `BPA Process - FlexiCapture 12 Processor.xml` files into Blue Prism.

<Steps>
  <Step title="Start the import">
    Open Blue Prism and click **File → Import**.
  </Step>

  <Step title="Select the files to import">
    Following the on-screen instructions, select the following files one by one:

    * `BPA Object - FlexiCapture 12 VBO.xml`
    * `BPA Process - FlexiCapture 12 Processor.xml`

    The usage example also needs two additional objects, whose default location is `C:\Program Files\Blue Prism Limited\Blue Prism Automate\VBO`:

    * `BPA Object - Utility - File Management.xml`, a business object for working with files stored on the local hard drive
    * `BPA Object - Utility - Environment.xml`, a business object for interacting with the environment, such as running third-party processes like a web browser
  </Step>

  <Step title="Check the import">
    After the import completes, all the business objects and the usage example appear in Blue Prism on the **Studio** tab.
  </Step>

  <Step title="Restart Blue Prism">
    Restart Blue Prism for the changes to take effect.
  </Step>
</Steps>

## Configure the ABBYY FlexiCapture 12 VBO

You can use the VBO to create a new Blue Prism process or integrate it into an existing process.

<Tip>
  You can also use the sample process named **BPA Process - FlexiCapture 12 Processor**, in `C:\Program Files (x86)\ABBYY FlexiCapture Connector for BluePrism\Single-Task Package\Samples\BluePrism Sample Process`.
</Tip>

<Steps>
  <Step title="Create or open a process">
    Create a new Blue Prism process, by right-clicking **Processes** on the **Studio** tab and clicking **Create Process**, or open an existing process.
  </Step>

  <Step title="Add an Action element">
    In the workspace, create an element of type **Action**, and then double-click it to open the action properties.
  </Step>

  <Step title="Select the business object and action">
    In the **Action Properties** window, specify a name for the new action in the **Name** field. In the **Business Object** drop-down list, select **FlexiCapture 12 VBO**. In the **Action** list, select the action you need.
  </Step>

  <Step title="Specify the input parameters">
    On the **Inputs** tab, specify the input parameters.

    You can specify values for text parameters explicitly by enclosing them in double quotation marks. For other data types, create the corresponding data items and specify their names in the **Value** column.

    <Frame>
      <img src="https://mintcdn.com/abbyy/M5jnw37NmJ-asKkj/images/flexi-capture/connectors/BP33.png?fit=max&auto=format&n=M5jnw37NmJ-asKkj&q=85&s=4b07f5e9dbc85582f5c1c90774196910" alt="Screenshot of the Inputs tab in the Blue Prism Action Properties window, showing example input parameter values for the FlexiCapture 12 VBO." width="931" height="753" data-path="images/flexi-capture/connectors/BP33.png" />
    </Frame>
  </Step>

  <Step title="Specify the output parameters">
    On the **Outputs** tab, specify the output parameters. You can have the data items created automatically by clicking the icon to the left of the value in the **Store In** column.

    <Frame>
      <img src="https://mintcdn.com/abbyy/M5jnw37NmJ-asKkj/images/flexi-capture/connectors/BP34.png?fit=max&auto=format&n=M5jnw37NmJ-asKkj&q=85&s=94d98d80c35d780231e543b6d5ed6f9d" alt="Screenshot of the Outputs tab in the Blue Prism Action Properties window, showing example output Data Items for the FlexiCapture 12 VBO." width="803" height="630" data-path="images/flexi-capture/connectors/BP34.png" />
    </Frame>
  </Step>
</Steps>

### Configure a proxy server

If you use a proxy server to connect to ABBYY FlexiCapture, what you pass depends on the authentication the proxy requires.

| Proxy authentication | What to pass                                                                                                                                                                            |
| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Transparent          | Pass the proxy server address and port in **ProxyServerUrl**. Leave **ProxyUsername** and **ProxyPassword** empty.                                                                      |
| NTLM                 | Pass the proxy server address and port in **ProxyServerUrl**. Leave **ProxyUsername** and **ProxyPassword** empty. The credentials that the `Automate.exe` process runs under are used. |
| Basic                | Pass the proxy server address and port in **ProxyServerUrl**, and pass the proxy credentials in **ProxyUsername** and **ProxyPassword**.                                                |

For the password, create a data item of type **Password** and set the required password as its value. Then use that data item to pass the password into the **ProxyPassword** input parameter.

For **ProxyServerUrl** and **ProxyUsername**, you can specify the values explicitly by enclosing them in double quotation marks.

### Change the timeout for processed documents

By default, the VBO waits 300 seconds for a processed document from ABBYY FlexiCapture.

<Steps>
  <Step title="Create a variable">
    Create a variable of type **Timespan**.
  </Step>

  <Step title="Set the wait time">
    Specify the wait time as the value of the variable.
  </Step>

  <Step title="Pass the variable to the VBO">
    Specify the name of the variable in the **DocumentProcessingTimeout** input parameter.
  </Step>
</Steps>

## Start the ABBYY FlexiCapture 12 VBO

To start the configured VBO, click **Go** on the Blue Prism toolbar.

If all the settings are correct, Blue Prism receives processing results from ABBYY FlexiCapture 12 and stores them in the output data elements you created. The format of the results depends on the scenario. For more information, see [Single-Task Package usage scenarios](/flexi-capture/connectors/blue-prism/bp-scenario).

If any configuration setting is invalid, such as an incorrect ABBYY FlexiCapture 12 address, an error message appears.
