UiPath Orchestrator

Field Descriptions

The Users Page

Field
Description

Search

Looks for users that match your input. You can search according to username, name, surname and email.

Type Filter

Enables you to filter the page according to the user type. The following options are available: All, Local User, Robot, Directory User, Directory Group.

Status Filter

Enables you to filter the page according to the user status. The following options are available: All, Active, and Inactive.

Web Access Filter

Enables you to filter the page according to the Web Access setting. The following options are available: All, Enabled, Disabled.

Robot Access Filter

Enables 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 defaults

This 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 Login

The amount of time passed since the user last logged in to Orchestrator.

Roles

The role(s) assigned to the user. This field is empty if you did not fill in the Roles field in the Provision User window.

Status

The status of the user. Can be Active or Inactive.

Web Access

Indicates whether the user has been granted web access to Orchestrator.

Robot Access

The 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.
    Note:
    • For Robot users, directory users, and directory groups you can only edit roles. For local users, the username cannot be changed.
    • Please note that editing a user in a modern folder allows you to configure web login options.
  • View Profile - Opens the Profile window for the corresponding user. This option is only available for local and directory users.
  • 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.
  • Remove - Remove the selected user. You cannot delete Robot users, and users with the Administrator role.

The Add Local User Window

The User Tab

Field
Description

Username

Mandatory.
Your username. This is used when logging in to Orchestrator.

Note: If you fill in your AD username and no password you 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

Optional.
Your name. This option is useful when Orchestrator is used by a large group of people.

Surname

Optional.
Your surname. This option is useful when Orchestrator is used by a large group of people.

Email address

Optional.
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

Optional.
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

Optional.
The password retyped, to ensure no mistakes.

Roles

Optional.
The role(s) assigned to the user. You can add multiple roles.

Allow Web Login Toggle

If enabled, the user is able to access the Orchestrator web UI. Only displayed for tenants that have the Modern Folders (Preview) option enabled.

Allow Basic Authentication Toggle

If enabled, local users are able to authenticate to Orchestrator using basic authentication.
Note: This toggle is only available is the Auth.RestrictBasicAuthentication setting in your web.config file is set to false.

Create

Saves your user settings and closes the Provision User window.

Cancel

Closes the Provision User window without saving your settings.

The Robot Settings Tab

Note that this tab is only displayed for tenants that have the Modern Folders (Preview) option enabled.

Field
Description

Automatically create a robot for this user Toggle

Enables you to configure 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.

License Type

Enables you to configure the license type of the Robot. The following options are available: Attended, Studio, StudioX. More details here.

External license

Select this option to indicate that the Robot is licensed locally and not through Orchestrator.
Note: For Robots in modern folders, using an external license disconnects your Robot from Orchestrator. In the 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.

Domain \ Username

Enables you to define the domain\username of the robot that will be correspondent to that specific local user.
It is mandatory if the Automatically create a robot for this user toggle is enabled.

Execution Settings

Enables you to control Robot execution settings from Orchestrator.
Are the same as for manually created Robots. See the fields described here.
Execution settings are not displayed when adding directory groups because directory groups have the default settings.

The Add Directory User or Group Window

Important!

You can only access this window after Enabling Windows Authentication.

Add Directory User or Group Tab

Field
Description

Domain Name

Mandatory.
Specify the domain to which the group or user belongs to.

Group Name

Mandatory.
The name of the Active Directory Group or User that you want to add.

Roles

Assigns one or multiple roles to AD group or user selected.

Add

Adds all users from the specified Active Directory group and assigns them the selected role(s).

Cancel

Closes the window without adding users or saving your settings.

Robot Settings Tab

Automatically create a robot for this user Toggle

Enables you to configure 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.

License Type

Enables you to configure the license type of the Robot. The following options are available: Inherit license from user's group, Attended, Studio, or StudioX. More details here.

Execution Settings

Enables you to control Robot execution settings from Orchestrator.
Are the same as for manually created Robots. See the fields described here.
Execution settings are not displayed when adding directory groups because directory groups have the default settings.

Updated 9 days 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.