UiPath Orchestrator Guide

Field Descriptions

The Robots Page

Field
Description

Environments tab

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

Search

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

Filter

Enables you to filter the page according to the Robot type (Development, NonProduction, Attended, Unattended) and Status (Available, Busy, Unresponsive, Disconnected).
The icon changes as follows:

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

Add

Opens the Add Robot window so that you can register a Robot to Orchestrator. This button is grayed out if you do not have a license or have used up all your Robot licenses.

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.

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. This can be only Attended, Unattended, Development or NonProduction. It is possible to filter the page according to the Robot type.

Environments

The names of the environments to which the Robot is assigned to.

Heartbeat

The amount of time elapsed since the Robot last communicated with Orchestrator, through a heartbeat. Hovering over this field displays the exact date and time.

Status

The status of the Robot. The page can be filtered according to this status. This status represents the last known status the Robot communicated to Orchestrator through a heartbeat.

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:

  • Username
  • Machine
  • Type
    You cannot edit any Robot details if your license is expired.

More Actions more_actions

Displays a menu that has 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. This button is displayed if the Robots.HighDensity.Enabled parameter is set to true, in the web.config file.
  • 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 removed 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 Add Robot Window

The Description Tab

Field
Description

Key

Mandatory.
This key is automatically generated from Orchestrator for the Robot machine.
For the Robot to work, the same key must exist on both the Robot and Orchestrator. To do this, this key must be copied to the Robot Key field in the UiPath Robot Settings window.

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.

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 Fre Robots.
Note: You must use short domain names, such as desktop\administrator and NOT desktop.local/administrator.

Password

The machine’s Windows password. 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:

  • NonProduction - this is the default option.
  • Unattended
  • Attended
  • Development

Description

Optional.
Type information about your Robot. We recommend using this field when you have multiple robots, so you easily identify them.

Create Another
(only if enabled)

Optional.
When selected, the values in the Key and Machine 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 Robots on the same machine with different keys and machine names.

Provision

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

Cancel

Closes the Provision Robot window, without saving your settings.

The Runtime 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

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.**

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.

The UiPath Robot Settings Window

Field
Description

Machine Name

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

Robot Key

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

Orchestrator URL

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

Connect

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

Disconnect

Disconnect the Robot from Orchestrator.

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.