- Introduction
- Product lifecycle
- Use of customer data in UiPath
- Use of customer data with Agents
- Use of customer data with AI Center
- Use of customer data with AI Computer Vision
- Use of customer data with Apps
- Use of customer data with Assistant
- Use of customer data with Automation Ops
- Use of customer data with Automation Hub
- Use of customer data with Autopilot for Everyone
- Use of customer data with cloud robots
- Use of customer data with Context Grounding
- Use of customer data with Data Service
- Use of customer data with Document Understanding™
- Use of customer data with Healing Agent
- Use of customer data with Insights
- Use of customer data with Integration Service
- Use of customer data with IT Automation
- Use of customer data with IXP
- Use of customer data with Orchestrator
- Use of customer data with Process Mining
- Use of customer data with Robot
- Use of customer data with ScreenPlay
- Use of customer data with Studio and StudioX
- Use of customer data with Studio Web
- Use of customer data with Test Manager
- Licensing
- Delivery options
- UiPath Platform
- UiPath documentation
- About UiPath documentation
- UiPath documentation website URLs
- Unified cloud documentation tracker
- Troubleshooting
Overview
This section explains how UiPath documentation is structured and how to find the right information for each offering, delivery option, or product.
The section is organized into the following areas:
- Platforms: How to navigate the documentation for UiPath platforms;
- Products: How to find and use documentation for individual UiPath products across delivery options;
- Documentation versioning and availability: How documentation is grouped and maintained.
The platform documentation explains how to install, configure, administer, and upgrade UiPath platform environments.
Automation Cloud and Test Cloud
The following guides include information that is applicable for both Automation Cloud and Test Cloud, because the platforms share the same architecture and management experience. The following table groups documentation by purpose and scope.
| Documentation type | Documentation guide | Description |
|---|---|---|
| Release notes | Summarizes platform-level changes for both Automation Cloud and Test Cloud, including infrastructure, administration, and shared services updates. | |
| Summarizes platform-level changes for Test Cloud only, specifically for updates related to testing. | ||
| Admin documentation | Explains how to manage users, tenants, authentication, licensing, and system configuration for both Automation Cloud and Test Cloud. | |
| Explains how to get started with Test Cloud. Administrative tasks and platform configuration are documented in the Automation Cloud Admin guide, which applies to both platforms. | ||
| API documentation | Describes the available platform APIs for Automation Cloud and Test Cloud, including authentication and service interaction. |
Automation Suite and Test Cloud
The following guides include information that is applicable for both Automation Suite and Test Cloud, because the platforms share the same deployment architecture and management experience. The following table groups documentation by purpose and scope.
| Documentation type | Documentation guide | Description |
|---|---|---|
| Release notes | Automation Suite release notes | Summarizes platform-level changes for both Automation Suite and Test Cloud, including infrastructure, administration, and shared services updates. |
| Test Cloud for Automation Suite release notes | Summarizes platform-level changes for Test Cloud only, specifically for updates related to testing. | |
| Installation documentation | Automation Suite on EKS/AKS installation guide | Offers instructions for installing Automation Suite or Test Cloud on managed Kubernetes services: Amazon EKS and Azure AKS. |
| Automation Suite on OpenShift installation guide | Offers instructions for installing Automation Suite or Test Cloud on Red Hat OpenShift clusters. | |
| Automation Suite on Linux installation guide | Offer instructions for installing Automation Suite or Test Cloud in Linux environments, from bare-metal to on-premises virtualized infrastructure. | |
| Admin documentation | Automation Suite Admin guide | Explains how to manage users, tenants, authentication, licensing, and system configuration for both Automation Suite and Test Cloud. |
| Test Cloud user guide | Explains how to get started with Test Cloud. Administrative tasks and platform configuration are documented in the Automation Suite Admin guide, which applies to both platforms. | |
| API documentation | API guide | Describes the available platform APIs for Automation Suite and Test Cloud, including authentication and service interaction. |
Each UiPath product includes its own documentation set, typically organized by documentation type. UiPath is in the process of unifying cloud documentation into a single, consistent structure across all cloud offerings. For more details, see the Unified cloud documentation tracker.
For the delivery options Automation Cloud, Automation Cloud Public Sector, and Automation Suite, the same product documentation applies to the corresponding Test Cloud offerings. Because Automation Cloud and Automation Suite share infrastructure and product architecture with Test Cloud, documentation is unified unless a feature is explicitly platform specific.
When a feature is available on only one platform, the difference is documented in one or both of the following ways:
-
Highlighted in the product release notes.
-
Noted in the relevant section of the product user guide.
For example, Test Manager in Automation Cloud and Test Cloud share the same release notes and user guide. Similarly, Test Manager in Automation Suite and Test Cloud for Automation Suite share a single documentation set.
| Documentation type | Delivery option | Description | Examples |
|---|---|---|---|
| Release notes |
Automation Cloud Test Cloud |
One shared documentation set for Automation Cloud and Test Cloud. One shared documentation set for Automation Cloud Public Sector and Test Cloud Public Sector. One shared documentation set for Automation Cloud Dedicated. | Orchestrator release notes are split into three guides:
|
|
Automation Suite Test Cloud | One shared documentation set for Automation Suite and Test Cloud, regardless of installation flavor. | Studio Web has one release notes guide for Automation Suite and Test Cloud installation flavors. | |
| Standalone | Separate release notes set. | Assistant has a separate release notes guide for standalone updates. | |
| User guide |
Automation Cloud Test Cloud | Some documentation sets are shared, while others remain separate . | Data Service has three separate user guides:
Automation Ops has one user guide that applies to Automation Cloud and Test Cloud, Automation Cloud Public Sector and Test Cloud Public Sector, and Automation Cloud Dedicated. |
|
Automation Suite Test Cloud | One shared documentation set for Automation Suite and Test Cloud. | Studio Web has one user guide for Automation Suite and Test Cloud installation flavors. | |
| Standalone | Separate documentation sets. | Assistant has a separate user guide for standalone updates. | |
| API guide |
Automation Cloud Test Cloud | One shared API documentation set for all Automation Cloud and Test Cloud flavors. | Orchestrator API guides are split into three guides: |
|
Automation Suite Test Cloud | One shared API documentation set for all Automation Suite and Test Cloud installation flavors. | Orchestrator has one API guide for Automation Suite and Test Cloud installation flavors. | |
| Standalone | Separate documentation sets. | Orchestrator has a separate API guide for standalone updates. |
Documentation versioning
Our product documentation is systematically divided based on content type, which includes installation, user, admin, and API guides, as well as release notes. The update frequency and versioning of the documentation for each product depends on whether the product is deployed in the cloud or on premises, as follows:
-
Cloud: We typically update and publish our cloud product documentation immediately after making product changes available to community users.
-
On premises:
- Long Term Support
(LTS) versions: We have a separate set of product documentation
for each LTS version.
Note: For example, Orchestrator 2022.10 and 2023.10 LTS versions each have its unique set of documentation.
- Cumulative Updates
(CU) and Community versions: Our documentation covers only the
latest CU or Community version of every LTS version.
Note: For example, if Orchestrator 2023.10.3 is the latest CU for the 2023.10 LTS version, then our documentation reflects the functionality of the 2023.10.3 version until the moment we release the following CU.
- Long Term Support
(LTS) versions: We have a separate set of product documentation
for each LTS version.
For details on what changed in each cloud deployment, CU, or LTS version, check the release notes of each product.
Documentation availability
The availability of the documentation depends on the development phase of the product it covers, as follows:
-
General Availability (GA):The full documentation for all GA products is available on the UiPath documentation platform. To share feedback on GA documentation and products, reach out to the Support team.
-
Preview:
- Private preview documentation is found exclusively on the Insider Portal and is available for a limited number of customers. To share feedback on private preview documentation and products, use the UiPath Insider Portal.
- Public preview documentation is found either on the Insider Portal and is available for signed-in customers, or exceptionally on the documentation platform and is available to the general public. Public preview documentation is marked with a Preview label. To share feedback on public preview documentation and products, use the UiPath Insider Portal.
- Community documentation is available on the UiPath documentation platform and is marked with a Preview label. To share feedback on Community documentation and products, use the UiPath forum.