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

# Vantage Scope activity

> Vantage Scope activity passes ABBYY Vantage connection settings, proxy settings, and Public API Client settings to nested UiPath connector activities.

**Vantage Scope** is the container every other UiPath connector activity must live inside — Use Skill, Get Results, and Map Fields all run nested within a Scope. The Scope holds the credentials, proxy settings, and Public API Client settings that the nested activities share, so you configure connection details once per workflow.

<Warning>
  The Vantage Scope activity allows you to configure authentication using Resource Owner Password Credentials Flow and Client Credentials Flow. If you set up an External Identity Provider in Vantage, the only authentication flow that will work is the Client Credentials Flow.
</Warning>

For more information, see:

<CardGroup cols={3}>
  <Card title="External Identity Provider" icon="user-shield" href="/vantage/documentation/tenant-admin/tenant-management/external-identity-provider">
    Set up SSO via an OAuth 2.0 or SAML 2.0 identity provider for your Vantage tenant.
  </Card>

  <Card title="Public API client" icon="key" href="/vantage/documentation/tenant-admin/tenant-management/configure-client">
    Create and configure a Public API client to authenticate to the Vantage API.
  </Card>

  <Card title="Authentication" icon="shield-check" href="/vantage/developer/authentication/authentication">
    Choose an OAuth 2.0 flow and obtain an access token.
  </Card>
</CardGroup>

## Activity properties

### Connection Settings

| Property                 | Type                                  | Description                                                                                                                                                                                                                                                                                                                             |
| ------------------------ | ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Authorization grant type | `IEnumerable<AuthorizationGrantType>` | The grant type that is used for authorization: `ResourceOwnerPassword` or `ClientCredentials`.                                                                                                                                                                                                                                          |
| Password                 | `String`                              | The password used to connect to ABBYY Vantage.                                                                                                                                                                                                                                                                                          |
| Secure Password          | `SecureString`                        | The secure password used to connect to ABBYY Vantage.                                                                                                                                                                                                                                                                                   |
| Server URL               | `String`                              | The ABBYY Vantage server address.                                                                                                                                                                                                                                                                                                       |
| Tenant                   | `String`                              | The ABBYY Vantage tenant name or tenant identifier. This property is only required if the user whose credentials are used to connect to the ABBYY Vantage server is registered in several (more than one) tenants on the server. The tenant name can be found on the Vantage sign-in page in your browser when you enter your password. |
| Username                 | `String`                              | The user e-mail address used to connect to ABBYY Vantage.                                                                                                                                                                                                                                                                               |

### Proxy Settings (optional)

| Property        | Type           | Description                                              |
| --------------- | -------------- | -------------------------------------------------------- |
| Enable Proxy    | `Boolean`      | Allows you to use a proxy server to route HTTP requests. |
| Server URL      | `String`       | The proxy server address (e.g. `http://127.0.0.1:8080`). |
| Username        | `String`       | The username used to connect to the proxy server.        |
| Password        | `String`       | The password used to connect to the proxy server.        |
| Secure Password | `SecureString` | The secure password used to connect to the proxy server. |

### Public API Client Settings (optional)

| Property             | Type           | Description                                         |
| -------------------- | -------------- | --------------------------------------------------- |
| Client Id            | `String`       | Vantage application identifier.                     |
| Client Secret        | `String`       | Secure Vantage application key.                     |
| Secure Client Secret | `SecureString` | Secure Vantage application key as a secured string. |

### Manage credentials

Vantage user password, proxy password, and Client Secret in the client settings can be set in the Scope Activity either in a string parameter or in the corresponding parameter with the `SecureString` type.

A password of type `String` is stored as plain text in the XAML project file, which is not safe. A `String` password is recommended for use only when configuring the **Use Skill** and **Map Fields** activities to obtain the list of skills, or for debugging your UiPath process. Once the process is fully configured:

* If you use Resource Owner Password Credentials Flow, remove the **Password** property from the Vantage Scope activity and set up the **Secure Password** property.
* If you use Client Credentials Flow, remove the **Client Secret** property from the Vantage Scope activity and set up the **Secure Client Secret** property.

