- Getting started
- Best practices
- Tenant
- About the Tenant Context
- Searching for Resources in a Tenant
- Managing Robots
- Connecting Robots to Orchestrator
- Storing Robot Credentials in CyberArk
- Storing Unattended Robot Passwords in Azure Key Vault (read-only)
- Storing Unattended Robot Credentials in HashiCorp Vault (read-only)
- Deleting Disconnected and Unresponsive Unattended Sessions
- Robot Authentication
- Robot Authentication With Client Credentials
- SmartCard Authentication
- Audit
- Resource Catalog Service
- Folders Context
- Automations
- Processes
- Jobs
- Triggers
- Logs
- Monitoring
- Queues
- Assets
- Storage Buckets
- Test Suite - Orchestrator
- Other Configurations
- Integrations
- Classic Robots
- Host administration
- About the host level
- Managing system administrators
- Managing tenants
- Customizing the Login page
- Session Policy
- Orchestrator Host Settings
- Configuring system email notifications
- Audit logs for the host portal
- Maintenance Mode
- Organization administration
- Troubleshooting
Orchestrator User Guide
Orchestrator Host Settings
On the Orchestrator host portal, system administrators have access to several global settings for Orchestrator. This page describes the options available in this portal and how to use them.
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.
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 .
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. |
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 the auto-updating client components article in the Orchestrator guide. |
Modern Folders |
Enable account-machine mappings - See details about configuring account-machine mappings. |
Classic Folders (deprecated) |
Activate Classic Folders - Enable classic folders. Use this setting with caution, since classic folders are 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 set up by an administrator. |
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. |
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.
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:
|
External |
Use an external feed. The feed can be secured either by using an API key or basic authentication credentials:
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. |
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:
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:
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. |
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 in 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>
<config> <add key="http_proxy" value="http://ipaddress:port" /> </config>
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.
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:
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. |