Skip to main content

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

Configuring the connection to UiPath Orchestrator

Updated on April 6, 2022

After you import your Pega Open Robotics application, configure the information that Pega Platform requires to authenticate requests from Orchestrator.

  1. In the navigation pane of Dev Studio, click Records.
  2. Expand the SysAdmin category, and then click Application Settings.
  3. Pega Platform automatically saves the following application settings in the Pega-Robotics:08-04-01 ruleset. To save each application setting into your application ruleset, click the application setting to open it.
    • pyUiPathOrchestratorDomain
    • pyUiPathOrchestratorAuthenticationUrl
    • pyUiPathOrchestratorTenantLogicalName
    • pyUiPathOrchestratorClientID
    • pyUiPathOrchestratorAPIUserKey
  4. Click Save as.
  5. On the Application Settings Record Configuration page, ensure that your application ruleset appears in the Add to ruleset field, and then click Create and open.
  6. On the Settings tab of each application setting, in the Value per production level section, update the values in the Value field to correspond with the values in your Orchestrator service instance. For more information, see Defining values for an application setting and your UiPath Orchestrator authentication documentation.
    • pyUiPathOrchestratorDomain - Enter the URL of your orchestrator instance, for example, https://<domainname>/<accountname>/<servicename> or https://<domainname>/<accountname>/<tenantname>.
    • pyUiPathOrchestratorAuthenticationUrl - Enter the URL that Orchestrator uses to provide the access token. For Cloud-based URLs, the URL is If you are hosting your own Orchestrator instance on a private Cloud or on-premises system, enter the authentication URL for those systems.
      Note: Pega Platform only supports token authentication for authenticating calls to UiPath.
    • pyUiPathOrchestratorTenantLogicalName - Enter the tenant logical name of your service instance in Orchestrator.
    • pyUiPathOrchestratorClientID - Enter the client ID of the service instance in Orchestrator.
    • pyUiPathOrchestratorAPIUserKey - Enter the user key of the service in Orchestrator.
    Client ID application setting
    Client ID configuration in Pega Platform
  7. Click Save.
    • Previous topic Configuring your UiPath Orchestrator instance
    • Next topic Configuring Pega Platform to receive webhook calls

    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