orchestrator

2023.10

false

Getting started
- Introduction
- User options
- Logging in to Orchestrator
- Resetting your password
- Robots
  - Robot Statuses
  - Robot Settings
- Auto Updating Client Components
- Orchestrator Configuration Checklist
Best practices
- Organization Modeling in Orchestrator
- Managing Large Deployments
- Automation Best Practices
- Optimizing Unattended Infrastructure Using Machine Templates
- Unattended automation
- Organizing Resources With Tags
- Orchestrator Read-only Replica
- Exporting grids in the background
Tenant
- About the Tenant Context
- Searching for Resources in a Tenant
- Robots
- Folders
- Monitoring
- Access control
- Configuring automation capabilities
- Machines
- Packages
- Audit
- Credential Stores
  - Managing credential stores
  - Integrating credential stores
- Webhooks
  - Types of Events
  - Managing Webhooks
- Licensing
  - Managing Your Licenses
- Alerts
- Settings - Tenant Level
Resource Catalog Service
- About Resource Catalog Service
Folders Context
- About the Folders Context
- Home
Automations
- About Automations
Processes
- About Processes
- Managing Processes
- Managing Package Requirements
- Recording
Jobs
- About Jobs
- Managing Jobs
- Job States
- Working with long-running workflows
- Running Personal Remote Automations
- Process Data Retention Policy
Triggers
- About triggers
  - Time triggers
  - Queue triggers
- Managing triggers
  - Creating a time trigger
  - Creating a queue trigger
- Managing Non-Working Days
- Using Cron Expressions
  - Triggering jobs on the last day of the month
Logs
- About Logs
- Managing Logs in Orchestrator
- Logging Levels
- Orchestrator Logs
Monitoring
- About Monitoring
- Machines
- Processes
- Queues
- Queues SLA
Queues
- About Queues and Transactions
- Bulk uploading Queue Items using a CSV file
- Managing Queues in Orchestrator
- Managing Queues in Studio
- Managing Transactions
  - Editing Transactions
  - Field Descriptions for the Transactions .csv File
- Review Requests
Assets
- About Assets
- Managing Assets in Orchestrator
- Managing Assets in Studio
- Storing Assets in Azure Key Vault (read only)
- Storing Assets in HashiCorp Vault (read only)
- Storing Assets in AWS Secrets Manager (read only)
Storage Buckets
- About Storage Buckets
  - CORS/CSP Configuration
- Managing Storage Buckets
- Moving Bucket Data Between Storage Providers
Test Suite - Orchestrator
- Test Automation
- Test Cases
  - Field Descriptions for the Test Cases Page
- Test Sets
  - Field Descriptions for the Test Sets Page
- Test Executions
  - Field Descriptions for the Test Executions Page
- Test Schedules
  - Field Descriptions for the Test Schedules Page
- Test Data Queues
- Testing Data Retention Policy
Other Configurations
- Increasing the Size Limit of Package Files
- Setting up Encryption Key Per Tenant
- GZIP Compression
Integrations
- About Input and Output Arguments
  - Example of Using Input and Output Arguments
Host administration
- About the host level
- Managing system administrators
- Managing tenants
- Configuring host authentication settings
- Managing your host license
  - Allocating Licenses to Tenants
- Configuring system email notifications
- Configuring other host settings
  - Customizing the Login page
  - Session Policy
  - Orchestrator Host Settings
- Audit logs for the host portal
- Maintenance Mode
Organization administration
- About organizations
- Managing organization administrators
- Managing organization settings
- Configuring organization authentication
  - Setting up the Azure AD integration
  - Configuring the SAML integration
    - Setting up SAML SSO with Azure AD
- Configuring organization security
  - Session policy
  - Restricting access to a set of users
- About licensing
  - Activating your license
- Accounts and groups
  - Managing access
  - Managing accounts and groups
- Authorizing external applications
  - Managing external OAuth applications
  - Configuring fine-grained access for confidential apps
- Managing tags
- Overriding system email settings
  - Email setup
    - System emails are not sent - SslHandshakeException
- Audit logs
Troubleshooting
- About Troubleshooting
- Frequently Encountered Orchestrator Errors
- Browser group policies
- Cron Expressions

Orchestrator User Guide

DELIVERY:

Automation Cloud Automation Cloud Public Sector Automation Suite Standalone

Last updated Nov 7, 2024

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.

Note: Changes to the host settings apply to all tenants that did not update their settings with custom values.

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

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.

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 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>
```

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.

On this page

General Tab
Application Tab
Deployment Tab
Packages
Libraries
Prerequisites for Using an External Feed Through a Proxy
Robot Security Tab
Robot
Scalability Tab
SignalR (Robots)

Was this page helpful?

PREVIOUSSession Policy

NEXTAudit logs for the host portal

Support and Services

Get The Help You Need

UiPath Academy

Learning RPA - Automation Courses

UiPath Forum

UiPath Community Forum

Trust and Security

Cookies Policy