orchestrator
latest
false
UiPath logo, featuring letters U and I in white
Orchestrator User Guide
Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
Last updated Nov 25, 2024

Exporting grids in the background

Overview

Orchestrator objects are displayed on their dedicated page, in a grid with various columns that are helpful to describe the status of that object.

You can export these grids to get a batch of data you can later use to create dashboards or reports. The exporting operation takes place in the background, meaning you can continue to interact with Orchestrator without having to wait for the export to finish, as a notification informs you when the download is ready.

The download format is .csv, which makes it data-analysis compliant, and you can access it from the My Reports page.

Orchestrator objects available for export

You can export the grids of the following Orchestrator objects:

  • At tenant level
    • Audit logs
    • Test Automation Audit logs
  • At folder level
    • Queue transactions
    • Logs
    • Jobs
Note:

Audit logs, queue transactions, logs, and jobs are limited to 100 exports per day per tenant.

Once that limit is exceeded, a #4502 error will be displayed, stating that the daily limit per tenant has been reached.

The limit resets at 00:00 UTC.

The exported report

Clicking the Export button creates a copy of the grid in the My reports page. A pop-up informs you when the export starts and when or if it completes.

Once the export is complete, you receive an alert letting you know that the data has been exported. The report is downloaded automatically in the background, to your browser's default download location, if you have the View on Alerts permission. However, you can also visit the My reports page and download the report at your own convenience.

The My reports page only displays the exports you created in the last 168 hours (7 days x 24 hours). Exports older than 168 hours are permanently deleted. For example, an export created on the 1st at 00:00 is available until the 7th at 23:59.

To see your exports, click the My reports icon on the top navigation bar.



You can see the following properties of an export:

  • Export type - refers to the Orchestrator object
  • Created on - the relative timestamp of when you created the export
  • Created on (absolute) - the exact timestamp of when you created the export. Absolute timestamps are rendered in the tenant time zone. For triggers, the next run time is rendered in the trigger time zone which may differ from the tenant time zone.
  • Available until - the date when the export is to be removed from the list. Reports are removed at 00:00 on the specified date.

    This is only displayed once the report has been exported.

  • Size - the size of the export. This is only displayed once the report has been exported.
  • Status - the status of the export operation:

    • New - the export is in progress.
    • Completed - the export finished.
    • Failed - the export failed. This may be generated by SQL timeout, or low storage. You need to manually retry the export.

      The computing time to resolve the export is maximum 15 minutes. After this time, the export fails. Before retrying the export, apply additional filters to your data.

      Important:

      To prevent the failure of exports with a large amount of data:

      • You must use the API endpoints for the corresponding Orchestrator object. For example, use /odata/AuditLogs/UiPath.Server.Configuration.OData.Export to export Audit logs.
      • The volume of generated exports both in terms of frequency and amount of data retrieved, can affect the performance of your tenant. If performance is affected, we might throttle or block such requests to ensure your automations are not affected by this behaviour.
      • Apply filters to reduce the amount of exported data.
To download the data to your device, click the Download button for the desired report. This operation uses the default download location on your device. The report is downloaded as an archive, which contains the .csv file of the grid filtered data.
Note:

To download exports to your device, you need to add the storage domains to your allowlist. More info here.

The .zip and the .csv files are named using the following the naming conventions:

Exported object type

Download file naming convention

Queue transactions

{queue-name}-items-{export-date}-{export-timestamp}-{export-id}