We recommend storing credentials in [UiPath Orchestrator assets](https://docs.uipath.com/orchestrator/docs/about-assets). Use the **Get Credential** activity to retrieve the password from Orchestrator and pass it to the Vantage Scope activity via a variable.

<Warning>
  The same type of password must be used for Connection Settings, Proxy Settings and for Client Settings.
</Warning>

### Configure the Vantage Public API client

When you create a client in ABBYY Vantage, configure the following in the **OAuth 2.0 Flows Settings** section of the client settings, depending on the grant type you use:

| Authorization flow                       | OAuth 2.0 client settings to enable                                                                                                                 |
| ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| Resource Owner Password Credentials Flow | **Allow Resource Owner Password Credentials Flow**                                                                                                  |
| Client Credentials Flow                  | **Allow issuing refresh tokens to refresh access tokens**, **Allow client credentials flow**, plus the required roles selected via **Manage Roles** |

<Warning>
  If you select one or more roles associated with skills via **Manage Roles**, also select the allowed skills for these roles.
</Warning>

For more information about ABBYY Vantage roles, see [Role-based access control](/vantage/documentation/tenant-admin/tenant-management/role-based-access).

### Fill in the activity fields

<Note>
  If all the properties in the Vantage Public API Client Settings are empty, the default ABBYY Vantage client is used.
</Note>

<Tabs>
  <Tab title="Resource Owner Password Credentials Flow">
    Fields to be filled for this flow:

    <Frame>
      <img src="https://mintcdn.com/abbyy/Km9nwnkPeY8_wARd/images/vantage/developer/connectors/uipath/scope-ropc.jpg?fit=max&auto=format&n=Km9nwnkPeY8_wARd&q=85&s=22e34d947174db96d438b1fa57c1cac5" alt="Vantage Scope activity fields for Resource Owner Password Credentials Flow" width="1038" height="1006" data-path="images/vantage/developer/connectors/uipath/scope-ropc.jpg" />
    </Frame>
  </Tab>

  <Tab title="Client Credentials Flow">
    Fields to be filled for this flow:

    <Frame>
      <img src="https://mintcdn.com/abbyy/Km9nwnkPeY8_wARd/images/vantage/developer/connectors/uipath/scope-cc.jpg?fit=max&auto=format&n=Km9nwnkPeY8_wARd&q=85&s=7bd045b77f4c7f3629a27e86cf32ee6b" alt="Vantage Scope activity fields for Client Credentials Flow" width="1044" height="1030" data-path="images/vantage/developer/connectors/uipath/scope-cc.jpg" />
    </Frame>
  </Tab>
</Tabs>

## Configure proxy settings

You can configure connector requests at runtime to go through a proxy server. The following proxy authentication types are supported: Basic, NTLM, IP authentication, and transparent proxy.

To use a proxy, select the **Vantage Scope** activity. In the **Proxy Settings (optional)** properties group, set the value of the **Enable Proxy** property to `"true"` and then specify the address of your proxy server in the **Server URL** property.

<Tabs>
  <Tab title="Basic authentication">
    In the **Username** and **Password / Secure Password** properties, specify the proxy connection credentials.
  </Tab>

  <Tab title="NTLM authentication">
    The **Username** and **Password** fields are optional. If the **Username** and **Password** fields are empty, the credentials of the user running the UiPath process are used.
  </Tab>
</Tabs>

## Related topics

<CardGroup cols={3}>
  <Card title="Use Skill activity" icon="play" href="/vantage/connectors/uipath/activities/use-skill">
    Create a Vantage transaction to process a document with a skill.
  </Card>

  <Card title="Get Results activity" icon="circle-down" href="/vantage/connectors/uipath/activities/get-results">
    Retrieve the processing results from ABBYY Vantage.
  </Card>

  <Card title="Map Fields activity" icon="arrow-right-arrow-left" href="/vantage/connectors/uipath/activities/map-fields">
    Save extracted field values to UiPath variables.
  </Card>
</CardGroup>
