UiPath (Action Flow)
With UiPath modules in Celonis platform, you can manage the jobs and queues in your UiPath account.
To use the UiPath modules, you must have an account. You can create an account at account.uipath.com.
Refer to the UiPath API documentation for a list of available endpoints.
Connect UiPath to Celonis platform
To establish the connection, you must:
Obtain your credentials in UiPath
To obtain your credentials from your UiPath account:
Log in to your UiPath account.
In the left navigation, click the 3 dots for more options.
Click Admin.
On the Administration page, click External Application > + Add application.
Enter the Application name.
Click + Add scopes, select Orchestrator API Access from the Resource drop down, and add the following scopes under the Application scope(s) tab:
OR.Robots.Read
OR.Queues
OR.Jobs
OR.Execution.Read
OR.Folders.Read
OR.Settings.Read
Click Save.
Enter a Redirect URL and click Add.
Copy the App ID and the App Secret and and store it in a safe place.
Click Close.
Click your profile icon at the top right, then click Preferences.
Go to the Privacy & security section.
In the Orchestrator API access table, find the record you need, and click View API access.
Copy your User key, Organization ID and Name and store it in a safe place.
You will use these values in the User key, UiPath Organisation ID, UiPath Tenant Name, Client ID, and Client Secret fields in Celonis platform.
Establish the connection with UiPath in Celonis platform
To establish the connection in Celonis platform:
Log in to your Celonis platform account, add a UiPath module to your Action Flow, and click Create a connection.
Select a Connection type:
UiPath Cloud
UiPath Cloud (client credentials)
Note: the fields you use to connect will vary depending on the Connection type you select.
Optional: In the Connection name field, enter a name for the connection.
If you selected UiPath Cloud as your Connection type, enter the User key in the UiPath User Key field.
In the UiPath Organisation ID field, enter the Organization ID copied above.
In the UiPath Tenant Name field, enter the Name copied above.
In the UiPath Client ID field, enter the App ID copied above.
If you selected UiPath (client credentials) as your Connection type, enter the App secret in the Client Secret field.
Click Save.
If prompted, authenticate your account and confirm access.
You have successfully established the connection. You can now edit your Action Flow and add more UiPath modules. If your connection requires reauthorization at any point, follow the connection renewal steps here.
Build UiPath Action Flows
After connecting the app, you can perform the following actions:
Job
Starts a UiPath job by triggering a selected process.
Connection | |
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. |
Select UiPath Robots | Select a robot to execute the process. |
Add Input Arguments | 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. |
Queue
Add items to an UiPath queue.
Connection | |
Select UiPath Folder | Select or map the folder that contains the queue for which you want to add the items. |
Select UiPath Queue | Select or map the queue to which you want to add the items. |
Add Specific Content | Enter or map the specific Key-Value pair to add the items to the queue. Refer to the UiPath documentation to learn more about queue item requests. |
Set Priority | From the Priority list, select the item's priority. |
Reference | Enter or map the reference to link your transactions to other applications used within an automation project. This reference enables you to search for certain transactions, in UiPath Orchestrator, according to the provided string. |
Other
Performs an arbitrary authorized API call.
Connection | |
URL | Enter a path relative to |
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. |