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
- Exporting usage data
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
Orchestrator testing
- 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
- 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 Microsoft Entra ID
- 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
  - Using default email settings
    - Default email settings
  - Using custom email settings
    - Custom email settings
- Audit logs
Troubleshooting
- About Troubleshooting
- Alerts troubleshooting
- General troubleshooting
- Frequently Encountered Orchestrator Errors

Orchestrator user guide

DELIVERY:

Last updated Sep 3, 2025

Activating your license

After receiving a license key from UiPath®, you can proceed to activate your Orchestrator instance. There are separate steps you must follow depending on if your Orchestrator is connected to the internet or offline.

Online activation

In Orchestrator, navigate to the License page at tenant level or host level. The License page is displayed.
Select Update.
Select Activate Online. The Activate Online window is displayed.
The Installation ID field is automatically populated with the unique identifier of your Orchestrator instance and is not editable.
In the License Key field, enter the license key.
In the Environment Designation field, use the radio buttons to select whether this is a Production, Non-Production, or Hybrid instance.
Select Activate. Your Orchestrator is licensed and ready for use.

Offline activation

In Orchestrator, navigate to the License page at tenant level or host level. The License page is displayed.
Select Update.
Select Activate Offline. The Activate Offline window is displayed, prompting you: Do you have a valid license file?
Select No and select Next. The Generate the request file window is displayed.

Note: If you already have a license file, select Yes. You will be prompted to upload the file to finish the activation.
The Installation ID field is automatically populated with the unique identifier of your Orchestrator instance and is not editable.
In the License Key field, enter the license key.
In the Environment Designation field, use the radio buttons to select whether this is a Production,Non-Production, or Hybrid instance.
Select Generate. The Activate Offline window is displayed with the remaining steps to finish the activation.
Select the Download button to download the request file.
From any computer with an internet connection, navigate to the Activation Portal .
Use the Upload from File button to upload your request file.
Select Generate License File. A license file is generated and saved.
Return to your Orchestrator instance. Select the Browse button to select the license file.
Select Activate. Your Orchestrator is licensed and ready for use.

Note: Any changes made to your licenses from UiPath require a license update. Refer to Renewing or Updating Your License for details.

On this page

Online activation
Offline activation

Was this page helpful?

PREVIOUSAbout licensing

NEXTAccounts and groups

Support and Services

Get The Help You Need

Learning RPA - Automation Courses

UiPath Community Forum

Trust and Security

© 2005-2025 UiPath. All rights reserved.