Subscribe

UiPath Orchestrator

The UiPath Orchestrator Guide

Connecting Robots to Orchestrator

You can connect your robots to Orchestrator in different ways based on the robot authentication settings configured in Orchestrator, typically by an administrator. If you are not aware of any robot authentications settings, please ask your Orchestrator administrator to provide details so as to be able to use the right method to connect your robot.

What are my authentication settings


The robot authentication settings can be seen and configured on Tenant > Settings, on the Robot security tab, usually by an administrator. Your Orchestrator administrator should provide you with details so as to be able to use the right method to connect your robot.

More on robot authentication.
Instructions on how to change robot authentication settings.

Connecting Attended Robots to Orchestrator


Interactive Sign-In

Sign in with your credentials to connect your robot to Orchestrator. This gives the robot access to Orchestrator resources and provides the user with operational rights to products such as Studio or the Assistant.

  1. Open the Assistant.
  2. On the Preferences menu, click Orchestrator settings. The Orchestrator configuration window is displayed.
  3. On the Connection type field, select Service URL. The content of the window is adjusted according to the selection.
  4. On the Service URL field, enter the URL of the Orchestrator instance you want to connect to.
  5. Click Sign In. You are directed to the Login page of your Orchestrator instance.
  6. Log in as usual.
  7. Once your identity is confirmed, the Assistant is populated with the processes in the Orchestrator folders you have access to.
600600

📘

Note

When using interactive sing-in, there is no need to create machine objects in Orchestrator.

🚧

Important

Interactive sign-in is not supported in a classic folder context.

 

Machine Key

Use a machine key to connect attended robots. The machine key is generated in Orchestrator via machine objects.

📘

Note

  • The person handling the Orchestrator configuration in the company should provide the attended users and developers with the correct Orchestrator URL and machine key. Machine objects do not need to be assigned to Orchestrator folders, only accounts.
  • Multiple accounts working on the same machine each require a robot created in Orchestrator.

 

There are two ways to connect your robot with a machine key: using the Assistant or via the command line.

Using the Assistant

  1. Open the Assistant.
  2. On the Preferences menu, click Orchestrator settings. The Orchestrator configuration window is displayed.
  3. On the Connection type field, select Machine Key. The content of the window is adjusted according to the selection.
  4. On the Machine Name field, you can see the name of your physical machine or VM.
  5. In the Orchestrator URL field, enter Orchestrator’s URL and the AccountLogicalName and ServiceName, such as https://cloud.uipath.com/uipathtokyo/uipathkyoto/.
  6. In the Machine Key field, enter the key generated by the machine object in Orchestrator.
  7. Click Connect. The robot is now connected to Orchestrator.
601601

 

Using the Command Line

  1. Open Command Prompt.
  2. Go to the directory where your robot is installed. For example:
cd C:\Program Files\UiPath\Studio
  1. Use the --connect, -url, and -key command-line arguments.
UiRobot.exe --connect -url <orchestratorInstanceURL> -key <machineKey>

The robot is now connected to Orchestrator. In a High-Density environment, the robot corresponding to each user is connected to Orchestrator.

 

Connecting Unattended Robots to Orchestrator


In unattended automation, the host machine is connected and licensed in unattended mode so the designated way to execute processes is Orchestrator. If you want to use the machine in attended mode (opening the Assistant) when Interactive Sign-In is enforced, you need to sign in, otherwise you cannot see the processes in the Assistant, and the robot appears as "Connected, Unlicensed".

Client Credentials

Use client credentials to connect unattended robots to Orchestrator. The client ID - client secret pair is generated via machine template objects in Orchestrator.

There are two ways to connect your robot with client credentials: using the Assistant or the command line.

Using the Assistant

  1. Open the Assistant.
  2. On the Preferences menu, click Orchestrator settings. The Orchestrator configuration window is displayed.
  3. On the Connection type field, select Client ID. The content of the window is adjusted according to the selection.
  4. In the Orchestrator URL field, enter Orchestrator’s URL and the AccountLogicalName and ServiceName, such as https://cloud.uipath.com/uipathtokyo/uipathkyoto/.
  5. In the Client ID field, enter the client ID generated by the machine object in Orchestrator.
  6. In the Client Secret field, enter the client secret generated by the machine object in Orchestrator.
  7. Click Connect. The robot is now connected to Orchestrator.
601601

 

Using the Command Line

  1. Open Command Prompt.
  2. Go to the directory where your robot is installed. For example:
cd C:\Program Files\UiPath\Studio
  1. Use the --connect, --url, --clientID, and --clientSecret command-line arguments to connect your robot and pass the Orchestrator URL, client ID, and client secret. For example:
UiRobot.exe --connect --url <OrchestratorURL> --clientID <clientID> --clientSecret <clientSecret>

📘

Note

When using PowerShell, you need to escape the $ character in the client secret using "". For example, you should pass a client secret such as Bepx8O3XqSHrt$ZU as "Bepx8O3XqSHrt""$""ZU".

Machine Key

Use a machine key connect unattended robots to Orchestrator. The machine key is generated in Orchestrator via machine objects.

📘

Note

  • Machine objects need to be assigned to folders in Orchestrator.

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

There are two ways to connect your robot with a machine key: using the Assistant or by using the command line.

Using the Assistant

  1. Open the Assistant.
  2. On the Preferences menu, click Orchestrator settings. The Orchestrator configuration window is displayed.
  3. On the Connection type field, select Machine Key. The content of the window is adjusted according to the selection.
  4. On the Machine Name field, you can see the name of your physical machine or VM.
  5. In the Orchestrator URL field, enter Orchestrator’s URL and the AccountLogicalName and ServiceName, such as https://cloud.uipath.com/uipathtokyo/uipathkyoto/.
  6. In the Machine Key field, enter the key generated by the machine object in Orchestrator.
  7. Click Connect. The robot is now connected to Orchestrator.
601601

 

Using the Command Line

  1. Open Command Prompt.
  2. Go to the directory where your robot is installed (by default C:\Program Files\UiPath\Studio). For example: cd C:\Program Files\UiPath\Studio.
  3. 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. The robot is now connected to Orchestrator. In a High-Density environment, the robot corresponding to each user is connected to Orchestrator.

Update the default Orchestrator URL for Mac


To update the default Orchestrator URL service when using the Assistant on a Mac, change it from store.json (/Applications/UiPath Assistant.app/Contents/Robot/uipath.config~/Library/Application Support/UiPath/store.json):

"MAIN_WINDOW_SERVICE_LOGIN_DETAILS": {
        "nextServiceUrl": "https://cloud.uipath.com",
        "defaultServiceUrl": "https://cloud.uipath.com"
    }

Updated 3 months 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.