orchestrator

latest

false

Getting started
- Introduction
- Robots
  - Robot Statuses
  - Robot Settings
- Auto Updating Client Components
- Time-to-live Periods
- Notifications
  - Notification permissions
Best practices
- Organization Modeling in Orchestrator
- Automation Best Practices
- Optimizing Unattended Infrastructure Using Machine Templates
- Unattended automation
  - Accessing the unattended robot setup
  - Useful concepts in unattended automation
  - How is unattended automation performed
- Organizing Resources With Tags
- Orchestrator Read-only Replica
- Exporting grids in the background
- Enforcing user-level Integration Service connection governance
Tenant
- About the Tenant Context
- Searching for Resources in a Tenant
- Robots
  - Managing Robots
  - Connecting Robots to Orchestrator
  - Storing Robot Credentials in CyberArk
  - Storing Unattended Robot Passwords in Azure Key Vault (read only)
  - Storing Unattended Robot Credentials in HashiCorp Vault (read only)
  - Storing Unattended Robot Credentials in AWS Secrets Manager (read only)
  - Deleting Disconnected and Unresponsive Unattended Sessions
  - Robot Authentication
  - Robot Authentication With Client Credentials
- Folders
  - Managing Folders
  - Organizing Folders
  - Personal Workspaces
  - Managing Personal Workspaces
- Monitoring
  - Unattended sessions
  - User sessions
  - License
  - API audit
- Access control
  - Account types
  - Default roles
  - Migrating from break inheritance to union of privileges
  - Managing custom roles
  - Configuring access for accounts
- Configuring automation capabilities
- Machines
  - Managing Machines
  - Assigning Machine Objects to Folders
  - Configuring Account-machine Mappings
  - EDR Protection Status
- Packages
  - Managing Packages
  - About Libraries
  - Managing Libraries
- Audit
- Credential Stores
  - Integrating credential stores
  - Managing credential stores
  - The Orchestrator Credentials Proxy
  - Orchestrator Credentials Proxy debugging
  - Managing credential proxies
- Webhooks
  - Types of Events
  - Managing Webhooks
- Licensing
  - Licensing Permissions
  - Managing Your Licenses
- Settings
  - General Tab
  - Deployment Tab
    - Libraries
  - Robot Security Tab
    - Security
    - Robot Authentication
  - Scalability Tab
    - SignalR (Robots)
Automation Suite Robots
- About Automation Suite Robots
- Executing Unattended Automations With Automation Suite Robots
  - Step 1. Enabling Unattended Automation on an Account
- Regenerating Client Secrets
- Frequently Asked Questions
Folders Context
- About the Folders Context
- Home
Automations
Processes
- About Processes
  - Runtime Arguments
    - Entry Points
    - In, Out, In/Out Arguments
  - Background Vs Foreground Processes
  - Process Compatibility
  - Version Management
- 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
  - Time triggers
  - Queue triggers
  - Event triggers
  - API triggers
    - Call modes explained
- Managing triggers
  - Creating a time trigger
  - Creating a queue trigger
  - Creating an event trigger
  - Managing API triggers
  - Trigger details
    - Jobs tab
- 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
  - Queue Item Statuses
  - Business Exception Vs Application Exception
  - Studio Activities Used With Queues
  - Queue Item Retention Policy
- 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)
Business Rules
- About Business Rules
  - Permissions for Business Rules
- Managing Business Rules
  - Creating a business rule
Storage Buckets
- About Storage Buckets
  - CORS/CSP Configuration
- Managing Storage Buckets
MCP Servers
- About MCP Servers
- Managing MCP Servers
  - Creating UiPath MCP Servers
  - Creating a remote MCP Server
- MCP compliance guidelines
Indexes
- About indexes
- Managing indexes
Orchestrator testing
- FAQ - Deprecating the testing module
  - FAQ - Migrating test artifacts to Test Manager
  - FAQ - Feature parity - Test Manager vs 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
  - Managing Test Data Queues in Orchestrator
  - Managing Test Data Queues in Studio
  - Field Descriptions for the Test Data Queues Page
  - Test Data Queue Activities
- Testing Data Retention Policy
Resource Catalog Service
- About Resource Catalog Service
Integrations
- About Input and Output Arguments
  - Example of Using Input and Output Arguments
