Subscribe

UiPath Orchestrator

The UiPath Orchestrator Guide

Automation Suite robots

This feature is only available if you are using Orchestrator in Automation Suite. It is not available in standalone Orchestrator installations.

About Automation Suite robots

Automation Suite robots make it easy to run background automation without worrying about the necessary infrastructure. They provide you with complete freedom from provisioning, managing, maintaining, and scaling any underlying infrastructure. UiPath handles all the work behind the scenes so you don't have to deal with containers, virtual machines, or physical servers.

Compatibility
You can use Automation Suite robots to run background, cross-platform automation projects that are published to Orchestrator as processes.

Learn more about background and foreground processes and process compatibility.

Prerequisites


Dedicated installation node

To use Automation Suite robots in a Production environment, you need a dedicated node for Automation Suite robots. You can create this node in a new Automation Suite installation, or add it as a new node to an existing Automation Suite installation.
For evaluation installations, you do not need a dedicated node for Automation Suite robots. In this case, you can install Automation Suite robots on the shared server node used for this environment.

Hardware requirements

If you want to include Automation Suite robots in your Automation Suite installation, you must meet the hardware requirements.

📘

Package caching

If you want to enable package caching, which can improve performance, a minimum of 10GB are required in addition to the requirements mentioned above. For details on enabling package caching, see Managing products.

Enabling Automation Suite Robots

For Automation Suite robots to be available in your installation, you must either include the Automation Suite Robots service at installation time, or enable the product at a later time.

Enabling during installation

Follow the Automation Suite installation instructions and, as part of this process, make sure that you enable the Automation Suite Robots service to have this feature available in your environment.

Enabling post-installation

If you did not enable the Automation Suite Robots service during Automation Suite installation, or if you chose to disable this feature at one point, you can enable it after installation as described in Enabling or disabling Automation Suite Robots.

Licensing

At least one Unattended (Production) runtime must be available for the tenant to create the machine template.
One such license allows for one job to run at one time on Automation Suite robots. More licenses allow you to run multiple jobs at the same time on the same robot.

 

Executing unattended automations with Automation Suite robots


Step 1. Enabling unattended automation on an account

To run unattended automations with a specific account you need to first enable unattended automation on that account.
You can skip this step if you are using robot accounts since they come with unattended automation capabilities by default.

  1. Go to Tenant > Manage access. A window is displayed listing all accounts in that tenant.
  2. Click More Actions > Edit to enable unattended automation for an existing account or Assign Roles > User to reference a user account from Automation Suite.
  3. On the Robot setup tab (step 2), enable the toggle for the Unattended Robot.
14631463
  1. Click Update to update an existing account or Create to add a new one.

📘

Notes

  • The Machine login credentials and Run only one job at a time settings do not apply to Automation Suite robots.
  • The account which is used for execution and the roles assigned to the account allow for a certain level of access to resources. To ensure successful execution of the process, make sure the account has the necessary roles to perform the operations required by the processes they will execute.

Step 2. Adding Automation Suite robots to your tenant

To enable execution you need to create a machine template of the type Automation Suite Robot - a type of machine template used to add the Automation Suite robots capability to your Orchestrator tenant.

  1. Go to Tenant > Machines.
  2. In the top right, click Add Machine and select Automation Suite Robot.
    The Machine template page opens.
10011001
  1. Fill in the Name field and, optionally, fill in the Description field for the machine template.
  2. Optionally, under Tags, if you want to keep track of this machine object together with other resources, define tags.
    For detailed instructions, see Adding tags to machine objects.

📘

Details about the runtime license requirements and the runtime type to use when running jobs are shown on the right.

  1. On the right, in the Production (Unattended) field, type the number of runtimes you want to allocate to this template.
    The number of runtimes that you allocate is the umber of processes that each Automation Suite robot can run at the same time. For example, allocating 3 runtimes means that the robot can run up to 3 processes at the same time.
    The allocated runtimes are subtracted from the number of runtimes available for the tenant after you create the template. The runtimes are never released as long as the template exists, even if they are not in use.
  2. Click Provision.

On the Machines page, a success message is displayed along the top and you can see your new template in the list.

Step 3. Giving access to folder resources

In order to run unattended automations, both the account and the Automation Suite Robot machine template must have access to the process to be executed. To do this, you must add the account and machine object previously configured (steps 1 and 2) to the folder that contains the process.

