Orchestrator is typically licensed through either a host license or an organization-level license, by a system administrator.
However, there are certain functions in Orchestrator that require that administrators or users of Orchestrator understand and work with other types of licenses, which allow the use of various features. These are called service licenses and, of these, of particular interest is the runtime.
This page covers strictly the licensing aspects of interest to Orchestrator administrators and users for using Orchestrator.
To learn more about the various types of licenses, see:
Several permissions are available to allow a user to perform the various license-related actions described on this page:
- License - Edit or License - Create - enables you to activate or update licenses
- License - View - enables the See More buttons on the License page, which allow you to see details about the licensed Robots in their corresponding page. The View Robots button is also available on these pages if you also have the Robots - View permission.
- License - Delete - enables you to remove licenses.
A licensing process most commonly starts with activating your Orchestrator license, as explained here. If you want to manage your licenses at host level, activate your Orchestrator license and allocate them as explained here.
Afterward, all you need to do to activate a Robot license is to connect the Robot to Orchestrator.
For Studio, there are two possibilities:
- You can activate its license directly from Orchestrator. This is the recommended method.
- You can activate it locally and then connect Studio to Orchestrator through its Robot. Remember to select the Stand-alone license checkbox when creating your Robot, to prevent Orchestrator from allocating Studio a license from its pool of licenses.
There are several ways to monitor license usage from Orchestrator:
- If you want to assess whether there's room for maximizing licensing efficiency, you have the possibility to monitor historical licensing data on the Tenant > Monitoring page, by selecting License from the Section list.
- In the License page, the total number of runtimes available on all online machines is displayed. Remember that a machine consumes the licenses as soon as the Robot Service starts.
To instantly release a license, disable the machine from the corresponding License page. Please note that you cannot use Studio or the Robot on a disabled machine.
A disabled machine appears crossed out on the Robots page:
Although license management is typically performed from the administration interfaces, in Orchestrator you do work with a particular type of license: the runtime, which is a service license for robot use.
Runtimes are the licenses you need to run unattended automations. You allocate runtimes when you create a machine object in Orchestrator. There are two aspects to know when allocating runtimes:
- Number of runtimes: You can assign a custom number of runtimes to a machine object (standard machine, or machine template), which determine the number of processes that can run at the same time on a machine.
The number required runtimes is given by the number of jobs you want to allow to be executed at the same time on this machine; it is not impacted by the number of robots on the machine.
Let's say you have a machine template with 10 Production (Unattended) runtimes allocated to it. For each workstation that is connected using the machine key of that template, 10 Production (Unattended) runtimes are reserved from the available licenses at the tenant level, allowing for executing 10 jobs at the same time. From these reserved runtimes, a runtime is only in use during job execution. So if you connect 4 machines to Orchestrator using that template, you need and reserve 40 runtimes at the tenant level. With, for example, 25 jobs running, 25 out of the 40 reserved runtimes are in use, leaving 15 runtimes that are reserved, but unused.
- Types of runtimes: The types of runtimes that are assigned to a machine object determine the types of processes that can run on that machine.
Because for classic folders you can have several Robot entities on the same machine, it is important to understand that more Robots does not mean more execution capacity. For that you need more runtimes.
For example, if on a machine with 5 Robots, you assign only 3 runtimes, it means only 3 licenses are consumed. If you execute 5 jobs or schedule all the Robots on that machine, the following occurs:
- 3 jobs are executed on the first 3 licensed Robots;
- the remaining 2 unlicensed Robots are placed in a pending state;
- the first 3 Robots release their licenses;
- the remaining 2 Robots are licensed and they execute the assigned jobs, leaving one license reserved, but not in use.
If on a machine you have only one Unattended or NonProduction Robot and assign its machine 30 runtimes, then 30 licenses are consumed if that machine is online.
If a Windows 7 machine has 10 users (Robots), you can only execute one process at a time, and you have to leave the number of runtimes to its default value, 1. If you assign more than 1 runtime to a Windows workstation machine and try to execute multiple jobs at the same time, errors are thrown.
If the UiPath Robot service is running on a given machine, it is displayed as licensed. If there are no more licenses available, the machine is not licensed.
All the machines that have Robots defined as Unattended are listed in the Unattended or NonProduction page, along with the number of allocated runtimes, the number of defined and running Robots, and the machine's license status. Additionally, you can edit the number of runtimes allocated to a machine, and display a list of the Robots defined on that machine.
If a machine is online but it is not licensed, it tries to acquire a runtime with each heartbeat.
By default, you are notified 180, 90, 30, 14, 7, and 1 day before the license expiry date. You can configure these values using the
SystemJobs.LicenseExpirationAlert.DaysBefore app setting.
At host level, for single licenses distributed across multiple tenants, only the system administrator receives these email alerts. At tenant level, all the active users with License - View permission receive them. The emails are localized per user.
Following the expiration of your license, there is granted grace period during which you can renew you license without experience any disruption of operations. At log on, a notification is displayed informing you that your license is expired and the duration of the grace period:
You may close the notification by clicking OK and continue working as usual. After the end of the prescribed grace period you Orchestrator will be unlicensed and no longer operational.
Updated 23 days ago