Subscribe

UiPath Orchestrator

Product Lifecycle

Submit Product Feedback
{{user.name}}

The UiPath Orchestrator Guide

Release notes

2019.10.23

Getting Started

Introduction
The User Interface
Logging in to Orchestrator
Resetting your password
Dashboard
About Backward and Forward Compatibility
Activities Feeds

Best practices

Organization Modeling in Orchestrator
Managing Large Deployments
Automation Best Practices
Attended vs. Unattended Automation
Security Best Practices
Performance Best Practices
- Maintenance Considerations

Hardware and Software Requirements

Hardware Requirements
Software Requirements
Prerequisites for Installation
About Deployment

Installation

About Installation
The Windows Installer
- Command Line Parameters
The Azure App Service Installation Script
- Publish-Orchestrator.ps1 Parameters
AWS Deployment
- Creating AWS Access Keys
- Installing Terraform
Web.Config

High Availability Add-On

Hardware and Software Requirements
Installation

Updating and Migrating

About Updating and Migrating
Updating Using the Windows Installer
Updating Using the Azure Script
Migrating Elasticsearch Indices
Backup and Restore

Authentication

Configuring the Active Directory integration
Configuring SSO: SAML 2.0
Configuring SSO: Azure Active Directory
SmartCard Authentication
Setting Up Auto Login for Users Under an Active Directory Group
Configuring the SMTP server
Changing the Windows Authentication Protocol

Other Configurations

Increasing the Size Limit of Package Files
Opting Out of Telemetry
Setting up Encryption Key per Tenant
GZIP Compression

System Administrator

About System Administrators
Managing Tenants
Field Descriptions for the Tenants Page
Field Descriptions for the Host Audit Page
Field Descriptions for the Host Settings Page
Field Descriptions for the Admin Profile Page
Maintenance Mode

Tenants

About the Tenant Context
Settings
Field Descriptions for the Tenant Settings Page

Folders

About Folders
Managing Folders
Field Descriptions
Classic folders vs modern folders
Migrating from Classic Folders to Modern Folders
Administration of Modern Folders

Environments

About Environments
Managing Environments
Field Descriptions

Users

About Users
User Types
Managing Users
Field Descriptions
FAQ

Roles

About Roles
Default Roles
Managing Roles
Field Descriptions

Machines

Machines
Managing Machines
Field Descriptions

Packages

Packages
- Publishing a Project from Studio to Orchestrator
Managing Packages
Field Descriptions

Libraries

About Libraries
Managing Libraries
Field Descriptions

Audit

Audit
Field Descriptions

Credential Stores

Credential Stores
Managing Credential Stores
CyberArk® Integration
Azure Key Vault Integration
Credential Store Plugins
Field Descriptions

Licensing

About Licensing
Activating Your License
Managing Your Licenses
Field Descriptions for the License Page
Field Descriptions for the Attended and Studio Pages
Field Descriptions for the Unattended and NonProduction Pages

Alerts

Alerts
Alert Emails
- Setting Up Alert Emails
- Alert Emails Dashboard Description
Alert Severity Levels
Field Descriptions

Monitoring Menu

About Monitoring
Robots
- Fields Descriptions for the Robots Page
- Folder Robots Overview
Jobs
Queues
- SLA
Logs

Robots

About Robots
Robot Statuses
Robots in Classic Folders
Robots in Modern Folders

Processes

About Processes
Managing Processes
Field Descriptions
About Recording

Triggers

About Triggers
Managing Triggers
Field Descriptions
Using Cron Expressions

Queues

About Queues and Transactions
Managing Queues in Orchestrator
Managing Queues in Studio
Managing Transactions
- Editing Transactions
Review Requests
Field Descriptions for Queues
Field Descriptions for Transactions
- Field Descriptions for the Transactions .csv File
Field Descriptions for Review Requests

Assets

About Assets
Managing Assets in Orchestrator
Managing Assets in Studio
Field Descriptions

Tasks

About Tasks
Managing Tasks
Field Descriptions for the Tasks Page
About Task Catalogs
Managing Task Catalogs
Field Descriptions for the Task Catalogs Page

Profile

About the Profile Page
Managing Profile Settings
Field Descriptions for the Profile Page

Integrations

About Input and Output Arguments
- Example of Using Input and Output Arguments
Webhooks

Troubleshooting

IE 11.0.9600.17031 Issues
Frequently Encountered Orchestrator Errors
Cron Expressions
Upgrade Issues

Release notes

2019.10.23

Getting Started

Introduction
The User Interface
Logging in to Orchestrator
Resetting your password
Dashboard
About Backward and Forward Compatibility
Activities Feeds

Best practices

Organization Modeling in Orchestrator
Managing Large Deployments
Automation Best Practices
Attended vs. Unattended Automation
Security Best Practices
Performance Best Practices
- Maintenance Considerations

Hardware and Software Requirements