Troubleshooting
- About Troubleshooting
- Alerts troubleshooting
- General troubleshooting
- Frequently Encountered Orchestrator Errors

Orchestrator user guide

DELIVERY:

Last updated Feb 12, 2026

Working with long-running workflows

Processes that require logical fragmentation or human intervention (validations, approvals, exception handling) such as invoice processing and performance reviews, are handled with a set of instruments in the UiPath® suite: a dedicated project template in Studio called Long Running Automation, resource allocation capabilities in Orchestrator, and actions within Action Center.

Broadly, you configure your workflow using activities from the Persistence, IntelligentOCR, DocumentUnderstanding ,and ML.Services activity packages. The workflow can be configured so that a suspended job can only be resumed if certain requirements have been met. Only after the requirements have been met, resources are allocated for job resumption, thus ensuring no waste in consumption.

In Orchestrator this is marked by having the job suspended, awaiting for requirements to be met, and then having the job resumed and executed as usual. Depending on which pair you use, completion requirements change, and the Orchestrator response adjusts accordingly.

Jobs

Activites	Use Case
Start Job and Get Reference Wait for Job and Resume	Introduce a job condition, such as uploading queue items. After the main job has been suspended, the auxiliary job gets executed. After this process is complete, the main job is resumed. Depending on how you configured your workflow, the resumed job can make use of the data obtained from the auxiliary process execution. If your workflow uses the Start Job and Get Reference activity to invoke another workflow, your Robot role should be updated with the following permissions: View on Processes. View, Edit, Create on Jobs. View on Environments.

Activites

Use Case

Introduce a job condition, such as uploading queue items.

After the main job has been suspended, the auxiliary job gets executed. After this process is complete, the main job is resumed. Depending on how you configured your workflow, the resumed job can make use of the data obtained from the auxiliary process execution.

If your workflow uses the Start Job and Get Reference activity to invoke another workflow, your Robot role should be updated with the following permissions:

View on Processes.
View, Edit, Create on Jobs.
View on Environments.

Queues

Activities	Use Case
Add Queue Item and Get Reference Wait for Queue Item and Resume	Introduce a queue condition, such as having queue items processed. After the main job has been suspended, the queue items need to be processed through the auxiliary job. After this process is complete, the main job is resumed. Depending on how you configured your workflow, the resumed job can make use of the output data obtained from the processed queue item.

Actions

Form actions

Activities	Use Case
Create Form Task Wait for Form Task and Resume	Introduce user intervention conditions, found in Action Center as actions. After the job has been suspended, an action is generated in Action Center (as configured in Studio). Only after action completion, is the job resumed. Form actions need to be completed by the assigned user. User assignment can be handled directly in Action Center, or through the Assign Tasks activity.

External actions

Activities	Use Case
Create External Task Wait for External Task and Resume	Introduce user intervention conditions, found in Action Center as actions. After the job has been suspended, an action is generated in Action Center (as configured in Studio). Only after action completion, is the job resumed. External actions can be completed by any user with Edit permissions on Actions, and access to the associated folder.

Document Validation actions

Activities	Use Case
IntelligentOCR.Activities Create Document Validation Action Wait for Document Validation Action and Resume DocumentUnderstanding.Activities Create Validation Task Create Validation Task and Wait Create Classification Validation Task Create Classification Validation Task and Wait Wait for Classification Validation Task and Resume	Introduce user intervention conditions, found in Action Center as actions. After the job has been suspended, an action is generated in Action Center (as configured in Studio). Only after action completion, is the job resumed. Document Validation actions need to be completed by the assigned user. User assignment can be handled directly in Action Center, or through the Assign Tasks activity. In order for the Robot to upload, download and delete data from a storage bucket, it needs to be granted the appropriate permissions. This can be done by updating the Robot role with the following: To upload document data: View, Create on Storage Files. View on Storage Buckets. To delete document data after downloading: View, Delete on Storage Files. View on Storage Buckets.

Activities

Use Case

IntelligentOCR.Activities

DocumentUnderstanding.Activities

Introduce user intervention conditions, found in Action Center as actions.

After the job has been suspended, an action is generated in Action Center (as configured in Studio).

Only after action completion, is the job resumed.

Document Validation actions need to be completed by the assigned user. User assignment can be handled directly in Action Center, or through the Assign Tasks activity.

