orchestrator

2023.10

false

Getting started
- Introduction
- User options
- Logging in to Orchestrator
- Resetting your password
- Robots
  - Robot Statuses
  - Robot Settings
- Auto Updating Client Components
- Orchestrator Configuration Checklist
Best practices
- Organization Modeling in Orchestrator
- Managing Large Deployments
- Automation Best Practices
- Optimizing Unattended Infrastructure Using Machine Templates
- Unattended automation
- Organizing Resources With Tags
- Orchestrator Read-only Replica
- Exporting grids in the background
Tenant
- About the Tenant Context
- Searching for Resources in a Tenant
- Robots
- Folders
- Monitoring
- Access control
- Configuring automation capabilities
- Machines
- Packages
- Audit
- Credential Stores
  - Managing credential stores
  - Integrating credential stores
- Webhooks
  - Types of Events
  - Managing Webhooks
- Licensing
  - Managing Your Licenses
- Alerts
- Settings - Tenant Level
Resource Catalog Service
- About Resource Catalog Service
Folders Context
- About the Folders Context
- Home
Automations
- About Automations
Processes
- About Processes
- Managing Processes
- Managing Package Requirements
- Recording
Jobs
- About Jobs
- Managing Jobs
- Job States
- Working with long-running workflows
- Running Personal Remote Automations
- Process Data Retention Policy
Triggers
- About triggers
  - Time triggers
  - Queue triggers
- Managing triggers
  - Creating a time trigger
  - Creating a queue trigger
- 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
- Orchestrator Logs
Monitoring
- About Monitoring
- Machines
- Processes
- Queues
- Queues SLA
Queues
- About Queues and Transactions
- 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)
Storage Buckets
- About Storage Buckets
  - CORS/CSP Configuration
- Managing Storage Buckets
- Moving Bucket Data Between Storage Providers
Test Suite - 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
- Testing Data Retention Policy
Other Configurations
- Increasing the Size Limit of Package Files
- Setting up Encryption Key Per Tenant
- GZIP Compression
Integrations
- About Input and Output Arguments
  - Example of Using Input and Output Arguments
Host administration
- About the host level
- Managing system administrators
- Managing tenants
- Configuring host authentication settings
- Managing your host license
  - Allocating Licenses to Tenants
- Configuring system email notifications
- Configuring other host settings
- Audit logs for the host portal
- Maintenance Mode
Organization administration
- About organizations
- Managing organization administrators
- Managing organization settings
- Configuring organization authentication
  - Setting up the Azure AD integration
  - Configuring the SAML integration
    - Setting up SAML SSO with Azure AD
- Configuring organization security
  - Session policy
  - Restricting access to a set of users
- About licensing
  - Activating your license
- Accounts and groups
  - Managing access
  - Managing accounts and groups
- Authorizing external applications
  - Managing external OAuth applications
  - Configuring fine-grained access for confidential apps
- Managing tags
- Overriding system email settings
  - Email setup
    - System emails are not sent - SslHandshakeException
- Audit logs
Troubleshooting
- About Troubleshooting
- Frequently Encountered Orchestrator Errors
- Browser group policies
- Cron Expressions

Orchestrator User Guide

DELIVERY:

Automation Cloud Automation Cloud Public Sector Automation Suite Standalone

Last updated Nov 7, 2024

Recording

The recording functionality helps you troubleshoot faulted jobs. Whenever a job fails, screenshots illustrating the last moments of the execution are available for download. This functionality is only available for unattended automations.

Recording can be configured either at process creation, or it may be enabled and configured afterwards on the Process Settings window.

While a job is in progress, its execution can be recorded either as a video or as a screenshot.

Video

The last 3 minutes of the execution are recorded, allowing you to have a walk-through of any errors that might occur.

Note: This option is available for:

Robot versions 2023.2 and above

Important: Only background cross-platform processes can be executed with Cloud Robots - Serverless. However, please be aware that, due to a known issue, foreground jobs with UIA are interpreted as background jobs.

The Job Recording option is located on the Additional settings tab of the process creation/editing window.

It is disabled by default.

When enabled, it provides the following settings:

Record and store only failed jobs - Only records job executions that have failed, enabling you to identify and troubleshoot underlying errors.
Record and store failed queue transactions - Only records executions of jobs with failed queue transactions. As such, it can only be enabled for processes that contain one or more queues.

Note:

This option is available for:

Robot versions 2023.10+
Processes using System Activities versions 2023.10+

Record all jobs - Records all job executions.

We recommend that you enable Record all jobs for a brief amount of time so as to observe potentially odd behavior during job execution. You can then switch to only recording and storing failed jobs in order to efficiently use bandwidth and storage.

Viewing a job recording

Once the execution of a job is recorded, you can access it from these two places:

From the Job Details window.
From the contextual menu of each job, using the Open recording option.
The recording opens in a new browser tab.

There are several actions that you can take in the browser player, such as playing, pausing, searching in the video timeline, setting the playback speed, downloading the video, and displaying it in Picture in Picture mode. Additionally, you can browse the Logs page in parallel.

Viewing a failed queue transaction recording

You can watch the recording of a job execution containing failed queue transactions in the following places:

In the contextual menu of the failed transaction in question, by clicking Open recording.
In the transaction details window, by clicking Open recording.

The option is inactive if recording is not enabled at the process level or if the queue transaction is not failed.

Availability of recorded videos

Recorded videos are stored in Orchestrator indefinitely, but you can choose to only store them for seven days, and have them automatically deleted after that time. To do that, set the following parameters in the UiPath.Orchestrator.dll.config file to true:

VideoRecording.RetentionJobEnabled
Database.EnableAutomaticMigrations

Note that you can save any video to your local machine for access beyond this limit and at your own convenience.

Audit

Video recording activity is included in the Orchestrator audit.

Permissions

This feature is controlled by the folder-level Execution Media permission, with the following options:

View - Allows the account to see job execution recordings.
Create - Allows the account/role that executes the job to also create the recording of the job execution.
Delete - Allows the account to delete video recordings from Orchestrator.

The default folder-level roles that include the Create permission on Execution Media are Folder Administrator, Automation User, and Robot.

Browser capabilities

The media player used for video recording playback is compatible with the following browsers:

Google Chrome
Mozilla Firefox
Microsoft Edge
Apple Safari

However, some features are not currently supported on the latest versions of these browsers, depending on their native capabilities:

Safari and Firefox do not provide the option to download the video recording.
Firefox does not allow you to adjust the playback speed or to enable the Picture in Picture option.

Screenshot

Whenever a job fails, screenshots illustrating the last moments of the execution are available for download.

This functionality is only available for unattended automations.

The following settings are available:

Scaling - Enables you to set the scaling of the screenshots in percent. The maximum value is 100. By default, this field is set to 100.
Frequency - Enables you to configure the time interval between screenshots, in milliseconds. The minimum value is 250. By default, this field is set to 500.
Duration - Enables you to configure the length of time before failure to start the recording, in seconds. The maximum value is 120. By default, this field is set to 40.

Permissions

You need View permissions on Execution Media in order to be able to download execution media on the Jobs page.

Keep in mind that the Jobs and Processes pages have permission sets of their own, which need to be granted accordingly when dealing with actions that concern them.

UiPath® does not provide a mechanism for automatically freeing used memory. You have to manually delete the execution media files.

On this page