- Getting started
- Best practices
- Tenant
- About the Tenant Context
- Searching for Resources in a Tenant
- 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
- Audit
- Cloud robots
- Folders Context
- Automations
- Processes
- Jobs
- Apps
- Triggers
- Logs
- Monitoring
- Queues
- Assets
- Storage Buckets
- Test Suite - Orchestrator
- Resource Catalog Service
- Authentication
- Integrations
- Classic Robots
- Troubleshooting
Exporting grids in the background
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.
.csv, which makes it data-analysis compliant, and you can access it from the My Reports page.
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
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.
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.Exportto 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.
- You must use the API endpoints for the corresponding Orchestrator object. For example, use
.csv file of the grid filtered data.
To download exports to your device, you need to add the storage domains to your allowlist. More info here.
.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-ddformat - {export_timestamp} - the time when the export was created , in the
HH-mm-ss-fffformat - {export-id} - the ID of the export
audit-logs-2023-01-27-12-29-40-843-24.zip.
Time columns in exported reports are expressed in the tenant's timezone.
-
The
$select,$top,$skip,$orderBy, andkeywords in our export API are not supported, and we strongly advise that you avoid using them. Please use appropriate filters instead.$count -
Report entries are only sorted by
Id, i.e.$orderBy=Id. Any other parameters used for the$orderBykeyword 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.
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 |
|---|---|---|
|
|
N/A |
|
|
|
Status |
|
|
|
Revision |
|
|
|
Reference |
|
|
|
Exception |
|
|
|
N/A |
|
|
|
Deadline (absolute) |
|
|
|
Priority |
|
|
|
Robot |
|
|
|
N/A |
|
|
|
Postpone (absolute) |
|
|
|
N/A |
|
|
|
Started (absolute) |
|
|
|
N/A |
|
|
|
Ended (absolute) |
|
|
|
Transaction Execution Time |
|
|
|
AncestorId |
|
|
|
AncestorUniqueKey |
|
|
|
Retry No. |
|
|
|
Manual AncestorId |
|
|
|
Manual AncestorUniqueKey |
|
|
|
Manual Retry No. |
|
|
|
UniqueKey |
|
|
|
Specific data |
|
|
|
Key |
|
|
|
Reviewer Name |
|
|
|
Exception Reason |
|
|
|
Output |
|
|
|
N/A |
|
|
|
N/A |
|
|
|
Analytics Data |
|
|
|
N/A |
|
CreationTimeAbs |
Created (absolute) |
|
Progress | Progress |
|
|
|
Id |
|
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 |
|---|---|---|
|
|
N/A |
|
|
|
N/A |
|
|
|
Action |
|
|
|
Component |
|
|
|
N/A |
|
|
|
N/A |
|
|
|
Operation |
|
|
|
Time (absolute) |
|
|
|
N/A |
|
|
|
N/A |
|
|
|
N/A |
|
|
|
N/A |
|
|
|
N/A |
|
|
|
N/A |
|
|
|
User |
|
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 |
|---|---|---|
|
|
N/A |
|
|
|
Time (absolute) |
|
|
|
Level |
|
|
|
Process |
|
|
|
Hostname |
|
|
|
Host Identity |
|
|
|
Message |
|
|
|
N/A |
|
|
|
Robot Name |
|
|
|
N/A |
|
|
|
N/A |
|
|
|
N/A |
|
|
API field |
Corresponding column in the exported report |
Allows filtering |
|---|---|---|
|
|
N/A |
|
|
|
N/A |
|
|
|
State |
|
|
|
Priority |
|
|
|
Hostname |
|
|
|
Host Identity |
|
|
|
Machine |
|
|
|
Key |
|
|
|
N/A |
|
|
|
Process |
|
|
|
Robot |
|
|
|
N/A |
|
|
|
Environment |
|
|
|
Job type |
|
|
|
Runtime type/license |
|
|
|
N/A |
|
|
|
Started (absolute) |
|
|
|
N/A |
|
|
|
Ended (absolute) |
|
|
|
N/A |
|
|
|
Source |
|
|
|
Created (absolute) |
|
|
|
N/A |
|
|
|
N/A |
|
|
|
N/A |
|
|
|
N/A |
|
|
|
N/A |
|
All exports you create are logged on the Alerts page, provided you have the proper permissions. Completed exports are logged with the Info severity, while failed exports are logged with the Error severity.
By default, you receive alert emails about completed or failed exports. You can unsubscribe from these alerts by navigating to the Alert Preferences page and unselecting the Export option.
