Subscribe

UiPath Orchestrator

The UiPath Orchestrator Guide

Field Descriptions

The Machines Page

FieldDescription
SearchLooks for Machines that match your input. You can search according to the machine name and description.
Type FilterEnables you to filter the page according to the machine type. The following options are available:
All
Standard
Template
Reset to defaultsThis 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.
DescriptionThe custom description of the machine. It can include special characters.
Type The type of machine. Can only be standard or template.
Installed VersionDisplays the versions for the Robots provisioned on a Machine. This column is populated according to various scenarios that may arise. They are detailed here.
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 the name and version of each Robots connected to the respective machine.
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

FieldDescription
NameThe 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.
DescriptionA custom description for your machine. It cannot be longer than 500 characters.
CancelCloses the window without saving your settings.
ProvisionCreates the standard machine and displays it in the Machines page with the provided name.

The Provision a Machine Template Window

FieldDescription
Template NameThe name of the new Machine Template. It cannot be longer than 50 characters.
DescriptionA custom description for your machine template. It cannot be longer than 500 characters.
CancelCloses the window without saving your settings.
ProvisionCreates the machine template and displays it in the Machines page with the provided name.

The Edit Machine Template Window

FieldDescription
Machine KeyThis 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 NameThe name of the machine template. It can be changed and it is not relevant when creating a Robot.
DescriptionThe description of the machine template. It can be changed.
Cancel Closes the Edit Machine Template window, without saving your changes.
UpdateSaves your changes and closes the Edit Machine Template window.

The Edit Machine Window

FieldDescription
Machine KeyThis 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.
NameThe name of the Standard Machine. It cannot be changed. Relevant when creating a Robot.
DescriptionThe description of the machine. It can be changed.
CloseCloses the window and saves your settings.

The Orchestrator Settings Window

FieldDescription
Machine Name Mandatory.
The name of the machine. It is automatically populated. It is not relevant for Floating Robots and Machine Templates.
Orchestrator URL Mandatory.
Enter the URL of your Orchestrator instance, such as http://platform.uipath.com.
Machine KeyMandatory.
The key generated from Orchestrator. The user that provisioned the Robot on a certain machine in Orchestrator should be able to send you this information.
ConnectConnects the Robot to Orchestrator, as long as the Machine Name, Robot Key, and Orchestrator URL are correctly filled in.
LanguageThe 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.
LevelThe logging level for the robot. The following levels are available: Verbose, Trace, Information, Warning, Error, Critical, Off. By default, Information is selected.
CloseCloses the window and saves your settings.

Updated 2 years 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.