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 Integration Service
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
v2022.4
v2021.10
v2022.4
stable
v2022.10
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
2022.4.0
2022.4.1
Overview
Automation Suite overview
Glossary
Automation Suite products
Cross-product dependencies
Compatibility matrix
Deployment architecture
Supported use cases for single-node and multi-node installations
Cross-deployment feature comparison
Certificates overview
Requirements
Hardware and software requirements
Evaluating your storage needs
Estimating cloud infrastructure costs
Capacity planning
Using uipathctl.sh
AI Center considerations
Root privileges requirements
High Availability – Three availability zones
Certificate requirements
Network requirements
Validating the prerequisites
Validating the prerequisites in a single-node evaluation setup
Validating the prerequisites in a multi-node HA-ready production setup
Installation
Best practices
Q&A: Deployment templates
Recommended: AWS deployment template
Release notes
AWS deployment architecture
Step 1: Preparing the AWS deployment
Step 2: Deploying the Quick Start Template
Step 3: Post-deployment steps
AWS deployment parameters
Recommended: GCP deployment template
Release notes
GCP deployment architecture
Step 1: Preparing the GCP deployment
Step 2: Deploying Automation Suite to GCP
Step 3: Post-deployment steps
Recommended: Azure deployment template
Release notes
Azure deployment architecture
Step 1: Preparing the Azure deployment
Step 2: Deploying Automation Suite to Azure
Step 3: Post-deployment steps
Manual: Single-node evaluation profile requirements and installation
Configuring the machines
Configuring the DNS
Configuring Microsoft SQL server
Configuring the certificates
Validating the prerequisites
Online single-node evaluation installation
Offline single-node evaluation installation
Manual: 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
Validating the prerequisites
Online multi-node HA-ready production installation
Offline multi-node HA-ready production installation
Manual: Advanced installation experience
Downloading installation packages
install-uipath.sh parameters
Enabling Redis High Availability Add-on for the cluster
Document Understanding configuration file
Adding a dedicated agent node with GPU support
Connecting Task Mining Application
Adding a dedicated agent node for Task Mining
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
Post-installation
Accessing Automation Suite
Managing the certificates
Resizing PVC
Updating the SQL database
Cluster administration
Managing products
Managing the cluster in ArgoCD
Backing up and restoring the cluster
Setting up the external NFS server
Automated: Enabling the backup on the cluster
Automated: Disabling the backup on the cluster
Automated, online: Restoring the cluster
Automated, offline: Restoring the cluster
Manual: Enabling the backup on the cluster
Manual: Disabling the backup on the cluster
Manual, online: Restoring the cluster
Manual, offline: Restoring the cluster
Additional configuration
Performing node operations
Adding a new node to the cluster
Removing a node from the cluster
Repaving a cluster node
Shutting down a node
Performing node maintenance
Performing database maintenance
Optimizing Objectstore storage
Manual: Migrating Ceph data pool from replicated to erasure-coded type
Automated: Migrating Ceph data pool from replicated to erasure-coded type
Configuring the cluster
Configuring the FQDN post-installation
Resizing PVC for AI Center
Setting up Kerberos authentication
Setting up Elasticsearch and Kibana
Saving robot logs to Elasticsearch
Setting up Splunk
Monitoring and alerting
Using the monitoring stack
Alert runbooks
Migration and upgrade
Upgrading Automation Suite
Automated: Online upgrade
Automated: Offline upgrade
Manual: Online upgrade
Manual: Offline upgrade
Rollback on error
Migrating Longhorn physical disk to LVM
Migrating from Canal to Cilium CNI
Downgrading Ceph from 16.2.6 to 15.2.9
Migration options
A) Full installation migration
Orchestrator configuration file checklist
Pre-migration steps
Updating the database connection strings
Post-migration steps
B) Single tenant migration
First Time Configuration
About the Automation Suite ecosystem
Interface tour
User preferences
Logging in
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 the Active Directory integration
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
Setting up the Azure AD integration
Configuring the SAML 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
Data Service
Product-specific configuration
Orchestrator
Using the Orchestrator Configurator Tool
Apps
Audit logs queries
MongoDB monitoring dashboard
MongoDB certificate renewal
Document Understanding
Access to the models
Troubleshooting
Troubleshooting
Using the Diagnostics Tool
Using the Support Bundle tool
Exploring logs
Release Notes
2022.4.0
2022.4.1
Overview
Automation Suite overview
Glossary
Automation Suite products
Cross-product dependencies
Compatibility matrix
Deployment architecture
Supported use cases for single-node and multi-node installations
Cross-deployment feature comparison
Certificates overview
Requirements
Hardware and software requirements
Evaluating your storage needs
Estimating cloud infrastructure costs
Capacity planning
Using uipathctl.sh
AI Center considerations
Root privileges requirements
High Availability – Three availability zones
Certificate requirements
Network requirements
Validating the prerequisites
Validating the prerequisites in a single-node evaluation setup
Validating the prerequisites in a multi-node HA-ready production setup
Installation
Best practices
Q&A: Deployment templates
Recommended: AWS deployment template
Release notes
AWS deployment architecture
Step 1: Preparing the AWS deployment
Step 2: Deploying the Quick Start Template
Step 3: Post-deployment steps
AWS deployment parameters
Recommended: GCP deployment template
Release notes
GCP deployment architecture
Step 1: Preparing the GCP deployment
Step 2: Deploying Automation Suite to GCP
Step 3: Post-deployment steps
Recommended: Azure deployment template
Release notes
Azure deployment architecture
Step 1: Preparing the Azure deployment
Step 2: Deploying Automation Suite to Azure
Step 3: Post-deployment steps
Manual: Single-node evaluation profile requirements and installation
Configuring the machines
Configuring the DNS
Configuring Microsoft SQL server
Configuring the certificates
Validating the prerequisites
Online single-node evaluation installation
Offline single-node evaluation installation
Manual: 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
Validating the prerequisites
Online multi-node HA-ready production installation
Offline multi-node HA-ready production installation
Manual: Advanced installation experience
Downloading installation packages
install-uipath.sh parameters
Enabling Redis High Availability Add-on for the cluster
Document Understanding configuration file
Adding a dedicated agent node with GPU support
Connecting Task Mining Application
Adding a dedicated agent node for Task Mining
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
Post-installation
Accessing Automation Suite
Managing the certificates
Resizing PVC
Updating the SQL database
Cluster administration
Managing products
Managing the cluster in ArgoCD
Backing up and restoring the cluster
Setting up the external NFS server
Automated: Enabling the backup on the cluster
Automated: Disabling the backup on the cluster
Automated, online: Restoring the cluster
Automated, offline: Restoring the cluster
Manual: Enabling the backup on the cluster
Manual: Disabling the backup on the cluster
Manual, online: Restoring the cluster
Manual, offline: Restoring the cluster
Additional configuration
Performing node operations
Adding a new node to the cluster
Removing a node from the cluster
Repaving a cluster node
Shutting down a node
Performing node maintenance
Performing database maintenance
Optimizing Objectstore storage
Manual: Migrating Ceph data pool from replicated to erasure-coded type
Automated: Migrating Ceph data pool from replicated to erasure-coded type
Configuring the cluster
Configuring the FQDN post-installation
Resizing PVC for AI Center
Setting up Kerberos authentication
Setting up Elasticsearch and Kibana
Saving robot logs to Elasticsearch
Setting up Splunk
Monitoring and alerting
Using the monitoring stack
Alert runbooks
Migration and upgrade
Upgrading Automation Suite
Automated: Online upgrade
Automated: Offline upgrade
Manual: Online upgrade
Manual: Offline upgrade
Rollback on error
Migrating Longhorn physical disk to LVM
Migrating from Canal to Cilium CNI
Downgrading Ceph from 16.2.6 to 15.2.9
Migration options
A) Full installation migration
Orchestrator configuration file checklist
Pre-migration steps
Updating the database connection strings
Post-migration steps
B) Single tenant migration
First Time Configuration
About the Automation Suite ecosystem
Interface tour
User preferences
Logging in
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 the Active Directory integration
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
Setting up the Azure AD integration
Configuring the SAML 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
Data Service
Product-specific configuration
Orchestrator
Using the Orchestrator Configurator Tool
Apps
Audit logs queries
MongoDB monitoring dashboard
MongoDB certificate renewal
Document Understanding
Access to the models
Troubleshooting
Troubleshooting
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