Subscribe

UiPath Robot

The UiPath Robot Guide

Using the Connection String

📘

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 Service Mode Robot.

Click here for details about authorization parameters in web.config.

  1. In Orchestrator, in the Settings page, in the General tab, 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.).
  2. On the Robot machine that you want to connect to Orchestrator, open the 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 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://platform.uipath.com/api/robotsservice/GetConnectionData?tenantId=1.
  5. In Orchestrator, create 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.

It is also possible to automatically connect the Robot to Orchestrator during installation via command line parameters.

Automatic Enrollment of Robots

  1. In Orchestrator, create your Robots as explained here.
  2. In the Settings page, in the General tab, copy the generated connection string to the Clipboard.
  3. Use an automatic deployment tool to install the Robots and provide the connection string copied at step 2 as a parameter. The Robots are connected to Orchestrator and are displayed as Available in the Robots page.

📘

Note:

The connection string does not work in combination with Machine Templates.

Updated about a year ago



Using the Connection String


Suggested Edits are limited on API Reference Pages

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