UiPath Orchestrator Guide

Connecting Robots to Orchestrator

Important!

When deploying multiple Standard Robots from the same machine on Orchestrator, you need to have the same Machine Name and Machine Key for each. To retain the values in the fields, you can click Create Another in the Add Robot window. Alternatively, you can copy the Machine Name and Machine Key from an already deployed Robot by clicking More Actions > Duplicate.

From Orchestrator and the UiPath Robot Settings Window

A Standard Robot can only work on a single standard machine, while a Floating Robot can work both on standard machines and templates, so keep this in mind when creating Robots.

Creating a Standard Robot

Prerequisites:

  • Permission to create Robots (Create permissions on Robots and View permissions on Machines)
  • The name of the standard machine which has to be connected to Orchestrator, and on which a Robot is installed (can be found in the Control Panel - Control Panel\System and Security\System or the UiPath Robot Settings)
  • The username that is used to access the specified machine
  • The password for the specified username (not required for Attended Robots)
  1. In Orchestrator, on the Robots page, click Add. The options to add a Standard Robot or a Floating Robot are displayed.
  2. Click the Standard Robot button. The Create a New Standard Robot window is displayed.
  3. Select the Standard Machine you want to register your Robot on. There are two possibilities:
    a. You had already created the machine on the Machines page beforehand. In this case, you can select it from the Machine drop-down list.
    b. You had not created the machine. In this case, simply type the name of a new one on the Machines field and click the Provision Machine button. Note that this step also adds the machine in the Machines page.
  1. In the Name field, type any name for the Robot.
  2. In the Domain\Username field, type the username that is used to login to the specified machine. If the user is in a domain, you are required to specify it in a DOMAIN\username format. You must use short domain names, such as desktop\administrator and NOT desktop.local/administrator.
  3. (Optional) Add the Windows password for the specified username.
  4. Select the desired robot type from the Type drop-down list. For more information, see the About Robots page.
  5. (Optional) Add a description for the Robot. We recommend populating this field, especially when dealing with an environment with many robots.
  6. Click Create. The Robot is now displayed on the Robots page and provisioned to Orchestrator, but it is offline.

Creating a Floating Robot

Prerequisites:

  • Permission to create Robots (Create permissions on Robots)
  • The username that is used to access the specified machine
  1. In Orchestrator, on the Robots page, click Add. The options to add a Standard Robot or a Floating Robot are displayed.
  2. Click Floating Robot. The Create a New Floating Robot window is displayed.
  3. In the Name field, type any name for the Robot.
  4. In the Domain\Username field, type the AD username that is used to login to the specified machine.
  5. (Optional) Add a description for the Robot. We recommend populating this field, especially when dealing with an environment with many robots.
  6. Click Create. The Robot is now displayed in the Robots page and provisioned to Orchestrator, but it is offline.

Note that the Type field is read-only. This is because Floating Robots can only be Attended.

Connecting the Robot to Orchestrator

Important!

Administrator rights are required to perform this procedure.

On the Robot machine, do the following:

  1. In the system tray, click the UiPath Robot icon. The UiPath Robot tray is displayed.
  2. Click the Options button and then select Settings. The UiPath Robot Settings window is displayed.
  1. In the Machine Key field, enter the key received from the user who provisioned the Robot on Orchestrator.
  2. In the Orchestrator URL field, enter Orchestrator’s address, such as http://platform.uipath.com.
  3. Click OK. The Robot is now deployed to Orchestrator and has the available status. Each time a Robot is registered to Orchestrator, a Robot user is automatically created and is assigned the Robot role. (You can view it 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. Provision a Robot to Orchestrator, as explained above. If you have multiple Robots on the same machine, you must provision them all to Orchestrator.
  2. Save the Machine key to the Clipboard or a file, as you need it to deploy the Robot to Orchestrator.
  3. Open the Command Prompt.
  4. 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.
  5. Use the --connect, -url and -key command line arguments, and the Orchestrator URL and the Machine Key to deploy the Robot to Orchestrator. For example: UiRobot.exe --connect -url https://demo.uipath.com/ -key ba1e4809-2f64-4965-bae2-efda62d20164. The Robot is now deployed to Orchestrator and has the available status. If you have a High-Density environment, the Robots corresponding to each user are now 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 the Robot connects to;
  • tenant ID - identifies the tenant the 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 in web.config (this is valid for subdomain machines as well).

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

  • Same domain as specified in web.config - https://demo.uipath.com/api/robotsservice/GetConnectionData?tenantId=1
  • Different domain than the one specified in web.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 from the web.config file has to be set to true
  • the WindowsAuth.Domain parameter has to be set to a valid domain
  • the Robot has to be installed as a Windows Service.
  1. In Orchestrator, provision your Robots as explained here.
  2. In the Robots page, click Generate Connection String. The Connection String window containing an URL is displayed.
  3. Copy the generated connection string to the Clipboard and send it to the Robot machine you want to connect to Orchestrator (via e-mail, USB stick etc.)
  4. Use an automatic deployment tool to install the Robots and provide the connection string copied at step 3 as a parameter. The Robot is connected to Orchestrator and is displayed as Available in the Robots page.