Hardware Requirements
Software Requirements
Prerequisites for Installation
About Deployment

Installation

About Installation
The Windows Installer
- Command Line Parameters
The Azure App Service Installation Script
- Publish-Orchestrator.ps1 Parameters
AWS Deployment
- Creating AWS Access Keys
- Installing Terraform
Web.Config

High Availability Add-On

Hardware and Software Requirements
Installation

Updating and Migrating

About Updating and Migrating
Updating Using the Windows Installer
Updating Using the Azure Script
Migrating Elasticsearch Indices
Backup and Restore

Authentication

Configuring the Active Directory integration
Configuring SSO: SAML 2.0
Configuring SSO: Azure Active Directory
SmartCard Authentication
Setting Up Auto Login for Users Under an Active Directory Group
Configuring the SMTP server
Changing the Windows Authentication Protocol

Other Configurations

Increasing the Size Limit of Package Files
Opting Out of Telemetry
Setting up Encryption Key per Tenant
GZIP Compression

System Administrator

About System Administrators
Managing Tenants
Field Descriptions for the Tenants Page
Field Descriptions for the Host Audit Page
Field Descriptions for the Host Settings Page
Field Descriptions for the Admin Profile Page
Maintenance Mode

Tenants

About the Tenant Context
Settings
Field Descriptions for the Tenant Settings Page

Folders

About Folders
Managing Folders
Field Descriptions
Classic folders vs modern folders
Migrating from Classic Folders to Modern Folders
Administration of Modern Folders

Environments

About Environments
Managing Environments
Field Descriptions

Users

About Users
User Types
Managing Users
Field Descriptions
FAQ

Roles

About Roles
Default Roles
Managing Roles
Field Descriptions

Machines

Machines
Managing Machines
Field Descriptions

Packages

Packages
- Publishing a Project from Studio to Orchestrator
Managing Packages
Field Descriptions

Libraries

About Libraries
Managing Libraries
Field Descriptions

Audit

Audit
Field Descriptions

Credential Stores

Credential Stores
Managing Credential Stores
CyberArk® Integration
Azure Key Vault Integration
Credential Store Plugins
Field Descriptions

Licensing

About Licensing
Activating Your License
Managing Your Licenses
Field Descriptions for the License Page
Field Descriptions for the Attended and Studio Pages
Field Descriptions for the Unattended and NonProduction Pages

Alerts

Alerts
Alert Emails
- Setting Up Alert Emails
- Alert Emails Dashboard Description
Alert Severity Levels
Field Descriptions

Monitoring Menu

About Monitoring
Robots
- Fields Descriptions for the Robots Page
- Folder Robots Overview
Jobs
Queues
- SLA
Logs

Robots

About Robots
Robot Statuses
Robots in Classic Folders
Robots in Modern Folders

Processes

About Processes
Managing Processes
Field Descriptions
About Recording

Triggers

About Triggers
Managing Triggers
Field Descriptions
Using Cron Expressions

Queues

About Queues and Transactions
Managing Queues in Orchestrator
Managing Queues in Studio
Managing Transactions
- Editing Transactions
Review Requests
Field Descriptions for Queues
Field Descriptions for Transactions
- Field Descriptions for the Transactions .csv File
Field Descriptions for Review Requests

Assets

About Assets
Managing Assets in Orchestrator
Managing Assets in Studio
Field Descriptions

Tasks

About Tasks
Managing Tasks
Field Descriptions for the Tasks Page
About Task Catalogs
Managing Task Catalogs
Field Descriptions for the Task Catalogs Page

Profile

About the Profile Page
Managing Profile Settings
Field Descriptions for the Profile Page

Integrations

About Input and Output Arguments
- Example of Using Input and Output Arguments
Webhooks

Troubleshooting

IE 11.0.9600.17031 Issues
Frequently Encountered Orchestrator Errors
Cron Expressions
Upgrade Issues

Introduction to the Orchestrator API

About OData and References
API References
Logical Resources and Metadata
Available Operations

The Swagger Definition

Managing Logical Resources
Building API Requests

Basics

Permissions Per Endpoint

Examples Using the Orchestrator API

Authenticating
Environments Requests
Robots Requests
Retrieving License Information
Packages Requests
Processes Requests
Libraries Requests
Jobs Requests
Triggers Requests
Transaction Requests
Assets Requests
Settings Requests
Users Requests
Roles Requests
Permissions Requests
License Requests
Tenants Requests
Webhooks Requests
Folders Requests
Calendars Requests
Tasks Requests
Task Catalogs Requests
Task Forms Requests

Performance Best Practices

The following page describes a set of best practices aimed at improving their performance.

Maintenance Considerations

Updated 11 days ago

Table of Contents
- Maintenance Considerations

Performance Best Practices

Suggested Edits are limited on API Reference Pages

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

Terms of Use
Contact Us
Our Ecosystem
Academy
Forum
Start Trial