Subscribe

UiPath Orchestrator

The UiPath Orchestrator Guide

The Settings page enables administrators to adjust Orchestrator tenant settings.

General Tab


Field

Description

Application Settings

Time Zone - The time zone of the tenant. By default, this field is set to UTC.

Personal Workspaces

Enable Personal Workspace - Create personal workspaces for all users in a tenant that use a certain attended licensing profile, while also selecting the UI profile to be used for those users.

Note: This action cannot be reversed, once the Personal Workspaces feature is enabled it cannot be disabled.

Standard Roles

Create standard roles for modern folders. These roles allow you to leverage the benefits of user groups.

Click Create Role next to each of the roles you want create.

Client Binaries (Robot, Studio, Assistant) Auto-Update Settings

Ignore auto-update status for robot machines that were offline for more than ___ days - Exclude inactive machines from the update process and no longer take them into account when the update status is reported.

Modern Folders

Enable account-machine mappings - Enable the Account-Machine Mappings feature.

Classic Folders

Activate Classic Folders - Enable classic folders.
Note: Classic folders are deprecated. Enabling them is only recommended if you migrate from an on-premises Orchestrator deployment to Orchestrator in Automation Cloud.

Deployment Tab


Enables you to configure and secure feeds for packages and libraries. You can manage the feeds for all tenants from a centralized location using Automation Ops. For more information, see feeds management in the Automation Ops guide.

Settings here only affect tenant feeds; folder feeds and personal workspace feeds are always internal and available in the context of the respective folder or personal workspace alone.

Packages

Enables you to set an internal or an external feed in which automation packages can be maintained. By default, an internal feed is used. The feeds can be secured either by defining basic authentication credentials or by using an API key.

Field

Description

Internal

Use an internal feed. The feed can be secured either with the Secure Deployment option or by using an API key:
Secure Deployment - Ensures that your automation packages are downloaded through a secure NuGet feed.
API Key - The key used to secure your feed against write operations such as delete or upload.

External

Use an external feed. The feed can be secured either by using an API key or basic authentication credentials:
API Key - The key used to secure your feed against write operations such as delete or upload.
Authentication - Enables 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.

When External is selected, the Deployment URL field is displayed where you need to fill in the address where the NuGet feed is located.

Libraries

Enables you to configure the feed to be used for library and activity packages.

Field

Description

Only host feed

Libraries are stored in 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 the tenant level: each tenant has access to the other tenants' activity.
🛈 You cannot upload libraries from Orchestrator if this option is selected.
🛈 This option gives robot access to the host feed only.

Only tenant feed

Libraries are isolated at the tenant level, meaning data is separated across tenants. You may set an internal or an external feed in which libraries are maintained. By default, an internal feed is used.
🛈 This option gives robot access to the tenant feed only.

Both host and tenant feeds

Libraries are isolated at the tenant level, meaning data is separated across tenants. You may set an internal or an external feed in which libraries are maintained. By default, an internal feed is used.
🛈 This option gives robot access to both the host and tenant feeds.

Internal

Displayed when Only tenant feed or Both host and tenant feeds is selected.
Use an internal feed for your libraries. The feed can be secured either with the Secure Deployment option or by using an API key:
Secure Deployment - Ensures that your automation packages are downloaded through a secure NuGet feed.
API Key - The key used to secure your feed against write operations such as delete or upload.

External

Displayed when Only tenant feed or Both host and tenant feeds is selected.
Use an external feed for your libraries. The feed can be secured either by using an API key or basic authentication credentials:
API Key - The key used to secure your feed against write operations such as delete or upload.
Authentication - Enables 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.

When External is selected, the Deployment URL field is displayed where you need to fill in the address where the NuGet feed is located.

Prerequisites for Using an External Feed Through a Proxy

If you want to use an external feed while you have a proxy server configured on Windows, the following are required beforehand:

  • Set the Load User Profile option for the Orchestrator application pool (Internet Information Services > Application Pools) to True.
