Subscribe

UiPath Connectors

The UiPath Connectors Guide

Connection Settings

Overview

The Connection Settings page allows you create a new connection to a UiPath Orchestrator tenant, or to edit or deleting an existing connection.

Creating an On Premise Connection

To set up a connection to an on-premise Orchestrator, follow the steps below:

  • Type the URL of your On-Premise Orchestrator.
  • Type the name of the Orchestrator Tenant (the name chosen for the Orchestrator instance)
  • Type the Username (or Email) and Password associated with an Orchestrator admin account
  • Type the name of the folder where the process resides.

🚧

Note

Be aware our Tableau App Service is running in the public cloud, so your Orchestrator needs to be accessible from the public cloud.

Creating a Cloud Connection

Use the instructions below to set up a cloud connection:

  • Type your Account Logical Name. You can also see this in the URL of the portal (e.g. if the URL is https://cloud.uipath.com/example, the account logical name is example).
  • Type your Tenant Logical Name (you can find it in the API Access page of your Cloud Platform account. Navigate to Admin > Tenants. The Tenants page lists all existing tenants. Click the arrow on the left of the desired tenant to display its available services. Click API Access for the Orchestrator service).
  • Type your Client ID and your User Key. Just like the Tenant Logical Name, these can be found in the API Access page.
  • Type the name of the folder where the process resides.

When you have completed the required properties the Test Connection button will become active. You will need to test the connection before you are allowed to save it for use.

📘

Note

You can still edit or delete a saved connection if it is not longer used. The Connection Name, however, can no longer be changed after you've set it.

After saving the connection, you can click the Next button to go to the Process / Robot Selection page if you are in the configuration wizard.

Properties

Common

  • Connection Name - The display name of the Connection. This field supports only String variables.
  • Connection Type - The type of connection. Chose one of the two available options: On-Premise or Cloud.

📘

Note

Selecting and option will cause the page to display only those additional properties necessary to configure a connection of this type.

On Premise Connection Properties

  • UiPath Orchestrator URL - The URL of your Orchestrator tenant. This field supports only String variables.
  • Orchestrator Tenant Name - The name of your Orchestrator tenant. This field supports only String variables.
  • Email or Username - Your email or username. This field supports only String variables.
  • Password - The password for the email or username specified above. This field supports only String variables.
  • Folder - The folder to use. This can be a classic or a modern folder name. This field supports only String variables. If a folder is not specified, the connection will presume the default Classic folder for this Orchestrator tenant.

Cloud Connection Properties

  • Account Logical Name - The account logical name. This field supports only String variables.
  • Tenant Logical Name - The tenant logical name. This field supports only String variables.
  • Client ID - The client id for this connection. This field supports only String variables.
  • User Key - The user key for this connection. This field supports only String variables.
  • Folder - The folder to use. This can be a classic or a modern folder name. This field supports only String variables. If a folder is not specified, the connection will presume the default Classic folder for this Orchestrator tenant.

Updated 3 months ago

Connection Settings


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.