UiPath Robot

Field Descriptions

The Robot Tray

Field
Descriptions

Search

Find available processes.

Available Processes

Displays a list of all the available processes.

Start start_process

Starts the corresponding process.

Stop stop_process

Tries to cancel the corresponding process, and if it does not succeed, it terminates it.
This button is displayed only when a process is already running.

Update update_process

This button is displayed only when a process exists in the Orchestrator feed, or locally in the %ProgramData%\UiPath\Packages folder, but not in the %userprofile%\.nuget\packages one.
Downloads and unzips a given process to the %userprofile%\.nuget\packages folder. Only automation processes that are in this folder can be executed directly from the tray.

Refresh

Refreshes the list of available processes.

Options options_button

Opens the Options menu. It can also be accessed by right-clicking the Robot tray. The following functionalities are available:

  • Settings - opens the UiPath Robot Settings window, so that you can connect or disconnect from Orchestrator
  • Open Logs - opens a File Explorer window, at the location of the logs (by default %LOCALAPPDATA%\UiPath\Logs)
  • Help - opens the Robot Guide.
  • Quit - closes the UiPath Robot tray. Closing the Robot tray does not close the UiPath Robot service.

The UiPath Robot Settings Window

Field
Descriptions

Machine Name

The name of the machine on which the Robot is installed. It is automatically filled in. It needs to be between 1 and 15 characters. If the machine name is longer than 16 characters, then it appears truncated in the Robot Settings window. For example, if your machine name is WORKSTATIONWIN7_01 it appears as WORKSTATIONWIN7 in the Robot Settings window. The following characters are not supported:

  • Backslash \
  • Slash mark /
  • Colon :
  • Asterisk *
  • Question mark ?
  • Quotation mark "
  • Less than sign <
  • Greater than sign >
  • Vertical bar |

Please note that full stop . is a supported character, but the Machine Name cannot start with it. Some computer names are reserved by default. You can find out more about NetBIOS computer names and limitations on this page.

Orchestrator URL

The URL of your Orchestrator instance, such as https://platform.uipath.com/. The URL is saved in a drop-down menu so that next time you connect to Orchestrator you only need to select the target URL.

Machine Key

The Machine key copied from the Provision Robot window in Orchestrator. The key is saved. Next time you select the Orchestrator URL to connect to this field is automatically filled in with the corresponding key.

Connect

Enables you to connect the Robot to Orchestrator. This button is not available if the Robot is already connected to Orchestrator or if all the required fields are not filled in properly.

Disconnect

Enables you to disconnect the Robot from Orchestrator. This button is available only if the Robot is connected to Orchestrator.

Language

Enables you to change the interface language of the Robot Tray and Studio.

Robot Logging Level

The level at which the Robot should log information. The following levels are available: Verbose, Trace, Information, Warning, Error, Critical, and Off.

Status

Informs you about the Robot's connection to Orchestrator. It can have the following values:

  • Robot unavailable
  • Connected, unlicensed
  • Connected, licensed

Close

Closes the UiPath Robot Settings window.

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