Workato Application Scope

UiPath.Workato.Activities.WorkatoScopeActivity

The Workato activities use an (User Email*) and (User Token) to establish an authenticated connection between UiPath and your Workato application. This connection authorizes a Robot to call the Workato APIs and access resources on your behalf.

You may also authenticate using an (Existing Connection) that has been established by a previous Workato Scope activity.

After establishing a connection, a parent Workato Scope activity can output a record of the connection in a Connection object (Connection) that you can use in subsequent child scope activities.

How it works

The following steps are an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

1. Complete the Setup steps.
2. Add the Workato Scope activity to your project.
3. Choose the authentication types you want to use.
4. Enter values for one of the authentication types properties.
5. Optionally create and enter a Connection variable for Output property. You can use this variable in subsequent uses of the Workato Scope activity.

In the Body of the Activity

To build your project and enable the (Object Wizard) in other activities, you must use the (Connection Wizard) by clicking the (Configure) button. The Configure Connection dialog allows you to specify both a (Design Connection) and a (Robot Connection).

Property values in the (Design Connection) section do not need to be quoted.

• ExistingConnection - A connection from the parent Application Scope to use instead of a new connection. Enter a Connection variable.
• User Email - The email address of the account. Enter a String or String variable.
• User Token - The token of the account. This is also known as your API key. Enter a SecureString or SecureString variable. This is the API key that you created in the Get API key step in Setup.

Properties

Common

• DisplayName - The display name of the activity. This field supports only Strings or String variables.

Misc

• Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Options

• ReportApiErrorAsException - When selected, API error responses are reported in BusinessActivityExecutionException by all child activities that use this application scope. When cleared, the child activity populates the API error message in the ResponseStatus output property and workflow execution continues. Check the ResponseStatus property to confirm successful execution.

Output

• Connection - The connection which can be passed to a child application scope. Enter a Connection variable.