Orchestrator 用户指南
在后台导出网格
概述
Orchestrator 对象显示在其专用页面上的网格中，其中包含有助于描述该对象状态的各种列。
您可以导出这些网格，以获取一批数据，以便日后用于创建仪表板或报告。导出操作在后台进行，这意味着您可以继续与 Orchestrator 交互，而无需等待导出完成，因为系统会在下载准备就绪时通知您。
The download format is .csv, which makes it data-analysis compliant, and you can access it from the My Reports page.
可导出的 Orchestrator 对象
您可以导出以下 Orchestrator 对象的网格：
- 在租户级别
- 审核日志
- 测试自动化审核日志
- 在文件夹级别
- 队列事务
- 日志
- 作业
导出的报告
单击“导出”按钮会在“我的报告”页面中创建网格的副本。导出开始以及完成或是否完成时，系统会弹出一个窗口通知您。
导出完成后，您会收到一条警示，告知您数据已导出。如果您具有“查看警示”权限，则系统会在后台自动将报告下载到浏览器的默认下载位置。但是，您也可以在方便时访问“我的报告”页面并下载报告。
“我的报告”页面仅显示您在过去 168 小时（7 天 x 24 小时）内创建的导出。超过 168 小时的导出将被永久删除。例如，在第 1 日 00:00 创建的导出文件在第 7 日 23:59 之前可用。
要查看导出，请选择“租户”旁边的垂直省略号 (⋮) 按钮，然后从列表中选择“我的报告”。
图 1. 我的报告
您可以查看导出的以下属性：
- Export type - refers to the Orchestrator object
- Created on - the relative timestamp of when you created the export
- 创建时间（绝对）- 创建导出时的确切时间戳。绝对时间戳以租户时区呈现。对于触发器，下一次运行时将在触发器时区呈现，该时区可能与租户时区不同。
- 有效期 - 从列表中删除导出的日期。系统会在指定日期的 00:00 删除报告。 这仅在导出报告后显示。
- 大小 - 导出的大小。这仅在导出报告后显示。
- Status - the status of the export operation:
- New - the export is in progress.
- Completed - the export finished.
- 失败 - 导出失败。这可能是由于 SQL 超时或存储容量低而造成的。您需要手动重试导出。解析导出数据的计算时间最长为 15 分钟。在此时间之后，导出将会失败。在重试导出之前，请对您的数据应用其他筛选器。
重要提示：
为防止包含大量数据的导出操作失败，请执行以下操作：
- You must use the API endpoints for the corresponding Orchestrator object. For example, use
/odata/AuditLogs/UiPath.Server.Configuration.OData.Exportto export Audit logs. - 就频率和检索数据量而言，生成的导出量可能会影响租户的性能。如果性能受到影响，我们可能会限制或阻止此类请求，以确保您的自动化不受此行为的影响。
- 应用筛选条件以减少导出的数据量。
- You must use the API endpoints for the corresponding Orchestrator object. For example, use
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.
.zip 和 .csv 文件使用以下命名约定命名：
| 导出的对象类型 | 下载文件命名约定 |
|---|---|
| 队列事务 | {queue-name}-items-{export-date}-{export-timestamp}-{export-id} 如果队列名称包含无效字符 (`\ / : * ? " < > |
| 审核日志 | audit-logs-{export-date}-{export-timestamp}-{export-id} |
| 日志 | robot-logs-{export-date}-{export-timestamp}-{export-id} |
| 作业 | jobs-{job_folder_key}-{export-date}-{export-timestamp}-{export-id} |
其中：
- {queue_name} - 包含已导出队列项目的队列名称
- {job_folder_key} - 从中导出作业网格的文件夹 ID
- {export_date} - 创建导出的日期，采用
yyyy-MM-dd格式 - {export_timestamp} - 创建导出的时间，格式为
HH-mm-ss-fff - {export-id} - 导出的 ID
例如，可以将审核日志网格的导出下载文件命名为 audit-logs-2023-01-27-12-29-40-843-24.zip。
导出的报告中的时间列以租户的时区表示。
API 导出的重要注意事项
- 不支持我们的导出 API 中的
$select、$top、$skip、$orderBy, and $count关键字，我们强烈建议您避免使用这些关键字。请使用适当的筛选条件。 - 报告条目仅按
Id排序，即$orderBy=Id。用于$orderBy关键字的任何其他参数都将被忽略。 - 如要筛选
$filter=结构，则仅允许使用表格中标记为可用的字段。 - 如下表所述，使用任何不支持的字段将返回 400 错误。
队列事务 API 导出支持的字段
下表列出了通过 API 导出队列事务生成报告中的可用字段，并指明是否允许对这些字段进行筛选。
| API 字段 | 导出的报告中的相应列 | 允许筛选 |
|---|---|---|
QueueDefinitionId | 不适用 | ✅ |
Status | 状态 | ✅ |
ReviewStatus | 修订 | ✅ |
Reference | 参考 | ✅ |
ProcessingExceptionType | 异常 | ✅ |
DueDate | 不适用 | ❌ |
DueDateAbs | 截止日期 (绝对值) | ❌ |
Priority | 优先级 | ✅ |
RobotName | Robot (机器人) | ❌ |
DeferDate | 不适用 | ❌ |
DeferDateAbs | 延期 (绝对值) | ❌ |
StartProcessing | 不适用 | ✅ |
StartProcessingAbs | 已开始 (绝对值) | ❌ |
EndProcessing | 不适用 | ✅ |
EndProcessingAbs | 已结束 (绝对值) | ❌ |
SecondsInPreviousAttempts | 事务执行时间 | ❌ |
AncestorId | 上级 ID | ❌ |
AncestorUniqueKey | AncestorUniqueKey | ❌ |
RetryNumber | 重试次数 | ❌ |
ManualAncestorId | 手动上级 ID | ❌ |
ManualAncestorUniqueKey | 手动上级唯一密钥 | ❌ |
ManualRetryNumber | 手动重试次数 | ❌ |
UniqueKey | UniqueKey | ❌ |
SpecificData | 特定数据 | ❌ |
Key | 密钥 | ❌ |
ReviewerName | 审核人姓名 | ❌ |
ProcessingExceptionReason | 异常原因 | ❌ |
Output | 输出 | ❌ |
RobotId | 不适用 | ✅ |
ReviewerUserId | 不适用 | ✅ |
Analytics | 分析数据 | ❌ |
CreationTime | 不适用 | ✅ |
CreationTimeAbs | 已创建 (绝对值) | ❌ |
审核日志 API 导出支持的字段
下表列出了通过 API 导出审核日志生成报告中的可用字段，并指明是否允许对这些字段进行筛选。
| API 字段 | 导出的报告中的相应列 | 允许筛选 |
|---|---|---|
Parameter | 不适用 | ✅ |
DisplayName | 不适用 | ✅ |
Action | 操作 | ✅ |
Component | 组件 | ✅ |
UserId | 不适用 | ✅ |
ExecutionTime | 不适用 | ✅ |
OperationText | 操作 | ❌ |
ExecutionTimeAbs | 时间 (绝对值) | ❌ |
ServiceName | 不适用 | ❌ |
MethodName | 不适用 | ❌ |
EntityId | 不适用 | ❌ |
UserType | 不适用 | ❌ |
UserIsDeleted | 不适用 | ❌ |
ExternalClientId | 不适用 | ❌ |
UserName | 用户 | ❌ |
支持机器人日志 API 导出的字段
下表列出了通过用 API 导出机器人日志而生成的报告中的可用字段，并指明是否允许对这些字段进行筛选。
| API 字段 | 导出的报告中的相应列 | 允许筛选 |
|---|---|---|
JobKey | 不适用 | ✅ |
TimeStamp | 时间 (绝对值) | ✅ |
Level | 级别 | ✅ |
ProcessName | 流程 | ✅ |
HostMachineName | 主机名 | ✅ |
WindowsIdentity | 主机身份 | ✅ |
Message | 消息 | ✅ |
RawMessage | 不适用 | ❌ |
RobotName | 机器人名称 | ✅ |
MachineId | 不适用 | ❌ |
MachineKey | 不适用 | ✅ |
RuntimeType | 不适用 | ❌ |
支持作业 API 导出的字段
| API 字段 | 导出的报告中的相应列 | 允许筛选 |
|---|---|---|
CreationTime | 不适用 | ✅ |
SourceType | 不适用 | ✅ |
State | 状态 | ✅ |
SpecificPriorityValue | 优先级 | ✅ |
HostMachineName | 主机名 | ✅ |
LocalSystemAccount | 主机身份 | ✅ |
MachineName | 计算机 | ❌ |
Key | 密钥 | ❌ |
JobPriority | 不适用 | ❌ |
ReleaseName | 流程 | ❌ |
RobotName | Robot (机器人) | ❌ |
MachineScope | 不适用 | ❌ |
EnvironmentName | 环境 | ❌ |
Type | 作业类型 | ❌ |
RuntimeType | Runtime 类型/许可证 | ❌ |
StartTime | 不适用 | ✅ |
StartTimeAbs | 已开始 (绝对值) | ❌ |
EndTime | 不适用 | ✅ |
EndTimeAbs | 已结束 (绝对值) | ❌ |
ProcessType | 不适用 | ❌ |
Source | 来源 | ❌ |
CreationTimeAbs | 已创建 (绝对值) | ❌ |
ServerlessJobType | 不适用 | ❌ |
StartingScheduleId | 不适用 | ✅ |
Release | 不适用 | ❌ |
Machine | 不适用 | ❌ |
Robot | 不适用 | ❌ |
导出警示
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.