orchestrator

2021.10

false

OUT OF SUPPORT

Orchestrator User Guide

DELIVERY:

Automation Cloud Automation Cloud Public Sector Automation Suite Standalone

Last updated Nov 11, 2024

Assigning Roles

The Assign roles tab of the Manage access page lets you search for users and groups that already exist at the organization level and configure permissions for them in Orchestrator.

Note: Group configuration (roles, web login, robot settings) is passed on to any user that belongs to that group and is later added or auto-provisioned.

To assign roles

Go to Tenant > Manage access.
Click Assign roles, and select User,Robot account, or Group.

The Assign roles window opens.
Follow the applicable instructions:

Assigning Roles to a Group

If you assign roles to a group, those roles are inherited by all users who are part of that group.

Note: Groups are created and maintained by organization administrators from the Admin > Accounts and Groups page in Automation Cloud.

1) General Details

In the Select a group field, type to search for an existing user group to which you want to assign roles.

If needed, you can create a new group by clicking Add new to the right of the field, but you must be an organization administrator in Automation Cloud to create or edit groups.
Click the Roles field and then select the check box for each role you want to assign to the selected group.

If needed, you can define a new role by clicking New role to the right of the field.

If classic folders are inactive for your tenant, you can only assign Tenant roles and Mixed roles. If you want to also assign Folder roles to this group, you must do so from the Folders page or from the folder's Settings page.
Under Web Access, click the toggle to select if the group members can log in to the Orchestrator UI.

Important: If this setting is enabled in at least one of the groups to which an account belongs (including the Everyone group), then setting it to disabled at the account level or for other groups has no effect for that particular account, only for other group members that are not in the same situation.
Under UI Profile, select the user interface profile for the members of this group.
If you want to also create an attended robot for group members, click Next.

Otherwise, click Skip and assign to apply your settings. Skip the rest of the instructions in this section.

2) Robot Setup

Under Attended Robot, set the first toggle to Enabled if you want to automatically create an attended robot for each group member.

Note: For groups, the default robot settings apply. If you want to customize robot settings, you have to make the adjustments explicitly for each user after you finish this process.

Note: Make sure that you also assign an attended user license - either at the group level, or to individual accounts - so that they can use the attended robot.
Click the second toggle Automatically create Personal Workspaces for members of this group to set it to off (left position) if you do not want each user to have a Personal Workspace.
Click Assign.

The group is now visible on the Assign roles tab of the Manage access page and the members of the group benefit from the changes as soon as they log in or within the hour if they are already logged in.

Assigning Roles to an Account

We recommend that you maintain access by assigning roles to groups and then assigning accounts to the right groups to grant them the roles they need.

However, if you need to perform a one-time role assignment for a specific account, you can assign roles directly to the account, as described below.

Go to Tenant > Manage Access > Assign roles tab.
In the top right of the tab, click Assign roles and select User.

1) General Details

In the Search for a user field, type to search for the user account to which you want to assign roles.

If needed, you can add a new account to your organization by clicking Manage Accounts to the right of the field. You must be an organization administrator in Automation Cloud to be able to add accounts.
Click the Roles field and then select the checkbox for each role you want to assign to the selected user.

If needed, you can define a new role by clicking New role to the right of the field.

If classic folders are inactive for your tenant, you can only assign Tenant roles and Mixed roles. If you want to also assign Folder roles to this user, you must do so from the Folders page or from the folder's Settings page.
Under Allow Orchestrator UI Access, click the toggle to select if the account can log in to Orchestrator and use the web interface.

Note: If this account is a member of any groups that have Web Access set to enabled, changing this setting for individual accounts has no effect because the group-level setting is inherited by all accounts. To control web access for individual accounts, you must either remove the account from groups with a conflicting setting, or remove the group with the conflicting setting from Orchestrator.
Under UI Profile, select the user interface profile for the account.
(Optional) Under Update policy settings, choose the release level to which you want this user to be required to update UiPath applications on their workstation.

If you select a policy, the user will not be able to use UiPath Robot, Studio, or Assistant until they upgrade these applications to the version required by the policy. This setting can help you make sure that all your users are using the same versions.
If you want to also create an attended or unattended robot for this user, click Next and continue with the next sub-section.

Otherwise, click Skip and assign to apply your settings. Skip the rest of the instructions in this section.

2a) Attended Robot

Under Attended Robot, set the first toggle to Enabled (right position) if you want to automatically create an attended robot for the user.
Select the Enable a Personal Workspaces for this user if you want them to have a Personal Workspace.
If the user license management model is disabled, under License Type select a user license to assign to the user. What is my licensing model?

Note:
If the user license management model is enabled, the License Type options are not available on this page.

You must also assign an attended user license - either at the group level, or to individual users - so that they can use the attended robot.
Click the second toggle Automatically create Personal Workspaces for members of this group to set it to off (left position) if you do not want each user to have a Personal Workspace.

2b) Unattended Robot

Under Unattended Robot, click the toggle to set it to Enabled (right position) if you want to create an unattended robot for the user.

For running service unattended automations, we recommend using a robot account instead. Users typically only need an unattended robot if they are an RPA developer and they need to debug unattended processes.

If this user does not require an unattended robot, click Next to review robot settings and continue with step 16 or click Skip and assign to apply your changes and skip the rest of the instructions in this section.
Under Settings, select the Machine login credentials checkbox if you want to specify the account credentials for logging in to the machine.
- In the Domain\Username field, type the domain and username used to log on to the machine on which UiPath Robot is installed. The credentials must exist in the selected credential store.
  For domain-joined users, use the domain\username format. For example deskover\localUser1. For local Windows accounts, use the host_machine_name\username format, with the host machine's name instead of the domain. For example, LAPTOP1935\localUser2. For local Windows accounts residing on multiple host machines and which you want to use regardless of machine, use the .\username format, with a dot instead of the host machine name. For example .\localUser3.
  
  Note:
  The credentials you set must match the Windows account credentials for the machine on which this account can run automations.
  
  To get the account name, on the machine, open command prompt and use the whoami command.