If the queue name contains invalid characters (\ / : * ? " < > |), they are replaced with _.

Audit logs

audit-logs-{export-date}-{export-timestamp}-{export-id}

Logs

robot-logs-{export-date}-{export-timestamp}-{export-id}

Jobs

jobs-{job_folder_key}-{export-date}-{export-timestamp}-{export-id}

Where:

  • {queue_name} - the name of the queue containing the exported queue items
  • {job_folder_key} - the ID of the folder from which the job grid was exported

  • {export_date} - the date when the export was created, in the yyyy-MM-dd format
  • {export_timestamp} - the time when the export was created , in the HH-mm-ss-fff format
  • {export-id} - the ID of the export
For example, an export download file for an audit logs grid could be named audit-logs-2023-01-27-12-29-40-843-24.zip.
Important:

Time columns in exported reports are expressed in the tenant's timezone.

Important considerations on API exports

  • The $select, $top, $skip, $orderBy, and $count keywords in our export API are not supported, and we strongly advise that you avoid using them. Please use appropriate filters instead.
  • Report entries are only sorted by Id, i.e. $orderBy=Id. Any other parameters used for the $orderBy keyword are ignored.
  • Filtering through a $filter= structure only allows the fields marked as available in the table.
  • Using any of the unsupported fields, as described in the following tables, returns a 400 error.

Fields supported for queue transactions API exports

The following table lists the fields that are available in the report generated by exporting queue transactions via API, and indicates whether these fields are allowed for filtering.

API field

Corresponding column in the exported report

Allows filtering

QueueDefinitionId

N/A

available

Status

Status

available

ReviewStatus

Revision

available

Reference

Reference

available

ProcessingExceptionType

Exception

available

DueDate

N/A

not available

DueDateAbs

Deadline (absolute)

not available

Priority

Priority

available

RobotName

Robot

not available

DeferDate

N/A

not available

DeferDateAbs

Postpone (absolute)

not available

StartProcessing

N/A

available

StartProcessingAbs

Started (absolute)

not available

EndProcessing

N/A

available

EndProcessingAbs

Ended (absolute)

not available

SecondsInPreviousAttempts

Transaction Execution Time

not available

AncestorId

AncestorId

not available

AncestorUniqueKey

AncestorUniqueKey

not available

RetryNumber

Retry No.

not available

ManualAncestorId

Manual AncestorId

not available

ManualAncestorUniqueKey

Manual AncestorUniqueKey

not available

ManualRetryNumber

Manual Retry No.

not available

UniqueKey

UniqueKey

not available

SpecificData

Specific data

not available

Key

Key

not available

ReviewerName

Reviewer Name

not available

ProcessingExceptionReason

Exception Reason

not available

Output

Output

not available

RobotId

N/A

available

ReviewerUserId

N/A

available

Analytics

Analytics Data

not available

CreationTime

N/A

available

CreationTimeAbs

Created (absolute)

not available

ProgressProgress

not available

Id

Id

available

Fields supported for audit logs API exports

The following table lists the fields that are available in the report generated by exporting audit logs via API, and indicates whether these fields are allowed for filtering.

API field

Corresponding column in the exported report

Allows filtering

Parameter

N/A

available

DisplayName

N/A

available

Action

Action

available

Component

Component

available

UserId

N/A

available

ExecutionTime

N/A

available

OperationText

Operation

not available

ExecutionTimeAbs

Time (absolute)

not available

ServiceName

N/A

not available

MethodName

N/A

not available

EntityId

N/A

not available

UserType

N/A

not available

UserIsDeleted

N/A

not available

ExternalClientId

N/A

not available

UserName

User

not available

Fields supported for robot logs API exports

The following table lists the fields that are available in the report generated by exporting robot logs via API, and indicates whether these fields are allowed for filtering.

API field

Corresponding column in the exported report

Allows filtering

JobKey

N/A

available

TimeStamp

Time (absolute)

available

Level

Level

available

ProcessName

Process

available

HostMachineName

Hostname

available

WindowsIdentity

Host Identity

available

Message

Message

available

RawMessage

N/A

not available

RobotName

Robot Name

available

MachineId

N/A

not available

MachineKey

N/A

available

RuntimeType

N/A

not available

Fields supported for jobs API exports

API field

Corresponding column in the exported report

Allows filtering

CreationTime

N/A

available

SourceType

N/A

available

State

State

available

SpecificPriorityValue

Priority

available

HostMachineName

Hostname

available

LocalSystemAccount

Host Identity

available

MachineName

Machine

not available

Key

Key

not available

JobPriority

N/A

not available

ReleaseName

Process

not available

RobotName

Robot

not available

MachineScope

N/A

not available

EnvironmentName

Environment

not available

Type

Job type

not available

RuntimeType

Runtime type/license

not available

StartTime

N/A

available

StartTimeAbs

Started (absolute)

not available

EndTime

N/A

available

EndTimeAbs

Ended (absolute)

not available

ProcessType

N/A

not available

Source

Source

not available

CreationTimeAbs

Created (absolute)

not available

ServerlessJobType

N/A

not available

StartingScheduleId

N/A

available

Release

N/A

not available

Machine

N/A

not available

Robot

N/A

not available

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.