Subscribe

UiPath Orchestrator

The UiPath Orchestrator Guide

Field Descriptions for the Tenant Settings Page

The General Tab

📘

Important!

It is recommended that the tenant and the Robots have the same time zone.

FieldDescription
Time ZoneThe time zone of the tenant. By default, this field is set to UTC.
The timezone list depends on the machine. To ensure that all the instances under a multi-node Orchestrator installation have the same timezone list, they must use the same operating system version.
LanguageThe language of the user interface for Orchestrator. You can choose between:
English (Default)
日本語
Deutsch
español
español (México)
français
한국어
português
português (Brasil)
русский
Türkçe
中文 (简体)
Connection StringA URL that enables you to automatically enroll Robots to Orchestrator. It contains the following information:
the Orchestrator URL - identifies the Orchestrator instance the Robot connects to;
tenant ID - identifies the tenant the Robot connects to;
domain name - identifies the domain of the machine; this is only necessary if the machine is in a different domain than that specified for the WindowsAuth.Domain parameter in web.config (this is valid for subdomain machines as well).

Details here.
Modern FoldersCheck box to enable the Modern Folders feature.
Note: This action cannot be reversed, once the Modern folders feature is enabled it cannot be disabled.

The Deployment Tab

📘

Important

The following settings are loaded only when the Robot Service connects to the server. Whenever they are modified you need to restart the UiRobotSvc service for the changes to take effect.

The Packages Section

FieldDescription
InternalMust be selected in order to use an internal feed. The feed can be secured either with the Secure Deployment option or by using an API key.
ExternalMust be selected in order to use an external feed. The feed can be secured either by using an API key or basic authentication credentials.
Secure DeploymentEnsures that your automation packages are downloaded through a secure NuGet feed.
API KeyThe key used to secure your feed against write operations such as delete or upload.
Deployment URLThe address where the NuGet feed is located.
AuthenticationEnables you to specify the credentials for your basic authenticated feed.
Please keep in mind that both the username and the password used with the API Key option should be used in this case as well.

The Libraries Section

FieldDescription
HostLibraries are stored within the host feed and are available to all tenants which use it. The Libraries page is the same for one Orchestrator instance, meaning libraries are not isolated at tenant level: each tenant has access to the other tenants' activity.
TenantLibraries are stored within the tenant feed and are isolated at tenant level, meaning data is separated across tenants. This feed behaves similarly to the packages feed and, as such, the same options are displayed when selecting the option.
InternalMust be selected in order to use an internal feed. The feed can be secured either with the Secure Deployment option or by using an API key.
ExternalMust be selected in order to use an external feed. The feed can be secured using an API key.
Secure DeploymentEnsures that your automation packages are downloaded through a secure NuGet feed.
Deployment URLThe address where the NuGet feed is located.
API KeyThe key used to secure your feed against write operations such as delete or upload. The user can use it to publish packages.
This key is generated by the external provider and has the following format [username]:[password]. For example, admin:2652ACsQhy.

📘

Note:

Robots with versions less than 2018.2 do not support the Secure Deployment setting.
Robots with versions less than 2018.3 cannot download packages when using an external feed.

The Mail Tab

FieldDescription
Enable Alerts EmailWhen selected, email alerts are sent to users that have a valid email address and View permissions on Alerts.
Use Default CredentialsWhen selected, the credentials of the identity under which Orchestrator runs are used to connect to the SMTP server. See step 5 in the installation procedure described here.
When using default credentials, the SMTP Password and SMTP Username fields are disregarded even if they are filled in. This check box should be cleared if the Enable SSL option is selected.
Enable SSLWhen selected, indicates that an SSL certificate is required for the SMTP domain used (if any). If this check box is selected, then the Use default credentials option should not be selected.
SMTP HostThe IP or Domain of the SMTP server.
SMTP DomainDomain for the username, if SMTP server requires authentication.
SMTP PortThe SMTP port. For example, if you are using a Gmail account to send mail messages and Enable SSL is selected, the port should be 587.
SMTP UsernameThe username of the SMTP server, if it requires authentication. For example, if you are using Gmail, fill in this field with the email address to be used to send messages.
SMTP PasswordThe email account password.
Default From AddressThe email address from which to send alert mail messages.
Default From Display NameA custom display name for the email address from which you send alerts.
Test Mail SettingsEnables you to validate the email settings.

