Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

UiPath integration metadata

Updated on April 5, 2022

When you import the Pega Open Robotics application, Pega Platform creates the rules for exchanging data with UiPath Orchestrator. To understand how to use the rules and processes in a case flow in Pega Platform, review the following information.


Each instance of the Connect-Robot-UiPath rule corresponds to a process in Orchestrator. You can view the rule form to understand the inputs and outputs that are expected when you run the process in your cases. This information helps you accurately configure your request and response data transforms in your case flow. For example, the input is a stock symbol, and the expected output is a stock price.
  • The ID of the rule corresponds to the release key of the process.
  • You can only update the Description and Usage sections of the rule form. To reduce user error, the rest of the fields are read-only.
  • The instances of this rule are created by a webhook call from Orchestrator. Manually creating an instance is not recommended.
Connect-Robot-UiPath rule form
The Connect-Robot-UiPath rule form that displays the inputs and


You create a record in the UiPath-Tenant-Metadata data class that includes the tenant ID and authentication secret from Orchestrator, and the operator ID in which to run the service call. With the information in the record, Orchestrator notifies Pega Platform when a process-related event or job-related event occurs in Orchestrator. For example, when you delete a process in Orchestrator, the system deletes the process in Pega Platform.

When Orchestrator makes a call to the Pega server, the server refers to the record in this data class to validate the request. Pega Platform then establishes a session with the operator specified in the record. For process-related events, Pega Platform creates the record in the ruleset of the specified operator’s default application. For job-related events, the case proceeds according to the event that occurred in Orchestrator, for example, the completion of a job.

Application settings

When you import the Pega Open Robotics application into your Pega Platform application, the system creates application settings that hold the authentication details of your Orchestrator service. The values you enter in these application settings provide Pega Platform with the information it needs to establish a connection with Orchestrator. For more information, see Configuring the connection to UiPath Orchestrator.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us