UiPath Orchestrator

The UiPath Orchestrator Guide

Managing Robots

In modern folders, there is no robot management per se, as robots are created automatically. You are, however, required to make some settings in order to control the licensing, execution and authentication aspects of the robot to be created. Find below the steps to be followed such that you have a functional setup which allows you to execute jobs in modern folders.

Attended Setup

  1. Create a machine template or a standard machine.
    Management Menu > Machines
    See here how to create a machine.
  2. Connect UiPath Robot to Orchestrator using the key generated by the machine entity.
    UiPath Robot Tray > Orchestrator Settings
    See here how to connect UiPath Robot to Orchestrator.
  3. Configure the user entity: set its role at tenant level, enable automatic robot creation, select the license type, select the Stand-alone check box if your Studio/StudioX/StudioPro is locally licensed such that Orchestrator doesn't allocate a license from its licenses pool, set the username used to log on to the machine on which UiPath Robot is installed, configure the execution settings of UiPath Robot.
    Management Menu > Users
    See here how to manage users.
  4. Assign the user to one or multiple folders while choosing the appropriate roles at folder level.
    This gives access to that folder and makes the processes deployed there available and ready to get executed.
    Management Menu > Folders
    See here how to assign users to a folder.
  5. Start a job.
    UiPath Robot Tray.

In attended mode, the UiPath Robot tray shows the processes across all the folders the user is assigned to.
These processes cannot be started or triggered in unattended mode from Orchestrator.

Unattended Setup

  1. Connect your machines to Orchestrator using the key generated by a machine template.
    Assign the necessary runtimes to the template. Each workstation connected to Orchestrator using the machine template has that number available runtimes. Say I assigned 2 unattended and 1 nonproduction runtime to a machine template. I want to use the key generated by this template to connect three workstations to Orchestrator. This means I have to purchase 6 unattended and 3 nonproduction runtimes for my tenant, such that my workstations are fully licensed.
    Management Menu > Machines > Machine Template
    See here how to create a machine template.
  2. Connect UiPath Robot to Orchestrator using the key generated by the machine template.
    UiPath Robot Tray > Orchestrator Settings
    See here how to connect UiPath Robot to Orchestrator.
  3. Configure the user entity: set its role at tenant level, enable automatic robot creation, set the username and password used to log on to the machine such that the Robot is able to authenticate, select the credential store, and configure the execution settings of the Robot.
    Management Menu > Users
    See here how to manage users.
  4. Assign the user and machine template to one or multiple folders, while choosing roles for the user at folder lever.
    This gives access to that folder and makes the processes deployed there available and ready to get executed.
    Management Menu > Folders
    See here how to assign users and machine templates to a folder.
  5. Start a job, configuring its priority and runtime type. You can specify the user under which it gets executed or you can leave it undefined.
    Unattended jobs are dynamically executed by automatically pairing the users and machines in your environment. If the user is specified, only the machine is dynamically allocated. If no user is specified, both are dynamically paired to each other. The latter is the optimal job execution mechanism, as it optimizes resource consumption.
    Monitoring Menu > Jobs
    UiPath Robot Tray (for unattended robots used in attended mode)
    See here how to start a job.

In unattended mode, the UiPath Robot tray shows the processes across all folders to which both the user and machine template have been assigned. These processes can be started or triggered in unattended mode from Orchestrator.
A user using an unattended robot in attended mode (the user logs on to the machine) does not have access to the processes in folders to which the user alone is assigned. Their access is restricted to processes found in folders to which both themselves and the machine template are assigned.

โ—๏ธ

Dynamic Allocation Usage Convention

On a host machine you need to provision a Windows user for each user that belongs to the folders to which the corresponding machine template is assigned to.
Say you connected a server to Orchestrator using the key generated by machine template, FinanceT. That machine template is assigned to folders FinanceExecution and FinanceHR, where 6 users are assigned as well. Those 6 users need to be provisioned as Windows users on the server.

Attended & Unattended Setup

You can create both an attended and an unattended robot for the same user, using the steps above.

Studio Workflows & Orchestrator Debugging

To build workflows in Studio/StudioX/StudioPro while debugging in Orchestrator you need both an attended and an unattended robot created for a user. Filling in the domain\username field on either of the Attended Robot or Unattended Robot sections, automatically fills it in the other section as well.

A Studio/StudioX/StudioPro license is required to provision UiPath Robot for that specific user in Orchestrator. This enables the user to build workflows and start jobs from the UiPath Robot tray.
Processes across all the folders the user belongs to can be executed in attended mode from the UiPath Robot tray.

A NonProduction runtime needs to be assigned to the machine template whose key is used to connect UiPath Robot to Orchestrator. This allocates the runtime to that machine from the pool of licenses available at tenant level and enables the user to start jobs from Orchestrator. The allocated runtime is consumed when starting the job.
Only processes from folders in which both the user and the machine template are assigned to can be executed in unattended mode from Orchestrator.

Perform the steps above to have both robots created automatically. If, for any reason, you encounter problems in debugging a workflow using Orchestrator, make sure the following:
You assigned runtimes to the machine template used to connect UiPath Robot to Orchestrator.
You assigned both the user and the machine to the folder which contains the processes to be executed.

Updated 5 months ago


Managing Robots


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.