UiPath Orchestrator Guide

Connecting Robots to Orchestrator

Important!

When deploying multiple Robots from the same machine on Orchestrator, you need to have the same Machine Name and Key on each of the Robots. To retain the values in these fields, you can click Create Another in the Add Robot window. Alternatively, you can copy the Machine Name and Key from an already deployed Robot by clicking More Actions > Duplicate. These buttons are displayed in the interface if the Robots.HighDensity.Enabled parameter is set to true.

From Orchestrator and the UiPath Robot Settings Window

By default, only the Administrator has the right to register new Robots to Orchestrator.

Provisioning the Robot to Orchestrator

  1. The person with the permission to register Robots requires the following information:
    • The name of the machine that needs 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
  2. In Orchestrator, in the Robots page, click Add Robot. The Add Robot window is displayed.
  1. In the Machine field, type the name of the machine that needs to be connected to Orchestrator.
  2. In the Name field, type any name for the Robot.
  3. 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 also specify it in a DOMAIN\username format. You must use short domain names, such as desktop\administrator and NOT desktop.local/administrator.
  4. (Optional) Add the Windows password for the specified username.
  5. Select the desired robot type from the Type drop-down list. For more information, see About Robots.
  6. (Optional) Add a description for the Robot. We recommend populating this field, especially when dealing with an environment with many robots.
  7. Copy the robot key from the Key field and send it to the person in charge of the Robot machine.
  8. Click Provision. The Robot is now displayed in the Robots page and provisioned on Orchestrator, but it is offline.

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 window is displayed.
  2. Click Options > Settings. The UiPath Robot Settings window is displayed.
  1. In the Robot 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 Robot 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 Platform). For example: cd C:\Program Files (x86)\UiPath Platform.
  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.

Using the Connection String

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

  • the Orchestrator URL
  • tenant ID
    The Robot uses these details to identify the Orchestrator instance it needs to connect to.

Important!

To use the connection string to deploy Robots to Orchestrator, 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 machine has to be in the same domain as the one specified in the WindowsAuth.Domain parameter
  • the Robot has to be installed as a Windows Service.
  1. In Orchestrator, in the Robots page, click Generate Connection String. The Connection String window containing an URL is displayed.
  2. 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.).
  3. On the Robot machine that you want to connect to Orchestrator, open the Command Prompt.
  4. Go to the directory where your UiPath Robot is installed (by default C:\Program Files (x86)\UiPath Platform). For example: cd C:\Program Files (x86)\UiPath Platform.
  5. Use the --connect and -connectionString command line arguments, and the URL generated at step 1 to connect the Robot to Orchestrator. For example, UiRobot.exe --connect -connectionString https://demo.uipath.com/api/robotsservice/GetConnectionData?tenantId=1.
  6. In Orchestrator, provision the Robot. The Robot is now deployed to Orchestrator and has the available status. If you have multiple Robots on the machine from which you generated the connection string, you must provision them all to Orchestrator.

Automatic Enrollment of Robots

  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.
  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.

Important!

For the Robot to connect as fast as it can to Orchestrator, ensure that the Is Read Committed Snapshot On configuration is set to True, in the SQL Database Properties.


Connecting Robots to Orchestrator