Subscribe

UiPath Orchestrator

The UiPath Orchestrator Guide

Field Descriptions

The Users Page

FieldDescription
Columns
visible_columns
Enables you to toggle column visibility. By default, all columns are displayed. Clear or select the check boxes corresponding to the columns you want to stay hidden or visible, respectively.

Click Reset in the Visible Columns drop-down to return to the default configuration with all columns enabled and visible.
SearchLooks for users that match your input. You can search according to username, name, surname and email.
Type FilterEnables you to filter the page according to the user type. The following options are available: All, Local User, Robot, Directory User, Directory Group.
Status FilterEnables you to filter the page according to the user status. The following options are available: All, Active, and Inactive.
Web Access FilterEnables you to filter the page according to the Web Access setting. The following options are available: All, Enabled, Disabled.
Robot Access FilterEnables you to filter the page according to the robot access (as set through the Automatically create a Robot for this user toggle on the Robot Settings tab when configuring the user). The following options are available: All, Disabled, Enabled, Set by Group.
Reset to defaultsThis button is displayed only if you made changes to any of the filters described above, and enables you to return to the default settings.

Please note that this button also resets the number of items displayed per page.
Add

add
When clicked it expands into three options:
Add Directory User or Group - enables you to add and configure directory users or directory groups from the Active Directory.
Add Local User - enables you to add and configure local users.
Check Permissions - enables you to check the access-rights for a user or a group both at folder level and at tenant level.
Username For local users it displays the username given at user configuration.
For directory users it displays the username as set in AD, and the domain he was added from. The syntax is the following: username@domain. For example, john.smith@deskover.
For directory groups it displays the name of the group as set in AD, and the domain it was added from. The syntax is the following: group_name@domain. For example finance@deskover.
For Robot users, it displays the name of the Robot as set at Robot creation in Orchestrator. This is only applicable for Robots created manually.
Name The name of the user. This field is empty if you did not fill in the Name field in the Provision User window.
Surname The surname of the user. This field is empty if you did not fill in the Surname field in the Add Local User window.
Email The email address of the user. Can be used to log in to Orchestrator. This field is empty if you did not fill in the Email Address field in the Provision User window.
If email alerts are enabled, and the user has a role with View permissions on Alerts, the alerts are sent to this address.
Last LoginThe amount of time passed since the user last logged in to Orchestrator.
RolesThe role(s) assigned to the user. This field is empty if you did not fill in the Roles field in the Provision User window.
StatusThe status of the user. Can be Active or Inactive.
Web AccessIndicates whether the user has been granted web access to Orchestrator.
Robot AccessThe user's robot access settings. May be Enabled, Disabled, or Set by Group.
More Actions

more_actions
Enables a drop-down with the following options:
Edit - Opens the Edit User window that enables you to make changes to your user configuration.
For Robot users you can only edit the roles.
For directory users and directory groups you can only edit roles and, if modern folders are enabled, you can toggle web access on/off.
* For local users you can edit all the fields, except the username.

View Profile - Opens the Profile page for the corresponding user. This option is only available for local users and directory users.
Check Permissions - Opens the User Permissions window which enables you to see the permissions of your user on a per folder basis, and whether they have been explicitly assigned or inherited from the tenant.
Activate - Enables a deactivated user. Only users with the Administrator role can activate other users.
Deactivate - Makes the current user unavailable. Only users with the Administrator role can deactivate other users.
Deactivating a user removes any customized settings made beforehand, including robot and licensing settings.
Remove - Remove the selected user. You cannot delete Robot users, and users with the Administrator role.

The Add Local User Window

The Add Local User Tab

FieldDescription
Username Your username. This is used when logging in to Orchestrator.

Note: If you fill in your AD username and no password, your user is provisioned as a directory user. If you fill in your AD username and a custom password, your user is provisioned as a local user.
Name Your name. This option is useful when Orchestrator is used by a large group of people.
Surname Your surname. This option is useful when Orchestrator is used by a large group of people.
Email address Your email address. Can be used to log in to Orchestrator. This field needs to be populated with a valid email address if the user wants to receive email alerts. For more information, see Setting Up Email Alerts.
Password The password that you want to use when logging in to Orchestrator. Passwords must contain at least 8 characters and contain at least one letter and a digit.
Confirm Password The password retyped, to ensure no mistakes.
Roles The role(s) assigned to the user. You can add multiple roles.
Allow Web Login ToggleIf enabled, the user is able to access the Orchestrator web UI. Only displayed for tenants that have the Modern Folders option enabled.
Allow Basic Authentication ToggleIf enabled, local users are able to authenticate to Orchestrator using basic authentication.
Note: This toggle is only available if the Auth.RestrictBasicAuthentication setting in your web.config file is set to false.
CreateSaves your user settings and closes the Add Local User window.
Cancel Closes the Add Local User window without saving your settings.

