UiPath Orchestrator

The UiPath Orchestrator Guide

Field Descriptions

The Machines Page

Field
Description

Columns

visible_columns

Enables you to toggle column visibility. By default, all columns are displayed. Clear or select the check boxes corresponding to the columns you want to stay hidden or visible, respectively.

Click Reset in the Visible Columns drop-down to return to the default configuration with all columns enabled and visible.

Search

Looks for Machines that match your input. You can search according to the machine name and description.

Type Filter

Enables you to filter the page according to the machine type. The following options are available:
All
Standard
Template

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

Displays two options to choose from: Standard Machine and Machine Template.

Remove

remove

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

Name

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

Description

The custom description of the machine. It can include special characters.

Type

The type of machine. Can only be standard or template.

Installed Version

Displays the versions for the Robots provisioned on a Machine. This column is populated according to various scenarios that may arise. They are detailed here.

Copy Machine Key to Clipboard

copy_machine_key

When clicked, copies the machine key of the corresponding machine to your clipboard.

More Actions

more_actions_icon

Displays a menu that has the following options:
View - Enables you to view machine information by displaying the View Machine window.
Edit - Enables you to edit machine information by displaying the Edit Machine window.
Only displayed for machine templates, if you have Edit permissions on Machines, and you can only edit their names.

View Logs - displays the Logs page, only with logs generated by the corresponding machine.
View Installed Versions - displays the Robot Versions window which shows details about the Robot versions on each host machine connected to Orchestrator using the key generated by that machine entity.
For machines with Robots installed in User Mode, the Service Username column is populated with the domain\username of the users associated to each Robot.
View Robots - displays the Robot page filtered by the machine name you initially selected on the Machines page. For more information on this matter, click here.
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).

The Provision a Standard Machine Window

Field
Description

Name

The name of the machine as found in the UiPath Robot tray, on the Orchestrator Settings window, or in Control Panel - Control Panel\System and Security\System. It cannot be longer than 50 characters.

Description

A custom description for your machine. It cannot be longer than 500 characters.

License - Unattended Runtimes

The number of unattended runtimes assigned to the machine.

License - NonProduction Runtimes

The number of nonproduction runtimes assigned to the machine.

License - Testing Runtimes

The number of testing runtimes assigned to the machine.

Cancel

Closes the window without saving your settings.

Provision

Creates the standard machine and displays it in the Machines page with the provided name.

The Provision a Machine Template Window

Field
Description

Template Name

The name of the new Machine Template. It cannot be longer than 50 characters.

Description

A custom description for your machine template. It cannot be longer than 500 characters.

License - Unattended Runtimes

The number of unattended runtimes assigned to the machine.

License - NonProduction Runtimes

The number of nonproduction runtimes assigned to the machine.

License - Testing Runtimes

The number of testing runtimes assigned to the machine.

Cancel

Closes the window without saving your settings.

Provision

Creates the machine template and displays it in the Machines page with the provided name.

The Edit Machine Template Window

Field
Description

Machine Key

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 Machine Key field in the UiPath Robot Settings window.

Template Name

The name of the machine template. It can be changed as its key can be used to connect UiPath Robot to any workstation, regardless of the name.

License - Unattended Runtimes

The number of unattended runtimes assigned to the machine.

License - NonProduction Runtimes

The number of nonproduction runtimes assigned to the machine.

License - Testing Runtimes

The number of testing runtimes assigned to the machine.

Description

The description of the machine template. It can be changed.

Cancel

Closes the Edit Machine Template window, without saving your changes.

Update

Saves your changes and closes the Edit Machine Template window.

The Edit Machine Window

Field
Description

Machine Key

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 Machine Key field in the UiPath Robot Settings window.

Name

The name of the Standard Machine. It cannot be changed. Relevant when creating a Robot.

Description

The description of the machine. It can be changed.

License - Unattended Runtimes

The number of unattended runtimes assigned to the machine.

License - NonProduction Runtimes

The number of nonproduction runtimes assigned to the machine.

License - Testing Runtimes

The number of testing runtimes assigned to the machine.

Close

Closes the window and saves your settings.

The Orchestrator Settings Window

Enables you to connect UiPath Robot to Orchestrator. The window is found in the UiPath Robot tray, not in Orchestrator.

Field
Description

Machine Name

The name of the machine. It is automatically populated with the name of the workstation on which UiPath Robot is installed. It is not relevant for machine templates, as the key generated by them can be use to connect UiPath Robot to any workstation, regardless of its name.

Orchestrator URL

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

Machine Key

The key generated in Orchestrator. The user that provisioned UiPath Robot on a certain machine in Orchestrator should be able to send you this information.

Connect

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

Language

The language of the user interface for the Robot.
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.

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