UiPath Orchestrator

The 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

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

Machine Filter

Enables you to filter the page according to the Machine name.

Username Filter

Enables you to filter the page according to the username.

Type Filter

Enables you to filter the page according to the Robot type. The following options are available:

  • All
  • NonProduction
  • Attended
  • Unattended
  • Studio
  • StudioX

Hosting Type Filter

Enables you to filter the page according to the hosting type. The following options are available:

  • All
  • Standard
  • Floating

Environments Filter

Enables you to filter the page according to the name of the environment.

Status Filter

Enables you to filter the page according to the Robot status. The following options are available:

  • All
  • Available
  • Busy
  • Disconnected
  • Unresponsive

Reset to defaults

This button is displayed only if you made changes to any of the filters described above, and enables you to return to the default settings.

Please note that this button also resets the number of items displayed per page.

Add

add

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

  • Standard Robot - displays the Create a New Standard Robot window, which allows you to define and provision a new Standard Robot.
  • Floating Robot - displays the Create a New Floating Robot window, which allows you to define and provision 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, in the format domain\username.

Type

The type of Robot. The following options are available:

  • Attended
  • Unattended
  • Studio
  • StudioX
  • NonProduction

For Attended, Studio, and StudioX 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.

Environments

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

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.

More Actions

more_actions

Displays a menu that has the following options:

  • Edit - enables you to edit Robot information by displaying the Edit Robot window.
    You cannot edit any Robot details if your license has expired.
    When a Robot is busy (executing a process), you cannot edit the following information:

    • For a Standard Robot: Machine Name, Username, Type
    • For a Floating Robot: Username
  • 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.
  • Monitor Robot - displays the Monitoring page for the corresponding Robot.
  • Convert to Floating (only displayed for Attended, Studio, and StudioX Standard Robots) - converts an Attended/Studio/StudioX 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).

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

Type

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

  • Studio - this is the default option
  • StudioX
  • Attended
  • Unattended
  • NonProduction

Description

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

Credential Store

Mandatory - applicable only when you have more than one credential store configured.
The location where the robot credentials will be saved, either the native Orchestrator database or your external CyberArk® store(s). If you have a default Robot credential store configured, it is automatically selected here.

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

External Name

Mandatory.
Available only when using a CyberArk® credential store.
The name of the robot to be used when communicating with CyberArk®. It is automatically filled in but may be edited.

The password represents a SmartCard Pin

Optional.
Enables SmartCard authentication for the current Robot.

Stand-alone license

Optional.
Displayed only for Studio and StudioX robots. Select this check box if your Studio or StudioX is already licensed locally. It ensures that Orchestrator does not allocate a license from its pool of licenses, as your Studio/StudioX defaults to the local one.

Note: For Floating Robots in classic folders using a stand-alone license disconnects your Robot from Orchestrator. In the Robot tray the robot is displayed as Unlicensed. As soon as a local license is available, the Robot becomes licensed and is displayed as Available in Orchestrator.

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 - this is the default value.
  • 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.
By default, this is set to No.

Auto Download Processes

If enabled, available processes are automatically downloaded when the Robot agent starts.

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.

Type

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

  • Studio - this is the default option
  • StudioX
  • Attended

Description

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

Credential Store

Mandatory - applicable only when you have more than one credential store configured.
The location where the robot credentials will be saved, either the native Orchestrator database or your external CyberArk® store(s). If you have a default Robot credential store configured, it is automatically selected here.

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. Not required for Attended Robots.

External Name

Mandatory.
Available only when using a CyberArk® credential store.
The name of the robot to be used when communicating with CyberArk®. It is automatically filled in but may be edited.

The password represents a SmartCard Pin

Optional.
Enables SmartCard authentication for the current Robot.

Stand-alone license

Optional.
Displayed only for Studio and StudioX robots. Select this check box if your Studio or StudioX is already licensed locally. It ensures that Orchestrator does not allocate a license from its pool of licenses, as your Studio/StudioX defaults to the local one.

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 Login To Console is '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.**

Auto Download Processes

If enabled, available processes are automatically downloaded when the Robot agent starts.

Updated 26 days ago



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.