The Attended Robot Tab

FieldDescription
Automatically create an attended robot for this userConfigure whether a robot is automatically created for the user or not. Selecting this option makes the robot settings configurable. Clearing it disables them.
More details about automatically created Robots here.
Domain \ UsernameA maximum of 256 characters allowed.
Identify the robot associated with that specific user.
For domain-joined users, use the domain\username syntax. For example deskover\florin.salam.
For local Windows accounts, use the host_machine_name\username syntax, with the name of the host machine instead of the domain. For example LAPTOP1935\elvis.
License TypeConfigure the license type of the Robot. The following options are available: Attended, Studio, StudioX, StudioPro. More details here.
Stand-alone licenseSelect this option to indicate that a Studio/StudioX/StudioPro Robot is licensed locally and not through Orchestrator.
Note: For robots in modern folders, using a stand-alone license disconnects your Robot from Orchestrator. In the UiPath Robot tray, the robot is displayed as Unlicensed. As soon as a local license is available, the robot becomes licensed and is displayed as Available in Orchestrator.

The Unattended Robot Tab

FieldDescription
Automatically create an unattended robot for this userConfigure whether an unattended robot is automatically created for the user or not. Selecting this option makes the Robot settings configurable. Clearing it disables them.
More details about automatically created robots here.
Domain\UsernameA maximum of 256 characters allowed.
Identify the robot associated with that specific user.
For domain-joined users, use the domain\username syntax. For example deskover\florin.salam.
For local Windows accounts, use the host_machine_name\username syntax, with the name of the host machine instead of the domain. For example LAPTOP1935\elvis.
For local Windows accounts residing on multiple host machines, which you want to use regardless of machine, use the .\username syntax with a dot instead of the host machine name. For example .\mariah.carey.
Credential StoreSelect the credential store to hold the credentials.
PasswordFill in the password used to log on to the machine on which UiPath Robot is installed.
Select the The password represents a SmartCard Pin option if the password is a SmartCard PIN.

The Robot Settings Tab

Control UiPath Robot execution settings from Orchestrator. Execution settings are not configurable for directory groups. Directory groups come with the default settings.
Click here for details about every setting.

The Add Directory User or Group Window

📘

Important!

You can only access this window after Enabling Windows Authentication.

Add Directory User or Group Tab

FieldDescription
Domain NameThe AD domain to which the group or user belongs to. All domains and subdomains from forests that are 2-way trusted with the domain specified in the WindowsAuth.Domain parameter are available when adding directory users/groups.
Group or UsernameThe name of the AD Group or User that you want to add.
Filter ByA drop-down which enables you to refine the search results according to the user type. The following options are available:
All - Displays all the AD identities, regardless of their type.
Users - Displays AD users only.
Groups - Displays AD groups only.
Roles Assigns one or multiple roles to AD group or user selected.
Allow Web Login ToggleIf enabled, the directory user or group is able to access the Orchestrator web UI. Only displayed for tenants that have the Modern Folders option enabled.
AddAdds the user entity.
CancelCloses the window without adding users or saving your settings.

The Attended Robot Tab

FieldDescription
Automatically create an attended robot for this userConfigure whether a robot is automatically created for the user or not. Selecting this option makes the robot settings configurable. Clearing it disables them.
More details about automatically created Robots here.
Domain \ UsernameRead-only. Identify the robot associated with that specific user. Prefilled with the domain\username of the directory user to be imported.
License TypeConfigure the license type of the Robot. The following options are available: Attended, Studio, StudioX, StudioPro. More details here.
Stand-alone licenseSelect this option to indicate that a Studio/StudioX/StudioPro Robot is licensed locally and not through Orchestrator.
Note: For robots in modern folders, using a stand-alone license disconnects your Robot from Orchestrator. In the UiPath Robot tray, the robot is displayed as Unlicensed. As soon as a local license is available, the robot becomes licensed and is displayed as Available in Orchestrator.

The Unattended Robot Tab

Not available for AD groups.

FieldDescription
Automatically create an unattended robot for this userConfigure whether an unattended robot is automatically created for the user or not. Selecting this option makes the Robot settings configurable. Clearing it disables them.
More details about automatically created robots here.
Domain\UsernameRead-only. Identifies the robot associated with that specific user. Prefilled with the credentials of the directory user to be imported.
Credential StoreSelect the credential store to hold the credentials.
PasswordFill in the password used to log on to the machine on which UiPath Robot is installed.
Select the The password represents a SmartCard Pin option if the password is a SmartCard PIN.

The Robot Settings Tab

Control UiPath Robot execution settings from Orchestrator. Execution settings are not configurable for directory groups. Directory groups come with the default settings.
Click here for details about every setting.

Updated 2 years 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.