- In the Password field, type the password for the above-mentioned account.
- From the Credential Type list, select the type of credentials you provided above.
- If you selected a CyberArk credential store, indicate the External Name. If not specified, the default value is used.
If you want to only allow this robot to run one job at a time and therefore consume only one runtime, select the Run only one job at a time checkbox.

If disabled, the robot can simultaneously execute multiple jobs. The maximum number of jobs it can run at the same time depends on the number of runtimes that were allocated to the standard machine or machine template on which the robot runs.
Click Next to review additional settings for the robot and continue with the instructions in the next sub-section.

If you do not want to customize robot settings, click Skip and assign to apply your changes. Skip the remaining instructions.

3) Robot Settings

Configure execution settings for the UiPath Robot.

For details about each setting, see Robot Settings.
When finished, click Assign.

The user account is now set up and displayed on the Assign roles page. One floating robot is created for the user for each robot configured above.

Assigning Roles to a Robot Account

Go to Tenant > Manage Access > Assign roles tab.
In the top right of the tab, click Assign roles and select Robot account.

1) General Details

In the Search for a Robot account field, type to search for the robot account to which you want to assign roles.

If needed, you can add a new robot account to your organization by clicking Manage Accounts to the right of the field. You must be an organization administrator to be able to add accounts.
Click the Roles field and then select the checkbox for each role you want to assign to the robot account.

If needed, you can define a new role by clicking New role to the right of the field.

If classic folders are inactive for your tenant, you can only assign Tenant roles and Mixed roles. To also assign Folder roles to this account, you must do so from the Folders page or from the folder's Settings page.

2) Robot Setup

Note: For robot accounts, Unattended robot is enabled by default and cannot be disabled. Also, there is no option for Attended robot.

If this account will be used to run foreground processes, under Settings, select the Machine login credentials checkbox to specify the account credentials for logging in to the machine.
- In the Domain\Username field, type the domain and username used to log on to the machine on which UiPath Robot is installed.
  For domain-joined users, use the domain\username format. For example uipath\localUser1.
  
  For local Windows accounts, use the host_machine_name\username format, with the host machine's name instead of the domain. For example, LAPTOP1935\localUser2.
  
  For local Windows accounts residing on multiple host machines and which you want to use regardless of machine, use the .\username format, with a dot instead of the host machine name. For example .\localUser3.
  
  Note:
  The credentials you set must match the Windows account credentials for the machine on which this account can run automations.
  
  To get the account name, on the machine, open command prompt and use the whoami command.
- In the Password field, type the password for the above-mentioned account.
- From the Credential Type list, select the type of credentials you provided above.
- If you selected a CyberArk credential store, indicate the External Name. If not specified, the default value is used.
If you want to only allow the robot to run one job at a time and therefore consume only one runtime, select the Run only one job at a time checkbox.

If disabled, the robot can simultaneously execute multiple jobs. The maximum number of jobs it can run at the same time depends on the number of runtimes that were allocated to the standard machine or machine template on which the robot runs.
Click Next to review additional settings for the robot and continue with the instructions in the next sub-section.

If you do not want to customize robot settings, click Skip and assign to apply your changes and skip the remaining instructions.

3) Robot Settings

Configure execution settings for the UiPath Robot.
When finished, click Assign.

The robot account is now set up and displayed on the Assign roles page.

Checking Roles

To see what roles are assigned to a user or a group:

Go to Tenant > Manage access > Assign roles tab.
Click the Check roles & permissions above the table.

The Check roles window opens.
In the Select a user field, type to search for the group or user whose roles you want to check. Optionally, filter the results by Users or Groups.
Select the group or user from the search results.

You can see the user or group's roles at the tenant and folder level. You can also see whether the role has been explicitly assigned or inherited from a group they are in.

Important: If you are using an Azure AD guest user account, the role information that is displayed may not be accurate.

Editing Roles

Go to Tenant > Manage access > Assign roles tab.
At the right end of the row, click More Actions and select Edit.
Make changes as needed.
When finished, click Update to apply your changes.

Activating or Deactivating an Account

Deactivated users can no longer access Orchestrator.

Note: Only users with the Administrator role can perform this operation.

Go to Tenant > Manage access > Assign roles tab.
At the right end of the row, click More Actions and select Activate or Deactivate.

The account is updated on the Assign roles page.

Removing an Account or Group

Removing a user or group from Orchestrator does not delete the account from your organization.

Go to Tenant > Manage access > Assign roles tab.
At the right end of the row, click More Actions and select Remove.
Confirm the operation.

The account or group is removed from Orchestrator and all roles are revoked.

Alternatively, select one or multiple accounts, and click Remove.

Important: Removing a directory group does not remove the license of an associated directory user, even if the group removal unassigns the user from any folder. The only way to release the license is to close UiPath Assistant on the user's machine.

Important: For accounts that are part of mappings which are employed in triggers, you cannot delete them or unassign them from the folder where the trigger resides. Make sure the account is not set as an execution target in a trigger so you can delete them.

Disabling Concurrent Execution

Optimizing resource consumption and maximizing execution capacity in modern folders involves little to no control over how users are allocated to jobs. For scenarios where a credential cannot be used more than once at a time (for example, with SAP), you can limit concurrent execution for unattended processes. This helps modulate the job allocation algorithm by restricting a user from simultaneously executing multiple jobs.