Subscribe
UiPath Automation Suite
Subscribe
Product Lifecycle
{{user.name}}
Log In
The UiPath Automation Suite Guide
UiPath Automation Suite
Overview
UiPath Action Center
UiPath Activities
UiPath AI Center
UiPath Apps
UiPath Automation Cloud™
UiPath Automation Hub
UiPath Automation Ops
UiPath Automation Suite
UiPath Chatbot Connector - Preview
UiPath Connectors
UiPath Customer Portal
UiPath Data Service
UiPath Developer
UiPath Document Understanding
UiPath Insights
UiPath Installation and Upgrade
UiPath Integrations
UiPath Marketplace
UiPath Orchestrator
UiPath Process Mining
UiPath Release Notes
UiPath Robot
UiPath Studio
UiPath StudioX
UiPath Task Capture
UiPath Task Mining
UiPath Test Suite
v2021.10
v2021.10-Preview
beta
(RC 13)
v2021.10
stable
v2021.10.1
beta
Home
UiPath Automation Suite Guide
Recipes
Automation Suite for Developers
Reference
Changelog
Discussions
Page Not Found
Search
{{ state.current().meta.title }}
API Logs
Home
UiPath Automation Suite Guide
Automation Suite for Developers
{{search.symbol}}K
discard
Save Edits
Submit
Suggested Edits
Release Notes
2021.10
Overview
Automation Suite overview
Automation Suite components
Configuring your firewall
Compatibility matrix
Requirements and installation
Deployment architecture and installation best practices
Cross-product dependencies
Hardware requirements
Capacity planning
Root privileges requirement
AI Center considerations
Sample Azure infrastructure setup
Step 1.1: Creating the VM
Step 1.2: Configuring the VM
Step 2: Configuring the load balancer
Step 3: Configuring Azure SQL
Step 4: Configuring the DNS
AWS deployment template
AWS deployment architecture
Step 1: Planning the AWS deployment
Step 2: Deploying the Quick Start Template
Step 3: Post-deployment steps
AWS deployment parameters
GCP deployment template
GCP deployment architecture
Step 1: Preparing the GCP deployment
Step 2: Deploying Automation Suite to GCP
Step 3: Post-deployment steps
Azure deployment template
Azure deployment architecture
Step 1: Preparing the Azure deployment
Step 2: Deploying Automation Suite to Azure
Step 3: Post-deployment steps
Single-node evaluation profile requirements and installation
Configuring the machines
Configuring the DNS
Configuring Microsoft SQL server
Configuring the certificates
Online single-node installation
Offline single-node installation
Multi-node HA-ready production profile requirements and installation
Configuring the machines
Configuring the load balancer
Configuring the DNS
Configuring Microsoft SQL Server
Configuring the certificates
Online multi-node installation
Offline multi-node installation
Adding a dedicated agent node for Task Mining
Connecting Task Mining Application
Adding a dedicated agent node with GPU support
Advanced installation experience
install-uipath.sh parameters
Document Understanding Deployment configuration settings
Post-installation operations
Accessing Automation Suite
Managing products
Configuring the cluster
Configuring the FQDN post-installation
Resizing PVC for AI Center
Adding a new node to the cluster
Backing up and restoring the cluster
Using the monitoring stack
Configuring a new data disk in the cluster
Setting up Kerberos authentication
Database maintenance
Setting up Elasticsearch and Kibana
Migration and upgrade
Migrating a standalone product to Automation Suite
Pre-migration steps
Updating the database connection strings
Post-migration steps
Migrating standalone Orchestrator to Automation Suite
Orchestrator pre-migration steps
Orchestrator post-migration steps
Orchestrator configuration file checklist
Upgrading Automation Suite
First Time Configuration
About the Automation Suite experience
Interface tour
User options
Logging in
Resetting your password
Configuration checklist
Connecting your first robot
Host Administration
Configuring system email notifications
Managing system administrators
Creating or deleting organizations
Managing your host license
Allocating host licenses to organizations
Audit logs for the host portal
Host authentication and security settings
Configuring SSO: Active Directory
Configuring SSO: SAML 2.0
Configuring SSO: Google
Configuring SSO: Azure AD
Customizing the Login page
Organization Administration
Managing your organization
Managing your organization license
Overriding system email notifications
Configuring authentication and security
Configuring authentication settings
Setting up the Azure AD integration
Managing external applications
Managing tenants and services
Setting up encryption key per tenant
Accounts and Roles
About accounts
Managing accounts and groups
Managing access
Licensing
About licenses
User license management
Assigning user licenses
Checking license allocation
Deallocating user licenses
Legacy license management
Managing licenses in the legacy model
Checking license allocation (legacy)
Allocating robot and service licenses to tenants
License overallocation
Automation Suite Products
Orchestrator
Test Manager
Automation Ops
Automation Hub
AI Center
Document Understanding
Action Center
Task Mining
Apps
Insights
Product-specific configuration
Apps
Audit logs queries
Document Understanding
Access to the models
Deploy UiPath OCR Skill on AI Center
Troubleshooting
Troubleshooting
Alert runbooks
Using the Diagnostics Tool
Using the Support Bundle tool
Exploring logs
Release Notes
2021.10
Overview
Automation Suite overview
Automation Suite components
Configuring your firewall
Compatibility matrix
Requirements and installation
Deployment architecture and installation best practices
Cross-product dependencies
Hardware requirements
Capacity planning
Root privileges requirement
AI Center considerations
Sample Azure infrastructure setup
Step 1.1: Creating the VM
Step 1.2: Configuring the VM
Step 2: Configuring the load balancer
Step 3: Configuring Azure SQL
Step 4: Configuring the DNS
AWS deployment template
AWS deployment architecture
Step 1: Planning the AWS deployment
Step 2: Deploying the Quick Start Template
Step 3: Post-deployment steps
AWS deployment parameters
GCP deployment template
GCP deployment architecture
Step 1: Preparing the GCP deployment
Step 2: Deploying Automation Suite to GCP
Step 3: Post-deployment steps
Azure deployment template
Azure deployment architecture
Step 1: Preparing the Azure deployment
Step 2: Deploying Automation Suite to Azure
Step 3: Post-deployment steps
Single-node evaluation profile requirements and installation
Configuring the machines
Configuring the DNS
Configuring Microsoft SQL server
Configuring the certificates
Online single-node installation
Offline single-node installation
Multi-node HA-ready production profile requirements and installation
Configuring the machines
Configuring the load balancer
Configuring the DNS
Configuring Microsoft SQL Server
Configuring the certificates
Online multi-node installation
Offline multi-node installation
Adding a dedicated agent node for Task Mining
Connecting Task Mining Application
Adding a dedicated agent node with GPU support
Advanced installation experience
install-uipath.sh parameters
Document Understanding Deployment configuration settings
Post-installation operations
Accessing Automation Suite
Managing products
Configuring the cluster
Configuring the FQDN post-installation
Resizing PVC for AI Center
Adding a new node to the cluster
Backing up and restoring the cluster
Using the monitoring stack
Configuring a new data disk in the cluster
Setting up Kerberos authentication
Database maintenance
Setting up Elasticsearch and Kibana
Migration and upgrade
Migrating a standalone product to Automation Suite
Pre-migration steps
Updating the database connection strings
Post-migration steps
Migrating standalone Orchestrator to Automation Suite
Orchestrator pre-migration steps
Orchestrator post-migration steps
Orchestrator configuration file checklist
Upgrading Automation Suite
First Time Configuration
About the Automation Suite experience
Interface tour
User options
Logging in
Resetting your password
Configuration checklist
Connecting your first robot
Host Administration
Configuring system email notifications
Managing system administrators
Creating or deleting organizations
Managing your host license
Allocating host licenses to organizations
Audit logs for the host portal
Host authentication and security settings
Configuring SSO: Active Directory
Configuring SSO: SAML 2.0
Configuring SSO: Google
Configuring SSO: Azure AD
Customizing the Login page
Organization Administration
Managing your organization
Managing your organization license
Overriding system email notifications
Configuring authentication and security
Configuring authentication settings
Setting up the Azure AD integration
Managing external applications
Managing tenants and services
Setting up encryption key per tenant
Accounts and Roles
About accounts
Managing accounts and groups
Managing access
Licensing
About licenses
User license management
Assigning user licenses
Checking license allocation
Deallocating user licenses
Legacy license management
Managing licenses in the legacy model
Checking license allocation (legacy)
Allocating robot and service licenses to tenants
License overallocation
Automation Suite Products
Orchestrator
Test Manager
Automation Ops
Automation Hub
AI Center
Document Understanding
Action Center
Task Mining
Apps
Insights
Product-specific configuration
Apps
Audit logs queries
Document Understanding
Access to the models
Deploy UiPath OCR Skill on AI Center
Troubleshooting
Troubleshooting
Alert runbooks
Using the Diagnostics Tool
Using the Support Bundle tool
Exploring logs
Automation Suite for developers
Overview
Resources
Scopes and permissions
API call definition
Authentication
Enumerated types
License codes
Orchestrator APIs
User management
Audit query
Get audit events
Download audit events
Group
Get all groups
Delete groups
Get specific group
Delete specific group
Create a new local group
Update group
Message template
Get message template
Update a message template
Get message template by name
Robot account
Get all robot accounts
Delete robot accounts
Get specific robot account
Delete specific robot account
Create a new robot account
Update robot account
Settings
Get settings
Update settings
User
Get specific user
Update user
Delete specific user
Create a new user
Delete users
Create multiple users
Update user password
Get login attempts
License management
License resource management
Allocate licenses to an organization
Allocate licenses to a tenant
License accountant
Allocate licenses to a group
Allocate licenses to a user