orchestrator
2024.10
true
UiPath logo, featuring letters U and I in white

Orchestrator User Guide

Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated Dec 4, 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.

docs image

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.

docs image

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.

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.