In order for the Robot to upload, download and delete data from a storage bucket, it needs to be granted the appropriate permissions. This can be done by updating the Robot role with the following:

To upload document data:

View, Create on Storage Files.
View on Storage Buckets.

To delete document data after downloading:

View, Delete on Storage Files.
View on Storage Buckets.

Document Classification actions

Activities	Use Case
Create Document Classification Action Wait for Document Classification Action and Resume	Introduce user intervention conditions, found in Action Center as actions. After the job has been suspended, an action is generated in Action Center (as configured in Studio). Only after action completion, is the job resumed. Document Classification actions need to be completed by the assigned user. User assignment can be handled directly in Action Center, or through the Assign Tasks activity. In order for the Robot to upload, download and delete data from a storage bucket, it needs to be granted the appropriate permissions. This can be done by updating the Robot role with the following: To upload document data: View, Create on Storage Files. View on Storage Buckets. To delete document data after downloading: View, Delete on Storage Files. View on Storage Buckets.

Activities

Use Case

Introduce user intervention conditions, found in Action Center as actions.

After the job has been suspended, an action is generated in Action Center (as configured in Studio).

Only after action completion, is the job resumed.

Document Classification actions need to be completed by the assigned user. User assignment can be handled directly in Action Center, or through the Assign Tasks activity.

In order for the Robot to upload, download and delete data from a storage bucket, it needs to be granted the appropriate permissions. This can be done by updating the Robot role with the following:

To upload document data:

View, Create on Storage Files.
View on Storage Buckets.

To delete document data after downloading:

View, Delete on Storage Files.
View on Storage Buckets.

Data Labeling actions

Activities	Use case
Create Labeling Task Wait for External Task and Resume	Introduce user intervention conditions, found in Action Center as actions. After the job has been suspended, an action is generated in Action Center (as configured in Studio). Only after action completion, is the job resumed. Data Labeling actions require a connection to the AI Center tenant.

App actions

Activities	Use case
Create App Task Wait for App Task and Resume Get App Tasks	Introduce user intervention conditions, found in Action Center as actions. After the job has been suspended, an action is generated in Action Center (as configured in Studio). Only after action completion, is the job resumed. Using Get App Tasks, you can cover the scenarios that require another workflow to wait on the tasks, different than the workflow that created those tasks (for example, building a recovery workflow in case the current job fails). App actions are custom user actions, similar to Form actions, for which Apps provides the visual interface for rendering the task in Action Center. Apps also offers pre-made templates which allow you to customize out-of-the-box customizations for your requirements.

Activities

Use case

Introduce user intervention conditions, found in Action Center as actions.

After the job has been suspended, an action is generated in Action Center (as configured in Studio).

Only after action completion, is the job resumed.

Using Get App Tasks, you can cover the scenarios that require another workflow to wait on the tasks, different than the workflow that created those tasks (for example, building a recovery workflow in case the current job fails).

App actions are custom user actions, similar to Form actions, for which Apps provides the visual interface for rendering the task in Action Center. Apps also offers pre-made templates which allow you to customize out-of-the-box customizations for your requirements.

Duration

Activity	Use Case
Resume After Delay	Introduce a time interval as a delay, during which the workflow is suspended. After the delay has passed, the job is resumed.
Configure task timer	Allows you to configure a timer for each task in Action Center. You can configure one of these actions as the outcome on the timer's expiry: alert the assigned user reassign the task

Job fragments are not restricted to being executed by the same Robot. They can be executed by any Robot that is available when the job is resumed and ready for execution. This also depends on the execution target configured when defining the job. Details here.

Example

I defined my job to be executed by specific Robots, say X, Y and Z. When I start the job only Z is available, therefore my job is executed by Z until it gets suspended awaiting user validation. After it gets validated, and the job is resumed, only X is available, therefore the job is executed by X.

From a monitoring point of view, such a job is counted as one, regardless of being fragmented or executed by different Robots.
Suspended jobs cannot be assigned to Robots, only resumed ones can.

To check the triggers required for the resumption of a suspended job, click its corresponding Details button, and check the Triggers tab in the side panel that opens.

On this page

Jobs
Queues
Actions
Form actions
External actions
Document Validation actions
Document Classification actions
Data Labeling actions
App actions
Duration
Example

Was this page helpful?

PREVIOUSJob States

NEXTRunning Personal Remote Automations