Subscribe

UiPath Orchestrator

The UiPath Orchestrator Guide

Connecting Robots to Orchestrator

Overview


You can connect your Robot to Orchestrator:
A. Manually
B. Using interactive sign-in
C. Using automatic Robot enrollment

Each method requires a correct configuration of the user, robot, and machine entities in Orchestrator per your real-life setup.

If a different person takes care of the Orchestrator configuration in your company, make sure they provide you with the correct Orchestrator URL and machine key.
If you have multiple Robots for different users on the same machine, you must create a robot for each in Orchestrator.
Click here for details about robots in modern folders.
Click here for details about robots in classic folders.

Manually Connecting Robots


From Orchestrator and the Orchestrator Settings Window

Administrator rights are required to perform this procedure for Service Mode Robots.

  1. Open UiPath Assistant
  2. On the Preferences menu, select Preferences. The Preferences window is displayed.
  1. Navigate to Orchestrator Settings.
  2. In the Orchestrator URL field, enter Orchestratorโ€™s web address.
  3. In the Machine Key field, enter the key generated by the machine entity in Orchestrator.
    Click here for details about the different machine entities in Orchestrator and when to use each.
  4. Click Connect. UiPath Robot is now connected to Orchestrator. Each time a UiPath Robot is registered to Orchestrator, a Robot user with the Robot role is automatically generated in the Users page.)

๐Ÿ“˜

Note:

The High-Density Robots feature only works if the same machine name and key are used when registering each Robot per user.

From the Command Line

  1. Save the machine key generated in Orchestrator to the Clipboard or a file.
  2. Open Command Prompt.
  3. Go to the directory where your UiPath Robot is installed (by default C:\Program Files (x86)\UiPath\Studio). For example: cd C:\Program Files (x86)\UiPath\Studio.
  4. Use the --connect, -url, and -key command-line arguments in conjunction with the Orchestrator URL and machine key. For example: UiRobot.exe --connect -url https://demo.uipath.com/ -key ba1e4809-2f64-4965-bae2-efda62d20164. UiPath Robot is now connected to Orchestrator. In a High-Density environment, the Robot corresponding to each user is connected to Orchestrator.

Automatic Enrollment of Robots


The connection string is a URL that contains the following information:

  • the Orchestrator URL - identifies the Orchestrator instance UiPath Robot connects to;
  • tenant ID - identifies the tenant UiPath Robot connects to;
  • domain name - identifies the domain of the machine; this is only necessary if the machine is in a different domain than that specified for the WindowsAuth.Domain parameter (this is valid for subdomain machines as well). The domain needs to be in a two-way trust relationship with the one set for the WindowsAuth.Domain parameter.
    Click here for details about authorization parameters in UiPath.Orchestrator.dll.config.

Here are two examples of connection strings according to the machine's domain:

  • Same domain as specified in UiPath.Orchestrator.dll.config - https://demo.uipath.com/api/robotsservice/GetConnectionData?tenantId=1
  • Different domain than the one specified in UiPath.Orchestrator.dll.config - https://demo.uipath.com/api/robotsservice/GetConnectionData?tenantId=1&domainName=domain_name

๐Ÿ“˜

Important!

In order to deploy Robots to Orchestrator using connection string, the following are required:
the WindowsAuth.Enabled parameter has to be set to true
the WindowsAuth.Domain parameter has to be set to a valid domain
the Service Mode Robot has to be installed.

  1. In Orchestrator, navigate to Settings, General tab. (Tenant > Settings > General). Look for the Connection String field on the Aplication Settings sction, and click Copy. The connection string is copied to the clipboard.
  1. Send the connection string to the Robot machine you want to connect to Orchestrator (via e-mail, USB stick etc.)
  2. Use an automatic deployment tool to install the Robots and provide the connection string copied above in the CONNECTIONSTRING parameter used with the UiPathStudio.msi installer. UiPath Robot is connected to Orchestrator and is displayed as Available in the Robots page.

Updated 6 days ago


Connecting Robots to Orchestrator


Suggested Edits are limited on API Reference Pages

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