orchestrator

latest

false

Getting started
- Introduction
- Robots
  - Robot Statuses
  - Robot Settings
- Auto Updating Client Components
- Time-to-live Periods
- Orchestrator Outbound IP Addresses
Best practices
- Organization Modeling in Orchestrator
- 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
- Webhooks
  - Types of Events
  - Managing Webhooks
- Licensing
  - Managing Your Licenses
- Alerts
- Settings
Cloud robots
- Elastic Robot Orchestration
  - Requirements
  - Cloud Provider Setup
  - Setup in Orchestrator
  - Troubleshooting
  - Frequently Asked Questions
- Automation Cloud™ Robots - VM
- Automation Cloud™ Robots - Serverless
- Configuring VPN for cloud robots
- Live streaming and remote control
- My notifications
Folders Context
- About the Folders Context
- Home
Automations
- About Automations
Processes
- About Processes
- Managing Processes
- Managing Package Requirements
- Recording
- Live streaming and remote control
  - Live streaming and remote control via RealVNC
    - Error scenarios
  - Live streaming and remote control via TightVNC
    - Error scenarios
Jobs
- About Jobs
- Managing Jobs
- Job States
- Working with long-running workflows
- Running Personal Remote Automations
- Process Data Retention Policy
Apps
- About Apps
- Publishing an App to a Tenant
- Managing Apps
- Running a Deployed App from a Folder
Triggers
- About triggers
- Managing triggers
- 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
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
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
Resource Catalog Service
- About Resource Catalog Service
Authentication
- About Authentication
- SmartCard Authentication
- Configuring the SMTP Server
Integrations
- About Input and Output Arguments
  - Example of Using Input and Output Arguments
Troubleshooting
- About Troubleshooting
- Frequently Encountered Orchestrator Errors

Orchestrator User Guide

DELIVERY:

DELIVERY:

Automation Cloud Automation Cloud Public Sector Automation Suite Standalone

Last updated Sep 17, 2024

Requirements

Important:

All cloud robot VMs contain a hypervisor agent (hvagent or UiPath VM Agent), which ensures the running of VMs. You can find it in your CSP installation folder. Add this agent to your allow-list, so that your security agents do not remove or block it.
We advise against imposing restrictions on your cloud provider subscription that might block the deployment of specific resources, as these resources are crucial to the successful creation and functioning of virtual machines.

To opt in for elastic robot orchestration, you need one of the following:

Azure Requirements

You need a Microsoft Azure subscription for hosting your cloud robots.

You must set up Azure and get the following details from your Azure administrator to connect Orchestrator:

Client Id - the unique identifier for the client app registration
Client Secret Key - the password for the app registration
Subscription Id - the unique key for your organization's Azure subscription
Directory (tenant) Id - the unique key for the tenant you use within the Azure subscription.

For details, refer to the Setup in Azure chapter.

AWS Requirements

You need an Amazon Web Services (AWS) subscription with Amazon Elastic Compute Cloud (Amazon EC2) for hosting your cloud robots.

You can connect to your AWS account through:

Access Key Based Authentication
RoleARN Based Authentication

Contact your AWS administrator to provide you with the following values:

For Access Key Based Authentication:
- Access Key ID - the unique identifier for the Orchestrator connection
- Secret Access Key - the password for this connection.
For RoleARN Based Authentication:
- RoleARN ID - the unique identifier for your role in AWS

For details, refer to the Setup in AWS chapter.

GCP Requirements

You need a Google Cloud Platform (GCP) subscription which includes Compute Engine for hosting your cloud robots.

You must set up a GCP project and get the following details from your GCP administrator to connect Orchestrator:

Client Id - the unique identifier for your GCP project
Private Key - the key for the GCP service account used for the integration.

For details, refer to the Setup in GCP chapter.

On this page

Azure Requirements
AWS Requirements
GCP Requirements

Was this page helpful?

PREVIOUSElastic Robot Orchestration

NEXTCloud Provider Setup

Support and Services

Get The Help You Need

Learning RPA - Automation Courses

UiPath Community Forum

Trust and Security

© 2005-2024 UiPath. All rights reserved.