UiPath Orchestrator Guide

Field Descriptions

The Robots Page

Field
Description

Environments tab

Opens the Environments page that enables you to create or edit environments.

Search

search

Looks for Robots that match your input. You can search according to Robot name, machine name, and username.

Filter

filter

Enables you to filter the page according to the Robot status (Available, Busy, Unresponsive, Disconnected), Robot type (Development, NonProduction, Attended, Unattended), hosting type (Standard or Floating), machine name, and username.
The icon changes as follows:

  • filter_not_applied - a filter is not applied
  • filter_applied - a filter is applied; if you click the Filters button when it is in this state, all filters are removed.

Add

add

When clicked it expands into three options from which you can choose:

  • Standard Robot - displays the New Standard Robot window, which allows you to create a new Standard Robot.
  • Floating Robot - displays the New Floating Robot window, which allows you to create a new Floating Robot.
  • Close - collapses the three options.

The Add button is grayed out if you do not have a license, have used up all your Robot licenses, or do not have Create permissions on Robots.

Remove

remove

Deletes the selected Robot(s) from the database. Note that at least one Robot must be selected for this button to be available.

Name

The name of the Robot. It can include special characters.

Machine

The name of the machine where UiPath Robot is installed. For Floating Robots both the name of the physical machine and the name of the machine defined in Orchestrator are displayed.

Username

The username used to connect the Robot to Orchestrator. For Attended and Development Robots, the licensing status is also displayed here - a green icon marks that the Robot acquired a license, while an orange one indicates that the Robot is unlicensed. Hovering over the green icon displays the exact time and date the license was acquired.

Type

The type of Robot. Can be only Attended, Attended Floating, Unattended, Development or NonProduction.

Environments

The names of the environments the Robot is assigned to.

Status

The last known status of the Robot as communicated through the most recent heartbeat.
Hover over this field to display the date and time of the last heartbeat.

Edit

edit

Enables you to edit Robot information by displaying the Edit Robot window.
When a Robot is busy (executing a process), you cannot edit the following information:
a. For a Standard Robot:

  • Machine Name
  • Username
  • Type

b. For a Floating Robot:

  • Username

You cannot edit any Robot details if your license has expired.

More Actions

more_actions

Displays a menu with the following options:

  • View Logs - Displays the Logs page, only with logs generated by the corresponding Robot.
  • Duplicate - Enables you to duplicate the configuration (machine and key) of an already existing Robot, so that you can create a new one on the same machine.
  • Convert to Floating (only displayed for Attended Standard Robots) - Converts an Attended Standard Robot into a Floating Robot. Note that the conversion is permanent!
  • Remove - Deletes the corresponding Robot. Note that 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).

Connection String
(only if enabled)

Generates a connection string that helps you deploy Robots to Orchestrator automatically.
This button is displayed if the WindowsAuth.Enabled parameter is set to true, in the web.config file.

The Create a New Standard Robot Window

The Description Tab

Field
Description

Machine

Mandatory.
The name of the Robot machine. It is displayed in the UiPath Robot Settings window, in the Orchestrator Configuration section, in the Machine Name field.
On this window, you can either select a machine from the drop-down, or fill in a name in order to create a new one.

Name

Mandatory.
A custom name for the Robot. It must have 19 characters maximum. It can include special characters.

Domain\Username

Mandatory.
The username used to connect to the machine on which the Robot is installed. If the user is under a domain, you are required to also specify it in a DOMAIN\username format. If this is not filled in, you cannot start jobs on Unattended or NonProduction Robots.
Note: You must use short domain names, such as desktop\administrator and NOT desktop.local/administrator.

Password

The machine’s Windows password. It is not required for Attended Robots.
If this is not filled in, you can start jobs on Unattended or NonProduction Robots, but they are going to fail.

Type

Mandatory.
Choose the type of Robot to use. The available options are:

  • Development - this is the default option for Standard Robots
  • Attended
  • Unattended
  • NonProduction
    Keep in mind that this field is read-only for Floating Robots as they can only be of type Attended.

Description

Optional.
Fill in details about your Robot. We recommend you to populate this field when having multiple Robots, so you can easily identify them.

Create Another

Optional.
When selected for Standard Robots, the values in the Machine and Type fields are kept so you can create a new Robot, on the same Windows Server machine, yet under a different user (high-density Robots). This button is displayed if the Robots.HighDensity.Enabled parameter is set to true, in the web.config file.
Note: You cannot create multiple Standard Robots on the same machine with different keys and machine names.

Create

Registers the Robot to Orchestrator and saves your settings. This button is disabled until all required fields are filled in.

Cancel

Closes the Create a New Standard Robot window, without saving your settings.

The Settings Tab

It offers a way of controlling the Robot settings from Orchestrator and per process, without needing to connect to the Robot machine each time.

Field
Description

Logging Level

The level at which the Robot should log information. The following options are available:

  • Verbose
  • Trace
  • Information
  • Warning
  • Error
  • Critical
  • Off

Allow Development logging

