UiPath Marketplace

The UiPath Marketplace Guide

Welcome to UiPath Marketplace Documentation. You will find comprehensive information to help you better understand and use the automations from our platform.

In order to download the solutions described here, please visit the official UiPath Marketplace here.

Please note that only solutions built and supported by UiPath are detailed in the present guide.

Box Scope

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

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

Common

DisplayName

The display name of the activity.

Attributes
Details

Type

String

Required

Yes

Default value

Box Scope

Allowed values

Enter a String or String variable.

Notes

N/A


ContinueOnError

Specifies if you want the activity to continue running when an error is thrown.

Attributes
Details

Type

Boolean

Required

Yes

Default value

False

Allowed values

Enter a Boolean value

Notes

N/A


Input

AuthenticationType

The type of authentication that you want to use to connect to your Custom App.

Attributes
Details

Type

Drop-down list

Required

Yes

Default value

JWT

Allowed values

Select an item from the drop-down list.

Notes

There are three options:
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.


Existing Connection

Box Connection

A connection record from a parent Box Scope activity that you can use instead of establishing a new connection.

Attributes
Details

Type

BoxClient

Required

No

Default value

Empty

Allowed values

Enter a BoxClient variable.

Notes

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.


JWT Authentication

Config File Content

The content of the JSON configuration file in a String object.

Attributes
Details

Type

String

Required

Yes (if Config File Path is empty)

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

For more information about the configuration file, see the Box Setup guide.


Config File Path

The location of the downloaded configuration file.

Attributes
Details

Type

String

Required

Yes (if Config File Content is empty)

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

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.

Attributes
Details

Type

String

Required

No

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

If left empty, authentication is done for the service account.


OAuth Authentication

Client ID

ClientID of the Box application

Attributes
Details

Type

String

Required

No

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

For more information about the configuration file, see the Box Setup guide.


Client Secret

The Client Secret of the Box application

Attributes
Details

Type

SecureString

Required

No

Default value

Empty

Allowed values

Enter a SecureString or SecureString variable.

Notes

For more information about the configuration file, see the Box Setup guide.

Misc

Private

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

Attributes
Details

Type

Checkbox

Required

No

Default value

Not Selected

Allowed values

Selected or Not Selected

Notes

N/A


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.

Attributes
Details

Type

BoxClient

Required

No (recommended if you plan to have multiple Box Scope activities within your project).

Default value

Empty

Allowed values

Enter a BoxClient variable.

Notes

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