UiPath

This page explains how to configure the UiPath connectors in Bonita Studio.
UiPath is a global software company that develops a platform for robotic process automation (RPA).

RPA is a complementary technology to BPM that handles high-volume, repeatable tasks that previously required humans to perform. RPA technology consists of software robots that mimic a human. Processes can leverage RPA technology when needed to gain efficiency and focus human on added value tasks. Combining BPM and RPA allows end to end automation and avoids what is called "islands of automation" by adding the orchestration capacity of a BPM platform to the RPA approach.

All connectors share common authentication settings, and have other specific settings.

Connector versions 2.3.0 and later require Bonita Studio released after October 2025 when using the Cloud authentication.
Supported Studio versions: 2023.2-u11, 2024.1-u9, 2024.2-u7, 2024.3-u5, and 2025.1-u1 or newer.

If you are using an earlier version of Bonita Studio, please use a connector version prior to 2.3.0.

UiPath - Authentication settings

Depending on the type of your UiPath platform (On-premise / Cloud), the authentication settings are different.

On-premise authentication

Name Description Type Example

URL

UiPath Orchestrator endpoint url

string

https://demo.uipath.com/

Tenant name

Target tenant on the orchestrator

string

Default

Username or Email

string

Password

password

Cloud authentication

Details concerning UiPath cloud authentication can be found on the UiPath documentation

When using the connector version 2.3.0 or later, there are 2 authentication types: Client Credentials (OAuth) or Token (Bearer). Token is the default authenticaiton type.

Shared Inputs

These inputs are shared between both authentication types.

Name Description Type Example

Account logical name

Your unique site URL

string

bonitoyeiuiu

Tenant logical name

The selected service’s logical name

string

BonitasoftDq96g314984

Organization Unit ID (optional)

The ID of the organization unit to target

string

354849

Connector versions earlier than 2.3.0

Name Description Type Example

User key

Unique key to generate login tokens

string

pb9Mm0s5xc-upnDIr3v1Uey9ZlCjwXIE1bO9i2LN7gQpT

Client Credentials (OAuth) authentication

For more details about the OAuth authentication, please refer to the UiPath documentation.

Name Description Type Example

Client ID

Identifier of the Orchestrator application itself

string

8DEv1AMNXczW3y4U15LL3jYf62jK93n5

Client Secret (required for connector versions 2.3.0 and later)

Secret of the Orchestrator application itself

string

Ic0iKUP1504b$%c$O$WORq3xbsMM02uu6QJ3SqGc8@LK@oD5Did)R9LTKx8Y1234

Scope

Scopes required for the operation, separated by space

string

OR.Queues OR.Queues.Read OR.Queues.Write

Token (Bearer) authentication

For more details about the Token authentication, please refer to the UiPath documentation.

Name Description Type Example

Token

Personal Access Token (PAT) to access UiPath services and resources

string

UiPath - Add queue item

Add an item in a specific UiPath queue

Queue item definition

Specify information for the new queue item

Name Description Type Example

Queue name

The name of the queue into which the item will be added.

string

Reference

An optional, user-specified value for queue item identification (128 characters max).

string

Priority

Sets the processing importance for a given item.

choice

High,Normal,Low

Defer date

The earliest date and time (ISO-8601 format) at which the item is available for processing. If empty the item can be processed as soon as possible.

string

Due date

The latest date and time (ISO-8601 format) at which the item should be processed. If empty the item can be processed at any given time.

string

Specific content

Key/value pairs containing custom data (complex type will be serialized in a JSON string)

Name Description Type Example

queueContent

Key,Value

array

UiPath - Get job

Get a UiPath Job status

Connector settings

Set connection and authentication connector parameters.

Name Description Type Example

Job ID

The ID of the job to request.

string

UiPath - Start jobs

Start UiPath jobs

Job configuration

Configure job parameters.

Name Description Type Example

Process name

The UiPath process name to execute

string

Process version

If empty, current process release will be used.

string

Strategy

States which robots from the environment are being run by the process.

choice

All,Specific,JobsCount

Robot names (if Specific strategy)

list

Jobs count (if JobsCount strategy)

Number of pending jobs to be created in the environment, for the current process. This number must be greater than 0 only if the start strategy is JobsCount.

integer

Input parameters

Input parameters to be passed to job execution.

Name Description Type Example

inputArguments

Key,Value

array