Enables you to choose whether or not you want to receive execution or debugging logs sent from Studio during development processes.
By default, the value is Yes.

Login To Console

Enables the Robot to connect to the console session of the machine where it is installed. Additionally, it indicates if you can connect multiple Robots to Orchestrator using multiple users (High-Density Robots) or not. By default, the value is No. To enable High-Density Robots, set the value to No.
If set to No, the Unattended Robot creates an RDP session when executing a process.

Resolution Width

The machine's display resolution width. This option is set to 0 be default, which means that it automatically retrieves and uses the detected resolution width. You can use a custom value, as long as it is supported by the workstation.

Resolution Height

The machine's display resolution height. This option is set to 0 be default, which means that it automatically retrieves and uses the detected resolution height. You can use a custom value, as long as it is supported by the workstation.

Resolution Depth

The machine's display resolution depth. This option is set to 0 be default, which means that it automatically retrieves and uses the detected resolution depth. You can use a custom value, as long as it is supported by the workstation. Please note that Windows 10 does not support a Resolution Depth value other than 32.

Font Smoothing

Enhances text recognition. If is set to True, the Font Smoothing option over RDP connections is turned on. This means that the target machine has ClearType turned on.

Note:

If you want to change the Robot resolution it is recommended to use an RDP session and set the Login To Console option to No. Take into account that a new session must be created for the resolution settings to take effect, so you need to log off and then log back in again.

The New Floating Robot Window

The Description Tab

Field
Description

Name

Mandatory.
A custom name for the Robot. It must have 19 characters maximum. It can include special characters.

Domain\Username

Mandatory.
The username used to connect to the machine on which the Robot is installed. If the user is under a domain, you are required to also specify it in a DOMAIN\username format. If this is not filled in, you cannot start jobs on Unattended or NonProduction Robots.
Note: You must use short domain names, such as desktop\administrator and NOT desktop.local/administrator.

Type

You can only have Floating Robots of type Attended so this option is read-only.

Description

Optional.
Fill in details about your Robot. We recommend you to populate this field when having multiple Robots, so you can easily identify them.

Create Another

Optional
When selected for Floating Robots, the values on the Settings tab are kept so you can create a new Robot having the same runtime configuration. This button is displayed if the Robots.HighDensity.Enabled parameter is set to true, in the web.config file.

Create

Registers the Robot to Orchestrator and saves your settings. This button is disabled until all required fields are filled in.

Cancel

Closes the Create a New Floating Robot window, without saving your settings.

The Settings Tab

It offers a way of controlling the Robot settings from Orchestrator and per process, without needing to connect to the Robot machine each time.

Field
Description

Logging Level

The level at which the Robot should log information. The following options are available:

  • Verbose
  • Trace
  • Information
  • Warning
  • Error
  • Critical
  • Off

Allow Development logging

Enables you to choose whether or not you want to receive execution or debugging logs sent from Studio during development processes.
By default, the value is Yes.

Login To Console

Enables the Robot to connect to the console session of the machine where it is installed. Additionally, it indicates if you can connect multiple Robots to Orchestrator using multiple users (High-Density Robots) or not. By default, the value is No. To enable High-Density Robots, set the value to No.
If set to No, the Unattended Robot will create an RDP session when executing a process.

Resolution Width

The machine's display resolution width. This option is set to 0 be default, which means that it automatically retrieves and uses the detected resolution width. You can use a custom value, as long as it is supported by the workstation.

Resolution Height

The machine's display resolution height. This option is set to 0 be default, which means that it automatically retrieves and uses the detected resolution height. You can use a custom value, as long as it is supported by the workstation.

Resolution Depth

The machine's display resolution depth. This option is set to 0 be default, which means that it automatically retrieves and uses the detected resolution depth. You can use a custom value, as long as it is supported by the workstation. Please note that Windows 10 does not support a Resolution Depth value other than 32.

Font Smoothing

Enhances text recognition. If is set to True, the Font Smoothing option over RDP connections is turned on. This means that the target machine will have ClearType turned on.**

The UiPath Robot Settings Window

Field
Description

Machine Name

Mandatory.
The name of the machine. It is automatically populated.

Orchestrator URL

Mandatory.
Enter the URL of your Orchestrator instance, such as http://platform.uipath.com.

Machine Key

Mandatory.
The machine key generated from Orchestrator. The user that provisioned the Robot on Orchestrator should be able to send you this information.

Connect

Connects the Robot to Orchestrator, as long as the Machine Name, Machine Key and Orchestrator URL are correctly filled in.

Disconnect

Disconnect the Robot from Orchestrator.

Language

The language chosen by the user for the Robot interface. The following options are available: English, 日本語, Français, Deutsch, русский.
The default value is English. After choosing another option, you need to restart for the changes to take effect.

Level

The logging level for the robot. The following levels are available: Verbose, Trace, Information, Warning, Error, Critical, Off. By default, Information is selected.

Close

Closes the window and saves your settings.



Field Descriptions


Suggested Edits are limited on API Reference Pages

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