Subscribe

UiPath Marketplace

The UiPath Marketplace Guide

Alteryx Scope

The Alteryx activities use an (Client ID*) and (Client Secret) to establish an OAuth connection between UiPath and your Alteryx application. This connection authorizes a Robot to call the Alteryx APIs and access resources on your behalf.

After establishing a connection, a parent Alteryx 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 Alteryx Scope activity to your project.
  3. Enter values for the [Input](doc:alteryx-scope#section-input] properties.
  4. Create and enter a Connection variable for Output property. You can use this variable in subsequent uses of the Alteryx Scope activity.

Properties

The values for the following properties are specified when adding this activity to your project in UiPath Studio.

Configure

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

The (Design Connection) is used for authentication only for design-time experiences, such as viewing the list of Answers in the Run Job activity. The (Robot Connection) credentials will be used when the robot runs any activity.

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

Common

DisplayName

The display name of the activity.

Attributes

Details

Type

String

Required

Yes

Default value

Alteryx Scope

Allowed values

Enter a String or String variable.

Notes

N/A


Input

Client ID

The Client ID to use for authentication.

Attributes

Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

N/A

Client Secret

The client secret for authentication.

Attributes

Details

Type

SecureString

Required

Yes

Default value

Empty

Allowed values

Enter a SecureString or SecureString variable.

Notes

N/A

Base Url

If different from default.

Attributes

Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

Use "http://localhost/gallery/api/" unless different. The URL should end with "/gallery/api/"


Output

Connection

The connection which can be passed to a child application scope.

Attributes

Details

Type

Connection

Required

No (required if you want to use the output data in subsequent activities)

Default value

Empty

Allowed values

Enter a Connection variable.

Notes

N/A


Options

Existing Connection

Use an existing Alteryx connection.

Attributes

Details

Type

Connection

Required

No

Default value

Empty

Allowed values

Enter a Connection or Connection variable.

Notes

The Connection variable must be from a previously run Alteryx Scope activity (parent) that still has an active connection.


Example

The following image shows an example of the activity dependency relationship and input/output property values.

Updated 4 months ago


Alteryx Scope


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.