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

Orchestrator 用户指南

Automation CloudAutomation Cloud Public SectorAutomation SuiteStandalone
上次更新日期 2024年11月22日

在后台导出网格

概述

Orchestrator 对象显示在其专用页面上的网格中,其中包含有助于描述该对象状态的各种列。

您可以导出这些网格,以获取一批数据,以便日后用于创建仪表板或报告。导出操作在后台进行,这意味着您可以继续与 Orchestrator 交互,而无需等待导出完成,因为系统会在下载准备就绪时通知您。

下载格式为 .csv,这使其符合数据分析要求,您可以从“我的报告”页面访问相关数据。

可导出的 Orchestrator 对象

您可以导出以下 Orchestrator 对象的网格:

  • 在租户级别
    • 审核日志
    • 测试自动化审核日志
  • 在文件夹级别
    • 队列事务
    • 日志
    • 作业

导出的报告

单击“导出”按钮会在“我的报告”页面中创建网格的副本。导出开始以及完成或是否完成时,系统会弹出一个窗口通知您。

导出完成后,您会收到一条警示,告知您数据已导出。如果您具有“查看警示”权限,则系统会在后台自动将报告下载到浏览器的默认下载位置。但是,您也可以在方便时访问“我的报告”页面并下载报告。

“我的报告”页面仅显示您在过去 168 小时(7 天 x 24 小时)内创建的导出。超过 168 小时的导出将被永久删除。例如,在第 1 日 00:00 创建的导出文件在第 7 日 23:59 之前可用。

要查看导出的内容,请单击顶部导航栏上的“我的报告”图标。



您可以查看导出的以下属性:

  • 导出类型 - 指的是 Orchestrator 对象
  • 创建时间 - 创建导出时的相对时间戳
  • 创建时间(绝对)- 创建导出时的确切时间戳。绝对时间戳以租户时区呈现。对于触发器,下一次运行时将在触发器时区呈现,该时区可能与租户时区不同。
  • 有效期 - 从列表中删除导出的日期。系统会在指定日期的 00:00 删除报告。

    这仅在导出报告后显示。

  • 大小 - 导出的大小。这仅在导出报告后显示。
  • “状态”- 导出操作的状态:

    • 新建 - 正在执行导出。
    • 已完成 - 导出已完成。
    • 失败 - 导出失败。这可能是由于 SQL 超时或存储空间不足。您需要手动重试导出。

      解决导出问题的计算时间最长为 15 分钟。 在此时间之后,导出将失败。 在重试导出之前,请对数据应用其他筛选器。

      重要提示:

      为防止包含大量数据的导出操作失败,请执行以下操作:

      • 必须使用相应 Orchestrator 对象的 API 端点。例如,使用 /odata/AuditLogs/UiPath.Server.Configuration.OData.Export 导出审核日志。
      • 就频率和检索数据量而言,生成的导出量可能会影响租户的性能。如果性能受到影响,我们可能会限制或阻止此类请求,以确保您的自动化不受此行为的影响。
      • 应用筛选条件以减少导出的数据量。
要将数据下载到您的设备,请单击所需报告的“下载”按钮。此操作使用设备上的默认下载位置。报告将作为存档下载,其中包含网格筛选数据的 .csv 文件。
.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

不适用

available

Status

状态

available

ReviewStatus

修订

available

Reference

参考

available

ProcessingExceptionType

异常

available

DueDate

不适用

不可用

DueDateAbs

截止日期 (绝对值)

不可用

Priority

优先级

available

RobotName

机器人

不可用

DeferDate

不适用

不可用

DeferDateAbs

延期 (绝对值)

不可用

StartProcessing

不适用

available

StartProcessingAbs

已开始 (绝对值)

不可用

EndProcessing

不适用

available

EndProcessingAbs

已结束 (绝对值)

不可用

SecondsInPreviousAttempts

事务执行时间

不可用

AncestorId

上级 ID

不可用

AncestorUniqueKey

AncestorUniqueKey

不可用

RetryNumber

重试次数

不可用

ManualAncestorId

手动上级 ID

不可用

ManualAncestorUniqueKey

手动上级唯一密钥

不可用

ManualRetryNumber

手动重试次数

不可用

UniqueKey

UniqueKey

不可用

SpecificData

特定数据

不可用

Key

密钥

不可用

ReviewerName

审核人姓名

不可用

ProcessingExceptionReason

异常原因

不可用

Output

输出

不可用

RobotId

不适用

available

ReviewerUserId

不适用

available

Analytics

分析数据

不可用

CreationTime

不适用

available

CreationTimeAbs

已创建 (绝对值)

不可用

Progress进度

不可用

Id

ID

available

审核日志 API 导出支持的字段

下表列出了通过 API 导出审核日志生成报告中的可用字段,并指明是否允许对这些字段进行筛选。

API 字段

导出的报告中的相应列

允许筛选

Parameter

不适用

available

DisplayName

不适用

available

Action

操作

available

Component

组件

available

UserId

不适用

available

ExecutionTime

不适用

available

OperationText

操作

不可用

ExecutionTimeAbs

时间 (绝对值)

不可用

ServiceName

不适用

不可用

MethodName

不适用

不可用

EntityId

不适用

不可用

UserType

不适用

不可用

UserIsDeleted

不适用

不可用

ExternalClientId

不适用

不可用

UserName

用户

不可用

支持机器人日志 API 导出的字段

下表列出了通过用 API 导出机器人日志而生成的报告中的可用字段,并指明是否允许对这些字段进行筛选。

API 字段

导出的报告中的相应列

允许筛选

JobKey

不适用

available

TimeStamp

时间 (绝对值)

available

Level

级别

available

ProcessName

流程

available

HostMachineName

主机名

available

WindowsIdentity

主机身份

available

Message

消息

available

RawMessage

不适用

不可用

RobotName

机器人名称

available

MachineId

不适用

不可用

MachineKey

不适用

available

RuntimeType

不适用

不可用

支持作业 API 导出的字段

API 字段

导出的报告中的相应列

允许筛选

CreationTime

不适用

available

SourceType

不适用

available

State

状态

available

SpecificPriorityValue

优先级

available

HostMachineName

主机名

available

LocalSystemAccount

主机身份

available

MachineName

计算机

不可用

Key

密钥

不可用

JobPriority

不适用

不可用

ReleaseName

流程

不可用

RobotName

机器人

不可用

MachineScope

不适用

不可用

EnvironmentName

环境

不可用

Type

作业类型

不可用

RuntimeType

Runtime 类型/许可证

不可用

StartTime

不适用

available

StartTimeAbs

已开始 (绝对值)

不可用

EndTime

不适用

available

EndTimeAbs

已结束 (绝对值)

不可用

ProcessType

不适用

不可用

Source

来源

不可用

CreationTimeAbs

已创建 (绝对值)

不可用

ServerlessJobType

不适用

不可用

StartingScheduleId

不适用

available

Release

不适用

不可用

Machine

不适用

不可用

Robot

不适用

不可用

导出警示

只要您拥有适当的权限,您创建的所有导出都将记录在“警示”页面上。已完成的导出将以“Info”严重性记录,而失败的导出则以“Error”严重性记录。

默认情况下,您会收到有关导出已完成或失败的警示电子邮件。您可以通过导航到“警示首选项”页面并取消选择“导出”选项来取消订阅这些警示。

此页面有帮助吗?

获取您需要的帮助
了解 RPA - 自动化课程
UiPath Community 论坛
Uipath Logo White
信任与安全
© 2005-2024 UiPath。保留所有权利。