436436
  • Add the proxy settings you used to the NuGet.config file associated with the application pool identity account (C:\Users\[YourAppPoolIdentityAccountName]\AppData\Roaming\NuGet\NuGet.Config):
<config>
<add key="http_proxy" value="http://ipaddress:port" />
</config>

📘

Important

Note that 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.

Mail Tab


Enables you to configure email settings so that you can send email alerts to users with a provided email address.

Email Setup field

Description

Enable alerts email

When selected, email alerts are sent to users that have a valid email address and the Alerts - View permission.

Use default credentials

If selected, your custom email settings are reverted to default.
The default settings are integrations of the SendGrid server.

Note: You can set the Default From Display Name to easily identify the alert mails in your inbox.

Use custom settings

If selected, you can set up your own SMTP server to receive alert emails from.

Note: The following SMTP fields become available for configuration:

Enable SSL

If selected, the connection is secured. Depending on your SMTP server, an SSL or TLS certificate may be required for the SMTP domain, otherwise emails are not sent.
If cleared, the connection is not secured.

SMTP Host

The IP or domain of your SMTP server.

SMTP Domain

The SMTP domain for the username. This will be concatenated with the SMTP username, if the SMTP server requires authentication.

SMTP Port

The SMTP port. For example, if you are using a Gmail account to send mail messages and Enable SSL is not selected, the port should be 587. If Enable SSL is selected, the port should be 465.

SMTP Username

The 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 Password

The email account password.

Default From Address

The email address from which to send alert mail messages.

Default From Display Name

A custom display name for the email address from which you send alerts.

Test Mail Settings

Validates the email settings.

For more information, see Setting Up Email Alerts.

Robot Security Tab


Security

Field

Description

Total hours a robot can run offline without license verification

Specify the number of hours a Robot can run offline, without Orchestrator checking its license. By default, it is set to 0. The maximum accepted value is 168 hours.

Robot authentication

Field

Description


Attended robot authentication

Interactive Sign-in SSO (Recommended) - This option only allows for robot connections with tokens that expire. Users can authenticate their robots only by signing-in with their credentials in the Assistant.
Note: User sign in is required to run attended robots, make Orchestrator HTTP requests, or view processes in the Assistant. When using interactive sing-in, there is no need to create machine objects in Orchestrator.

Hybrid - This option allows for both connections with tokens that don't expire (machine key) and connections with tokens that expire (interactive sign-in or client credentials). Users have the option to sign-in with their credentials to authenticate their robots, which in turn allows them to connect Studio and the Assistant to Orchestrator, however it is not mandatory.

Unattended robot authentication

Client credentials (Recommended) - This option only allows for connections with tokens that expire. It uses the OAuth 2.0 framework as the basis for the authentication protocol, meaning unattended robots can connect to Orchestrator with a client ID - client secret pair generated via machine template objects. The client ID - client secret pair generates a token that authorizes the connection between the robot and Orchestrator and provides the robot with access to Orchestrator resources.

Hybrid - This option allows for both connections with tokens that don't expire (machine key) and connections with tokens that expire (client credentials).

Scalability Tab


Specify if the Robot service should subscribe to Orchestrator's SignalR channels, and configure the transport protocols that work best for you.

15701570

SignalR (Robots)

Field

Description

Enabled

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

WebSocket

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

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.

Long Polling

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

Non-Working Days Tab


Define a list of non-business days, per tenant, on which you can restrict triggers from running. This means that, during public holidays, weekends, or any other day on which normal business activities are not being carried out, your long-run schedules can be configured such that they don't trigger. Once the defined non-business days are over, the triggers launch as usual.

In order to apply these restrictions to your triggers, you need to select the non-working day calendar when configuring triggers. All changes you make on the Non-Working Days tab affect all triggers that use that calendar.

For more details on how to manage non-working days, click here.

Cloud Connections


This tabs allows you to configure integrations with third-party cloud service providers (CSPs) which are used for elastic robot orchestration.

Cloud Robot Images


This tab lists captured images of customized machines that are used for Cloud Robot - VM.
Managing custom images

Updated 8 days ago


Settings


Suggested Edits are limited on API Reference Pages

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