Skip to main content

Celonis Product Documentation

UiPath

Note

UiPath is part of a limited availability release for the time being. If you find that the UiPath app is not active in your environment, please open a Support ticket.

Introduction

UiPath is a Robotic Process Automation (RPA) system. Users create software robots (bots) that interact with systems and applications to automate users’ day-to-day tasks on the desktop, such as copying and pasting data, making calculations, and moving files.

By combining RPA with Action Flows, you can:

  • leverage your existing bots and take targeted action by intelligently triggering them based on insights from EMS.

  • automate your entire landscape by combining API-led automation and UI-led automation in one Action Flow.

Pre-requisites

To use UiPath with , you need to:

  • have access to UiPath Orchestrator to create and configure UiPath processes and robots.

Functionality

By using the UiPath app in Action Flows, users can:

In UiPath, items are key-value pairs of specific content.

This page explains how to:

  • set up a connection to UiPath (cloud).

  • configure and start a UiPath job.

  • add items to a UiPath queue.

Connect UiPath to Execution Management System

Depending on the type of UiPath installation, you can connect UiPath to action flows using the following connection types:

  • UiPath On-premise (beta)

  • Uipath Cloud

Note

Integration with an on-premise installation of UiPath is in the Beta version and is out of the scope of this documentation. The connection to an on-premise version is only possible when white-listing the Celonis IP address.

To connect to the UiPath Cloud version, you need to obtain the Client ID, User Key, Tenant Name, and Organization ID from your UiPath account and insert it in the Create a connection dialog in the Execution Management System module.

To connect to a UiPath Cloud version:

  1. Log in to your UiPath Orchestrator account.

  2. Click Account Preferences > Privacy and Security > View API Access.

    cUXF81D0B4.png
  3. Copy the details of User Key, Organization ID, Tenant Name, and Client ID to a safe place and click OK.

    msedge_LPtKJzX19m.png
  4. Go to Execution Management System and open the UiPath module's Create a connection dialog and select the Connection type to UiPath Cloud.

    msedge_os095Z6ju8.gif
  5. In the Connection name field, enter a name for the connection.

  6. In the UiPath User Key, UiPath Organization ID, UiPath Tenant Name, and UiPath Client ID fields, enter the values copied in step 3 and click Create.

    uipath.png

The connection is established and you can now create Action Flows .

Job

A Job is the trigger event of a process. Each job is an instance of a robot running the process.

To start a UiPath job in action flows, you need to select the process, and a robot to execute the selected process.

Start a Job

Starts a UiPath job by triggering a selected process.

Connection

Establish a connection to your UiPath account.

Select UiPath Folder

Select or map the UiPath folder that contains the process you want to execute.

Select UiPath Process

Select the UiPath process to start the job. You must create a process in your UiPath account.

Select UiPath Robots

Select a robot to execute the process. You can select multiple robots. You must configure robots in your UiPath account.

Add Input Arguments (Optional)

If there are any input variables configured for the process in your UiPath account, they would be shown in the app when you select the process.

You can either enter the data manually or use the output values from the previous apps.

_2022-07-21_上午9_47_03.png
Queue

In UiPath, a queue is a container of data held so other bots or applications can use it. Users create queues in their UiPath account.

From the Action Flows, we allow the users to fill in these queues with the data (key/value pair) to be picked up by the jobs or other applications.

Add an Item to a Queue

Adds an item to a queue.

Connection

Establish a connection to your UiPath account.

Select UiPath Folder

Select or map the folder that contains the queue for which you want to add the items.

msedge_yi6lr1EhCE.png

Select UiPath Queue

Select or map the queue to which you want to add the items.

The Map function allows a user to map a value from one of the previous modules instead of selecting a queue from the dropdown list.

_2022-07-21_下午12_55_05.png

Add Specific Content

Enter or map the specific Key-Value pair to add the items to the queue. For more information about the queue items, see queue item requests.

_2022-07-21_下午12_53_08.png

Set Priority (Advanced Settings)

From the Priority list, select the item's priority.

The items are arranged in the queue for processing based on the priority set.

  • High

  • Normal

  • Low

Reference (Advanced Settings)

Enter or map the reference to link your transactions to other applications used within an automation project. Additionally, this reference enables you to search for certain transactions, in UiPath Orchestrator, according to the provided string.

Other
Make an API Call

Performs an arbitrary authorized API call.

Connection

Establish a connection to your UiPath account.

URL

Enter a path relative to https://cloud.uipath.com/celonisee/DefaultTenant. For example, /odata/QueueDefinitions

For the list of available endpoints, refer to the UiPath API Documentation.

Method

Select the HTTP method you want to use:

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

Example of Use - Get Folders

The following API call returns all the folders from your UiPath account:

URL

/odata/QueueDefinitions

Method

GET

msedge_xYzBRljaqw.png

Matches of the search can be found in the module's Output under Bundle > Body > value.

In our example, 1 folder is returned:

msedge_u7xX0c9Z8M.png