13631363 13591359

Step 4. Executing unattended automations

Orchestrator allows launching unattended jobs manually from the Jobs page or automatically triggered in a pre-planned manner via triggers.

🚧

Important

Each job is limited to 1 hour. Jobs that take longer are terminated when they reach 1 hour of execution time. Optimize your automation projects or split them into multiple workflows to avoid reaching the 1 hour limit.

Manually

  1. Go to the folder that contains the processes, by selecting it in the sidebar menu.
  2. In the context of the selected folder, go to Automations > Jobs.
    The Jobs page is displayed.
  3. Click Start to start a new job.
  4. From the Runtime license drop-down, select Serverless (Unattended).
  5. Click Start.

A Command sent message is displayed and you can see the job in the list.

Automatically triggered

  1. Go to the folder that contains the processes, by choosing it from the sidebar menu.
  2. In the context of the selected folder, go to Automations > Triggers.
    The Triggers page is displayed.
  3. Click Add a new trigger to configure the mechanism for launching the jobs via triggers.
  4. Configure the necessary fields.
  5. On the Runtime license drop-down, select Serverless (Unattended).
  6. Click Add.

A Save successful message is displayed and you can see the trigger in the list. A job is launched according to your configuration. All jobs and their statuses are listed on the Jobs page.

 

Machine sizes and costs

To run processes using serverless robots, you must have:

  • the required number of Production (Unattended) runtimes available for the tenant in which the process needs to run
  • adequate hardware to support the required number of executions.

Choosing the machine size

Because each process has particular needs, you set the machine size in the configuration of a process.
For any cross-platform process, the Automation Suite Robots list is available on the Additional Settings tab when creating or editing a process. Use this list to choose the machine size you want to use for each process.

The option is available for all cross-platform processes, which are candidates for being run using serverless robots, but the option has no effect unless it is executed by a serverless robot.

Automatic machine size selection

All your cross-platform processes have the Automation Suite Robots option set to Automatic by default. This setting selects the appropriate machine size for running the process using serverless robots.
The amount of robot units consumed to run the process is based on the machine size and the number of minutes it takes to run.

When automatically choosing the size, the criteria listed in the below table are evaluated in order. As soon as one criterion is satisfied, the corresponding machine size is chosen and the remaining criteria are not evaluated.

OrderCriterionMachine size
1Remote debugging jobMedium
2Process depends on UI Automation
OR
Process depends on the UiPath Document Understanding activities
Standard
3Other unattended processSmall

 

Regenerating client secrets


When using client credentials to connect your Automation Suite robots to Orchestrator, the Automation Suite Robots machine template generates a client ID and client secret pair that authorizes the connection between that host machine and Orchestrator. If you feel that the secret key has been compromised, you can regenerate the client secret:

  1. Go to Tenant > Machines.
  2. At the right of the row for the Automation Suite Robot machine template, click More Actions and select Edit Machine.
  3. On the Edit Machine page, in the Client secrets section at the bottom, click Regenerate.

What are my authentication settings.

 

Frequently asked questions


Why can't I see Automation Suite Robot machine templates when starting a job?

The process you are trying to execute must be one that was designed as a background, cross-platform process in UiPath Studio.

Can I use Automation Suite robots to debug processes remotely from Studio?

Yes. Make sure the Automation Suite Robots machine template is added to the folder or personal workspace where the process resides.

How many jobs can I run in parallel on Automation Suite robots?

There are two limitations that impact this:

  • Each Automation Suite robot can run as many jobs concurrently as there are Unattended (Production) runtimes allocated to the template.
  • Per total, the number of Automation Suite robots that can run at the same time across your entire installation - that is, across all organizations and across all tenants - is limited by the hardware resources that you have available (CPUs, RAM, and others).

What activities and projects can Automation Suite robots run?

You can use Automation Suite robots to run all activities that are available for cross-platform projects. This includes but is not limited to:

  • Browser-based automations using the Chromium browser
  • Integration Service activities
  • API-based automations (Including HTTPS API calls that require using your own SSL certificates for authentication by downloading the certificates to the /tmp/certs filepath)
  • Database activities that require Oracle, MySql, MSSQL and PostgreSQL ODBC drivers.

Updated about a month ago


Automation Suite robots


Suggested Edits are limited on API Reference Pages

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