Subscribe

UiPath Activities

The UiPath Activities Guide

Box Scope

UiPath.Box.Activities.BoxScope

The Box activities use the JWT authentication to establish a connection between UiPath and your Box Custom App. This connection authorizes a Robot to call the Box APIs and access resources on your behalf.

To enable authentication, you can create a Box Custom App with JWT authentication. After creating your application, Box generates a configuration file that contains the information necessary to establish an authenticated connection. You can also choose to create a Box Custom App with OAuth authentication. For more information and before you build your first automation project, see the Setup guide.

After creating your Custom App, you select the type of authentication that you want to use (Authentication Type) and enter the location of your configuration file (Config File Path) or the contents of the file (Config File Content) into the Box Scope activity if you are using JWT authentication or enter the (Client ID) and (Client Secret) if you are using OAuth Authentication.

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

How it works

The following steps and message sequence diagram is 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 Box Scope activity to your project.
  3. Enter values for the [Input](doc:box-scope#section-input] and JWT Authentication properties (if using JWT).
  4. Create and enter a BoxClient variable for Output property.
    • You can use this variable in subsequent uses of the Box Scope activity.

Properties

Common

  • ContinueOnError - Specifies if you want the activity to continue running when an error is thrown. This field supports only Boolean values.
  • DisplayName - The display name of the activity. This field supports only Strings or String variables.

Existing Connection

  • Box Connection - A connection record from a parent Box Scope activity that you can use instead of establishing a new connection. This field supports only BoxClient variables.
    • The BoxClient variable must be from a previously run Box Scope activity (parent) that still has an active connection.
    • If you're unable to establish a connection using this property, try re-running your parent Box Scope activity.

Input

  • AuthenticationType - The type of authentication that you want to use to connect to your Custom App. Select one of the three items from the drop-down list:
    • JWT - To specify JWT Authentication. Required for the first run of the Box Scope activity (i.e., parent scope).
    • OAuth - To specify OAuth authentication. Required for the first run of the Box Scope activity (i.e., parent scope).
    • BoxConnection - Optional for subsequent runs of the Box Scope activity within the same automation project that includes a parent scope.

JWT Authentication

  • Config File Content - The content of the JSON configuration file in a String object. This field supports only Strings or String variables. For more information about the configuration file, see the Box Setup guide.
  • Config File Path - The location of the downloaded configuration file. This field supports only Strings or String variables. For more information about the configuration file, see the Box Setup guide.
  • User ID - The ID of the user account that you want to use for authentication. This field supports only Strings or String variables. If left empty, authentication is done for the service account.

Misc

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

OAuth 2 Authentication

  • Client ID - ClientID of the Box application. This field supports only Strings or String variables. For more information about the configuration file, see the Box Setup guide.
  • Client Secret - The Client Secret of the Box application. Enter a SecureString or SecureString variable. For more information about the configuration file, see the Box Setup guide.

Output

  • Box Connection - A record of your established connection that you can use in other Box Scope activities that are included in this scope activity. This field supports only BoxClient variables.

📘

Note

You can pass this variable to a scope activity in a workflow that is invoked from within the parent scope activity.
For example, you may have 3 workflows. The first includes the parent scope activity that establishes the connection to your registered application (i.e., parent workflow). The second workflow creates a new contact record and the third creates a new account record; both are included in the parent scope activity.
When the workflows run, the parent scope activity passes the BoxClient variable to the existing connection BoxConnection property in the second and third workflows (see image below).

Updated 5 months ago


Box Scope


Suggested Edits are limited on API Reference Pages

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