There are two ways to connect your Robot to Orchestrator:
- Manually - using the Orchestrator URL and the corresponding machine key
- Automatically - using a connection string.
Being able to connect UiPath Robot to Orchestrator, manually or automatically, requires you to first correctly configure and define user, robot, and machine entities in Orchestrator in accordance to your real-life setup.
If a distinct person takes care of the Orchestrator configuration in your company, make sure they provide you with the correct Orchestrator URL and machine key or connection string.
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.
Administrator rights are required to perform this procedure for Service Mode Robots.
- Click UiPath Assistant in the system tray to display the UiPath Assistant tray.
- On the Settings menu select Orchestrator Settings. The Orchestrator Settings window is displayed.
- In the Orchestrator URL field, enter Orchestrator’s web address.
If you are using a Cloud Platform service, add the
ServiceName, such as http://cloud.uipath.com/uipathtokyo/uipathkyoto/.
- 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.
- 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.)
The High-Density Robots feature only works if the same machine name and key are used when registering each Robot per user.
If you're looking for an overview on connecting UiPath Robot to Orchestrator using a machine key generated for the machine on which it is installed, and that machine only, watch the video below. It showcases creating a standard machine and a standard robot in Orchestrator and using them to connect UiPath Robot to a Cloud Platform service. For a fully detailed how-to and particularities, read the documentation.
- Save the machine key generated in Orchestrator to the Clipboard or a file.
- Open Command Prompt.
- 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.
- Use the
-keycommand 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.
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
web.config(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
Click here for details about authorization parameters in
Here are two examples of connection strings according to the machine's domain:
- Same domain as specified in
- Different domain than the one specified in
In order to deploy Robots to Orchestrator using connection string, the following are required:
WindowsAuth.Enabled parameter from the
web.config file has to be set to
WindowsAuth.Domain parameter has to be set to a valid domain
the Service Mode Robot has to be installed.
- In Orchestrator, navigate to the Settings page, General tab. (User menu > Settings > General). Look for the Connection String field, and click Copy. The connection string is copied to the clipboard.
- Send the connection string to the Robot machine you want to connect to Orchestrator (via e-mail, USB stick etc.)
- Use an automatic deployment tool to install the Robots and provide the connection string copied above in the
CONNECTIONSTRINGparameter used with the
UiPathStudio.msiinstaller. UiPath Robot is connected to Orchestrator and is displayed as Available in the Robots page.
Updated 5 days ago