Subscribe

UiPath Orchestrator

The UiPath Orchestrator Guide

Configuring host settings

The Settings page of the Orchestrator host portal enables system administrators to adjust global settings for Orchestrator that apply to all tenants.
You can also configure the same settings on a per-tenant basis by using the Settings page at the tenant level, which overrides the host setting.

📘

Note

Certain settings are different between standalone Orchestrator and Orchestrator in Automation Suite. Where applicable, these differences are noted below each setting.

General Tab


Field

Description

Application Settings

Timezone - The time zone for all tenants. By default, this field is set to UTC.
The time zone list depends on the machine. To ensure that all the instances under a multi-node Orchestrator installation have the same time zone list, they must use the same operating system version.
Language - The language of the Orchestrator user interface for all tenants, including email notifications and alerts. This setting does not affect robot logs or event logs, which use the Windows language.
Changing the organization language settings in Automation Suite.
Custom logo - Upload your desired logo which appears in the Orchestrator window header. The accepted formats are .png and .svg, with a maximum file size of 1MB.
Changing the company logo in Automation Suite.
Custom header color - Select a color for the Orchestrator window header. This is useful for distinguishing between multiple Orchestrator tenants. The header color is selected by clicking the colored square to bring up your machine's color selector.
In Automation Suite, you cannot customize the color of the header.

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

Auto-fill available product versions - Configure whether the update policies for all tenants in the organization contain the latest versions of client binaries or if they need to be configured manually. If you need to manage update versions manually, disable this option and follow the steps described in this article.

Modern Folders

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

Classic Folders (deprecated)

Activate Classic Folders - Enable classic folders.
Note: Use this setting with caution, since classic folders are disabled and will soon be deprecated.

Email Setup

Enable alerts email - Enable Orchestrator to send email messages about Fatal and Error alerts.
To receive email alerts, email settings must be properly set up.
Configuring system email notification settings for all tenants in a standalone Orchestrator deployment.
Configuring global email notification settings for all organizations (and the tenants in them) in Automation Suite.
Overriding global email notification configuration for a certain organization (and the tenants in it) in Automation Suite.

Application Tab


Field

Description

Terms and conditions URL

Add a URL to the terms and conditions that is displayed on the Login page.

Custom title

Add a custom name to identify the Orchestrator instance that is displayed on the Login page.

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.

📘

Note

Packages settings made on this page propagate as defaults for new tenants only. Settings for existing tenants need to be configured explicitly for each tenant.

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. Libraries can be published from Studio or manually uploaded by the user in Orchestrator and are stored within the chosen feed.

Field

Description

Internal

Must be selected in order to use an internal feed as the tenant 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. 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.

External

Must be selected in order to use an external feed as the tenant feed. The feed can be secured using an API key:
API Key - The 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.

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

Allow tenant users to upload into the feed

Allow users to upload packages to the host feed.

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

Robot Security Tab


Robot

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.

Scalability Tab


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

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.

Updated about a month ago


Configuring host settings


Suggested Edits are limited on API Reference Pages

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