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

v2021.10
v2022.4
v2022.10stable
v2023.4beta

HomeUiPath Automation Suite GuideRecipesAutomation Suite for DevelopersReferenceChangelogDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API Logs

UiPath Automation Suite Guide

Automation Suite for Developers

Release Notes

2022.10.0

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
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
Getting started with the Deployment Assistant

Installation

Best practices
Q&A: Deployment templates
Recommended: AWS deployment template
Recommended: GCP deployment template
Recommended: Azure deployment template
Manual: Single-node evaluation profile requirements and installation
Manual: Multi-node HA-ready production profile requirements and installation
Manual: Advanced installation experience
Sample Azure infrastructure setup

Post-installation

Accessing Automation Suite
Managing the certificates
Resizing PVC
Updating the SQL database
Preview: Multi-site deployments

Cluster administration

Managing products
Getting started with the Cluster Administration portal
Managing the cluster in ArgoCD
- Enabling SSO for ArgoCD
Backing up and restoring the cluster
Performing node operations
Performing database maintenance
Migrating objectstore from persistent volume to raw disks
Migrating data between objectstores
Migrating in-cluster objectstore to external objectstore
Configuring the cluster

Monitoring and alerting

Using the monitoring stack
Alert runbooks

Migration and upgrade

Upgrading Automation Suite
Migration options
A) Full installation migration
B) Single tenant migration

First Time Configuration

About the Automation Suite ecosystem
Interface tour
- User preferences
- Logging in
Configuration checklist
Connecting your first robot
Configuring authentication settings

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
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
- Managing tenants and services (Old)
Setting up encryption key per tenant

Accounts and Roles

About accounts
Managing accounts and groups
Managing access

Licensing

About licenses
Allocating user licenses
- Deallocating user licenses
Allocating robot and service licenses to tenants
Requesting a service trial
Monitoring license allocation
License overallocation

Automation Suite Products

Action Center
AI Center
Apps
Automation Hub
Automation Ops
Automation Suite Robots
Data Service
Document Understanding
Insights
Orchestrator
Process Mining
Test Manager
Task Mining

Product-specific configuration

AI Center
Apps
Document Understanding
- Access to the models
Orchestrator
- Using the Orchestrator Configurator Tool
Process Mining
- Rotating blob storage credentials
Task Mining
- Out-of-sync Task Mining

Troubleshooting

Troubleshooting
Using the Automation Suite Diagnostics Tool
Using the Automation Suite Support Bundle tool
Exploring logs

Release Notes

2022.10.0

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
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
Getting started with the Deployment Assistant

Installation

Best practices
Q&A: Deployment templates
Recommended: AWS deployment template
Recommended: GCP deployment template
Recommended: Azure deployment template
Manual: Single-node evaluation profile requirements and installation
Manual: Multi-node HA-ready production profile requirements and installation
Manual: Advanced installation experience
Sample Azure infrastructure setup

Post-installation

Accessing Automation Suite
Managing the certificates
Resizing PVC
Updating the SQL database
Preview: Multi-site deployments

Cluster administration

Managing products
Getting started with the Cluster Administration portal
Managing the cluster in ArgoCD
- Enabling SSO for ArgoCD
Backing up and restoring the cluster
Performing node operations
Performing database maintenance
Migrating objectstore from persistent volume to raw disks
Migrating data between objectstores
Migrating in-cluster objectstore to external objectstore
Configuring the cluster

Monitoring and alerting

Using the monitoring stack
Alert runbooks

Migration and upgrade

Upgrading Automation Suite
Migration options
A) Full installation migration
B) Single tenant migration

First Time Configuration

About the Automation Suite ecosystem
Interface tour
- User preferences
- Logging in
Configuration checklist
Connecting your first robot
Configuring authentication settings

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
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
- Managing tenants and services (Old)
Setting up encryption key per tenant

Accounts and Roles

About accounts
Managing accounts and groups
Managing access

Licensing

About licenses
Allocating user licenses
- Deallocating user licenses
Allocating robot and service licenses to tenants
Requesting a service trial
Monitoring license allocation
License overallocation

Automation Suite Products

Action Center
AI Center
Apps
Automation Hub
Automation Ops
Automation Suite Robots
Data Service
Document Understanding
Insights
Orchestrator
Process Mining
Test Manager
Task Mining

Product-specific configuration

AI Center
Apps
Document Understanding
- Access to the models
Orchestrator
- Using the Orchestrator Configurator Tool
Process Mining
- Rotating blob storage credentials
Task Mining
- Out-of-sync Task Mining

Troubleshooting

Troubleshooting
Using the Automation Suite Diagnostics Tool
Using the Automation Suite 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
Message template
Robot account
Settings
- Get settings
- Update settings
User
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

AI Center

For more information on specific configuration for AI Center, see the following pages:

ML Packages offline installation
Copy Orchestrator certificate
Manage node scheduling

Updated 2 months ago

AI Center

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