For more information, see the Setting Up Email Alerts page.

The Security Tab

Password Complexity

📘

Note:

By default, passwords must contain at least 8 characters and at least one letter and a digit.

FieldDescription
Must have special charactersWhen selected, it forces users to create login passwords containing special characters. By default, this check box is not selected.
Must have lowercase charactersWhen selected, it forces users to create login passwords containing lowercase characters. By default, this check box is selected.
Must have uppercase charactersWhen selected, it forces users to create login passwords containing uppercase characters. By default, this option is not selected.
Must have digitsWhen selected, it forces users to create login passwords containing at least one digit. By default, this check box is selected.
Minimum LengthSpecify the minimum number of characters user login passwords should contain. By default, it is 8. The length cannot be smaller than 6 and longer than 14.
Expiration DaysSpecify the number of days for which the password is available. After this period the password expires and needs to be changed.
The minimum accepted value is 0, while the maximum is 120 days.
The Number of Previously Used PasswordsEnables you to define how many of your latest passwords are prohibited from use when setting up a new password.
The minimum accepted value is 0, while the maximum one is 10.
Should change password on first loginWhen selected, users that log in to Orchestrator for the first time are required to change their password.

📘

Note:

Editing the settings in the Password Complexity tab does not affect existing passwords.

Account Lockout

FieldDescription
EnabledIf checked, locks the account for a specific amount of seconds after a specific amount of failed login attempts. This also applies to the password change feature.
Account Lockout SecondsThe number of seconds a user needs to wait before attempting to log in again after exceeding the Max Access Attempts. The default value is 5 minutes.
The minimum accepted value is 0, while the maximum one is 2592000 (1 month).
Max Access AttemptsThe amount of login attempts a user can make before the account is locked. The default value is 10 attempts. You can set a value between 2 and 10.

Robot

  • Run Disconnected Hours - Enables you to specify the number of hours a Robot can run offline, without checking for its Orchestrator license. By default, it is set to 0. The maximum accepted value is 168 hours. This setting is applied when you first connect the Robot to Orchestrator, or after the UiPath Robot service is restarted. If you are running the Community version, you need to restart the tray for the change to take effect. Logs are cached locally while the Robot is offline, and are sent to Orchestrator when it reconnects.

📘

Important!

Please note that if you restart the UiPath Robot service or the machine the Robot is running on while in an offline environment, the license is lost.

The Scalability Tab

SignalR (Robots)

FieldDescription
EnabledThis toggle specifies if the Robot service subscribes to Orchestrator's SignalR channels or not. By default, this setting is enabled, and all available channels are selected:
WebSocket
Server-Sent Events (SSE)
Long Polling

When all transport channels are enabled, the best available transport is automatically selected, in the following priority order: WebSocket > Server-Sent Events > Long Polling. If the first protocol is not available for any reason, the next in line (if enabled) is used to facilitate the communication between Orchestrator and Robot.

Upon upgrade, the value of this setting is preserved.
WebSocketWhen selected, enables the WebSocket transport protocol to be used to connect the Robot to Orchestrator's SignalR channels. This is the highest protocol used in the order of priority due to its performance and support for simultaneous communication in both directions - from the Robot service to Orchestrator and vice versa.

This option cannot be used if the SignalR (Robots) feature is not enabled.

Upon upgrade, the value of this setting is preserved.
Server-Sent Events (SSE)When selected, enables the Server-Sent Events (SSE) push technology to be used to connect the Robot to Orchestrator's SignalR channels. This is the first backup in case WebSockets is not available for any reason.

This option cannot be used if the SignalR (Robots) feature is not enabled.

Upon upgrade, the value of this setting is preserved.
Long PollingWhen selected, enables the long polling transport protocol to be used to connect the Robot to Orchestrator's SignalR channels. This protocol is used in case the WebSockets and SSE ones are not available.

This option cannot be used if the SignalR (Robots) feature is not enabled.

Upon upgrade, the value of this setting is preserved.

Updated about a month ago



Field Descriptions for the Tenant Settings Page


Suggested Edits are limited on API Reference Pages

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