UiPath Orchestrator

The UiPath Orchestrator Guide

Managing Robots

classic

Enable you to connect UiPath Robot to Orchestrator:

  • using attended floating robots in conjunction with machine templates
  • using all types of standard robots in conjunction with standard machines

Creating a Standard Robot

Read here how a standard robot works.

Prerequisites

Create permissions on Robots and View permissions on Machines.
Must know the username that is used to access the machine.
Must know the password for the specified username (only required for Unattended Robots).
Must know the name of the machine on which UiPath Robot is installed. You may find it in the UiPath Robot tray, on the Orchestrator Settings window, or in Control Panel (Control Panel\System and Security\System).

  1. In the Management menu, click Robots. The Robots page is displayed. Make sure the currently active folder is a classic folder, otherwise you won't be able to access this page.
  2. Click Add. The options to add a Standard Robot or a Floating Robot are displayed.
  3. Click Standard Robot. The Create a New Standard Robot window is displayed.
  4. In the Machine field, you can either select a previously created standard machine from the displayed drop-down, or you can type its name, in which case the machine is created on the spot. The standard machine needs to have the exact same name as the machine on which UiPath Robot is installed.
  1. In the Name field, type a name for the robot.
  2. Add a description for the robot. We recommend populating this field, especially when dealing with an environment with many robots.
  3. From the Type drop-down list, select the desired license type for the robot.
    The first unattended robot created on a machine automatically assigns a runtime of that type to the machine, if that machine has none defined. Robots created afterwards have no subsequent impact on the runtime number. You can edit the runtimes number on the Machines page or on the License page.
    Click here for details about runtimes.
    Click here for details about robots.

Note:

For Studio/StudioX/StudioPro licenses, if they are already licensed locally, select the External license check box, as this ensures Orchestrator does not allocate a license from its pool of licenses.

  1. In the Credential Store field, select where the credentials for this robot are stored (only required for unttended robots). See Credential Stores for details.
  2. In the Domain\Username field, type the username that is used to log in to the specified machine using the machine_name\username syntax. 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. In the Password field, fill in the Windows Password for the username filled in in the Domain\Username field (only required for Unttended Robots). If you are using SmartCard authentication, check the The password represents a SmartCard Pin option and fill in the corresponding SmartCard PIN instead.
  4. Click Create Another if you want to create an additional robot entity for a different user on the same machine. If enabled, after clicking Create on the current window, the same window is displayed with values retained for the Machine and Type fields. You are required to only fill in the new robot name and username (and password for unattended).
  5. Navigate to the Settings tab if you want to change the default robot settings (Logging Level, Allow Development Logging, Login To Console, Resolution Width, Resolution Height, Resolution Depth, Font Smoothing, Auto Download Processes). Make the desired changes, if any. Click here for details on each setting.
  6. Click Create. The robot is now displayed on the Robots page and provisioned to Orchestrator, but it is offline. That's because the corresponding UiPath Robot installed on your machine is not connected to Orchestrator yet.
    Click here to learn how to connect UiPath Robot to Orchestrator.

Creating a Floating Robot

Read here how a floating robot works.

Prerequisites

Create permissions on Robots.
Must know the username that is used to access the machine.

  1. In the Management menu, click Robots. The Robots page is displayed. Make sure the currently active folder is a classic folder, otherwise you won't be able to access this page.
  2. Click Add. The options to add a Standard Robot or a Floating Robot are displayed.
  3. Click Floating Robot. The Create a New Floating Robot window is displayed.
  4. In the Name field, type a name for the Robot.
  5. Add a description for the Robot. We recommend populating this field, especially when dealing with an environment with many robots.
  6. From the Type drop-down list, select the desired license type for the robot. For more information, see the About Robots page.
    In classic folders you can only create floating attended robots.

Note:

For Studio/StudioX/StudioPro licenses, if they are already licensed locally, select the External license check box, as this ensures Orchestrator does not allocate a license from its pool of licenses.

  1. In the Domain\Username field, type the username that is used to log in 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.
  2. Click Create Another if you want to create an additional robot entity for a different user with the same settings as the current one. If enabled, after clicking Create on the current window, the same window is displayed on which you are required to fill in the new robot name and username (and password for unattended).
  3. Navigate to the Settings tab if you want to change the default robot settings (Logging Level, Allow Development Logging, Login To Console, Resolution Width, Resolution Height, Resolution Depth, Font Smoothing, Auto Download Processes). Make the desired changes, if any. Click here for details on each setting.
  4. Click Create. The robot is now displayed on the Robots page and provisioned to Orchestrator, but it is offline. That's because the corresponding UiPath Robot installed on your machine is not connected to Orchestrator yet.
    Click here to learn how to connect UiPath Robot to Orchestrator.

Editing a Robot

Click More Actions > Edit, make the necessary changes and click Update.

Note:

When a Robot is busy (executing a process), you cannot edit the following information:

  • Domain\Username
  • Machine
  • Type

Displaying Logs for a Robot

Click More Actions > View Logs for the respective robot.

Important!

If you edit the Robot name, the messages logged with the previous Robot name are no longer displayed.

Duplicate a Robot

Duplicate the configuration of an existing robot, so that you can create a new one for a different user on the same machine.
Click More Actions > Duplicate for the robot you want to duplicate. A new window is displayed which retains the machine and type of the duplicated robot. Fill in the robot name, new username (and password for unattended robots) and click Create.

Converting a Standard Robot into a Floating Robot

Click More Actions > Convert to Floating for the standard robot you want to convert. Only Attended, Studio, and StudioX standard robots can be converted to floating robots.

Monitoring a Robot

Click More Actions > Monitor Robot for the respective robot. Alternatively, select it from the Robots Overview widget (Monitoring > Robots > Folder Overview).

Note:

Monitoring a Robot requires your user to have View permissions on Robots and on Monitoring. Additionally, Edit on Monitoring is required in order to disable errors from the Error Feed widget on the Monitoring > Robots page. View on Environments is required in order to filter the pages by environment.

Deleting a Robot

Click the More Actions > Remove for the respective robot.

Alternatively, select one or multiple Robots from the Robots page and click Remove.

Note:

You can only delete Robots if they do not have pending or active jobs attached to them. Deleting a robot also removes it from all associations it may be part of (environments, assets, processes, schedules).

Updated 2 months ago



Managing Robots


Suggested Edits are limited on API Reference Pages

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