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

# Install the Blue Prism connector

> Install the ABBYY Vantage Connector for Blue Prism with the installation wizard or in silent mode, then import the ABBYY Vantage Skills business object.

The ABBYY Vantage Connector for Blue Prism is a visual business object (VBO) that provides a set of actions to send documents to ABBYY Vantage, process them with an available skill, and get the results. It ships with a preconfigured sample process named **ABBYY Vantage Skills example**, which is imported together with the `.bprelease` file.

Install the connector on every machine that runs a Blue Prism process that uses it. Use the installation wizard for a single machine, or silent mode to automate installation across many machines.

<Warning>
  Installing, updating, and uninstalling the connector requires administrator privileges. The installer requires that all Blue Prism `Automate.exe` processes be stopped during installation. If any `Automate.exe` process is running, the installer displays a warning, and continuing forcibly terminates those processes.
</Warning>

## Install via the installation wizard

<Steps>
  <Step title="Upload the setup file">
    Upload the `ABBYYVantageConnectorForBluePrism<version>.exe` setup file to the machine where Blue Prism is installed.
  </Step>

  <Step title="Run the installer">
    Run `ABBYYVantageConnectorForBluePrism<version>.exe` and follow the instructions of the Installation Wizard.
  </Step>

  <Step title="Import the release into Blue Prism">
    In Blue Prism, open the **Studio** tab and click **File > Import > Release / Skill**. Select the `ABBYY Vantage Skills <version>.bprelease` file in the folder where the connector was installed, and then follow the setup instructions.

    The default location is `C:\Program Files (x86)\ABBYY Vantage Connector for Blue Prism` on 64-bit systems, or `C:\Program Files\ABBYY Vantage Connector for Blue Prism` on 32-bit systems.

    If you install the connector on many machines, you only need to import the release once, on any machine where the Blue Prism client is installed.
  </Step>

  <Step title="Confirm the import">
    After the import completes, an **ABBYY Vantage Processes** section (containing the sample process) appears in the list of processes, and an **ABBYY Vantage** section (containing the **ABBYY Vantage Skills** VBO) appears in the list of objects.

    <Frame>
      <img src="https://mintcdn.com/abbyy/fsp_01hRYkHg4Ey_/images/vantage/developer/connectors/blue-prism/studio-import-tree.png?fit=max&auto=format&n=fsp_01hRYkHg4Ey_&q=85&s=a7829b15ff339c240d02caf1c0f9a1ef" alt="Blue Prism Studio tab with the ABBYY Vantage Processes section (ABBYY Vantage Skills example) and the ABBYY Vantage object (ABBYY Vantage Skills VBO) highlighted" width="323" height="235" data-path="images/vantage/developer/connectors/blue-prism/studio-import-tree.png" />
    </Frame>
  </Step>
</Steps>

## Install in silent mode

Use silent mode to install the connector automatically on many machines.

<Steps>
  <Step title="Open a command line as administrator">
    On the machine where Blue Prism is installed, run the command line as an administrator.
  </Step>

  <Step title="Go to the setup file location">
    Navigate to the directory where the connector setup file is located.
  </Step>

  <Step title="Run the install command">
    Run the following command:

    ```text theme={null}
    ABBYYVantageConnectorForBluePrism.<version>.exe -install /q
    ```

    This command unpacks the distribution files to the default folder (`C:\Program Files (x86)\ABBYY Vantage Connector for Blue Prism` on 64-bit systems, or `C:\Program Files\ABBYY Vantage Connector for Blue Prism` on 32-bit systems) and copies the `Abbyy.Rpa.Vantage.BluePrism.dll` library into the Blue Prism installation folder. This library is required for the **ABBYY Vantage Skills** VBO.
  </Step>
</Steps>

To uninstall the connector, run the following command:

```text theme={null}
ABBYYVantageConnectorForBluePrism.<version>.exe -uninstall /q
```

## Update the connector

If you have an older version of the connector, update it to the latest version.

<Steps>
  <Step title="Run the update">
    Depending on how the connector was installed, do one of the following:

    * If the connector was installed with the [installation wizard](#install-via-the-installation-wizard), run `ABBYYVantageConnectorForBluePrism<version>.exe` of the latest version, and then click **Update**.
    * If the connector was installed in [silent mode](#install-in-silent-mode), run `ABBYYVantageConnectorForBluePrism.<version>.exe -install /q`.
  </Step>

  <Step title="Import the latest release and resolve conflicts">
    In Blue Prism, open the **Studio** tab and click **File > Import > Release / Skill**. Select the `ABBYY Vantage Skills <version>.bprelease` file where the latest version is stored, and then follow the setup instructions.

    During setup, in the **Resolve Import Conflicts** section, select these resolutions:

    * For the **ABBYY Vantage Skills example** component, select **Overwrite the existing process with the incoming process**.
    * For the **ABBYY Vantage Skills** component, select **Overwrite the existing business object with the incoming business object**.
  </Step>
</Steps>

## Replace the GetTransactionResult action with SaveTransactionResult

If you use Blue Prism version 7.2, update the connector to the latest version. Then, in each Blue Prism process that contains the **GetTransactionResult** action, replace it with the **SaveTransactionResult** action.

<Steps>
  <Step title="Open the process">
    Open a process in Blue Prism Process Studio.
  </Step>

  <Step title="Switch the action to SaveTransactionResult">
    Double-click the **GetTransactionResult** action to open its properties. In the **Action Properties** window:

    1. In the **Action** field, select the **SaveTransactionResult** action.
    2. On the **Inputs** tab, for the **outputDirectoryPath** parameter, specify the path to the folder that holds the transaction results.

    <Frame>
      <img src="https://mintcdn.com/abbyy/fsp_01hRYkHg4Ey_/images/vantage/developer/connectors/blue-prism/action-properties-save-transaction-result.png?fit=max&auto=format&n=fsp_01hRYkHg4Ey_&q=85&s=0e949444470977fb8fe06251de653204" alt="Action Properties window with the Action set to SaveTransactionResult and the outputDirectoryPath input parameter" width="624" height="406" data-path="images/vantage/developer/connectors/blue-prism/action-properties-save-transaction-result.png" />
    </Frame>
  </Step>

  <Step title="Rebuild the results collection">
    Change the structure of the file processing results:

    1. In the **Output Data Items** area, open the collection of documents obtained from the transaction.
    2. Open **Collection Properties**, and then click **Clear** to reset the parameters.
    3. Import the collection fields for the **documentProcessingResults** parameter of the **SaveTransactionResult** action: click **Import**, select **Business Object: ABBYY Vantage Skills**, select **Action: SaveTransactionResult**, and select **Parameter: documentProcessingResults (output)**.

    <Frame>
      <img src="https://mintcdn.com/abbyy/fsp_01hRYkHg4Ey_/images/vantage/developer/connectors/blue-prism/fields-import-document-processing-results.png?fit=max&auto=format&n=fsp_01hRYkHg4Ey_&q=85&s=31962ff4bc66bcd7fd2205c9bd2aa964" alt="Fields Import window importing the documentProcessingResults (output) parameter of the SaveTransactionResult action" width="1100" height="807" data-path="images/vantage/developer/connectors/blue-prism/fields-import-document-processing-results.png" />
    </Frame>
  </Step>

  <Step title="Remove the file-saving actions">
    Open the process and remove the actions that saved files from the workflow.
  </Step>
</Steps>

## Next steps

Set up and run the bundled [Blue Prism sample process](/vantage/connectors/blue-prism/sample-process).
