Skip to main content
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.
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.
For more information about authentication and Public API clients, see:

​
Activity properties

​
Connection Settings

​
Proxy Settings (optional)

​
Public API Client Settings (optional)

​
Manage credentials

Set the Vantage user password, proxy password, and Client Secret in the Vantage Scope activity. Use either a string parameter or the corresponding SecureString parameter. A password of type String is stored as plain text in the XAML project file, which is not safe. Use a String password 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.
Store credentials in UiPath Orchestrator assets. Use the Get Credential activity to retrieve the password from Orchestrator and pass it to the Vantage Scope activity via a variable.
The same type of password must be used for Connection Settings, Proxy Settings, and Public API Client Settings.

​
Configure the Vantage Public API client

When you create a client in ABBYY Vantage, configure the OAuth 2.0 Flows Settings section for the grant type you use:
If you select one or more roles associated with skills via Manage Roles, also select the allowed skills for these roles.
For more information about ABBYY Vantage roles, see Role-based access control.

​
Fill in the activity fields

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

​
Resource Owner Password Credentials Flow

The following fields are required for this flow.
Vantage Scope activity fields for Resource Owner Password Credentials Flow

​
Client Credentials Flow

The following fields are required for this flow.
Vantage Scope activity fields for Client Credentials Flow

​
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 Enable Proxy property to true. Then specify your proxy server address in the Server URL property.

​
Basic authentication

In the Username and Password / Secure Password properties, specify the proxy connection credentials.

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