グリッドをバックグラウンドでエクスポートする

概要

Orchestrator のオブジェクトはそれぞれの専用ページでグリッドに表示されています。グリッドには、そのオブジェクトのステータスの説明に役立つさまざまな列が含まれています。

これらのグリッドをエクスポートしてデータのバッチを取得し、後でダッシュボードやレポートの作成に使用できます。エクスポートの操作はバックグラウンドで行われます。ダウンロードの準備ができると通知が届くので、エクスポートの完了を待たずに Orchestrator の操作を続けることができます。

ダウンロード形式は、データ分析を行いやすい .csv です。ダウンロード データには [マイ レポート] ページからアクセスできます。

エクスポートできる Orchestrator オブジェクト

グリッドをエクスポートできる Orchestrator オブジェクトは以下のとおりです。

• テナント レベル
  • 監査ログ
  • Test Automation の監査ログ
• フォルダー レベル
  • キューのトランザクション
  • ログ
  • ジョブ

エクスポートされたレポート

[エクスポート] ボタンをクリックすると、[マイ レポート] ページにグリッドのコピーが作成されます。エクスポートの開始時と、エクスポートの完了時、またはエクスポートが失敗した場合は、ポップアップが表示されます。

エクスポートが完了すると、データがエクスポートされたことを知らせるアラートが送信されます。アラートの表示権限がある場合、レポートはブラウザーの既定のダウンロード場所に、バックグラウンドで自動的にダウンロードされます。ただし、[マイ レポート] ページにアクセスして好きな時にレポートをダウンロードすることもできます。

[マイ レポート] ページには、過去 168 時間 (7 日 x 24 時間) に作成したエクスポートのみが表示されます。168 時間を経過したエクスポートは完全に削除されます。たとえば、ある月の 1 日の 00:00 に作成されたエクスポートは、7 日の 23:59 まで利用できます。

エクスポートを確認するには、上部のナビゲーション バーにある [マイ レポート] アイコンをクリックします。

図 1. マイ レポート

エクスポートで確認できるプロパティは以下のとおりです。

• エクスポートの種類 - 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	N/A
Status	Status
ReviewStatus	リビジョン
Reference	参照
ProcessingExceptionType	Exception
DueDate	N/A
DueDateAbs	処理期限 (絶対時間)
Priority	優先度
RobotName	Robot
DeferDate	N/A
DeferDateAbs	延期 (絶対時間)
StartProcessing	N/A
StartProcessingAbs	開始時刻 (絶対時間)
EndProcessing	N/A
EndProcessingAbs	終了時刻 (絶対時間)
SecondsInPreviousAttempts	トランザクション実行時間
AncestorId	前回の試行 ID
AncestorUniqueKey	AncestorUniqueKey
RetryNumber	リトライ回数
ManualAncestorId	手動の親 ID
ManualAncestorUniqueKey	ManualAncestorUniqueKey
ManualRetryNumber	手動リトライ回数
UniqueKey	UniqueKey
SpecificData	固有データ
Key	キー
ReviewerName	レビュー担当者名
ProcessingExceptionReason	例外の理由
Output	出力
RobotId	N/A
ReviewerUserId	N/A
Analytics	分析データ
CreationTime	N/A
CreationTimeAbs	作成時刻 (絶対時間)
Progress	進行状況
Id	ID

監査ログの API エクスポートでサポートされるフィールド

以下の表に、API を使用して監査ログをエクスポートすることで生成されるレポートで利用可能なフィールドと、そのフィールドをフィルター処理できるかどうかを示します。

API フィールド	エクスポートされたレポートの対応する列	フィルター処理可能
Parameter	N/A
DisplayName	N/A
Action	操作
Component	コンポーネント
UserId	N/A
ExecutionTime	N/A
OperationText	操作
ExecutionTimeAbs	時刻 (絶対時間)
ServiceName	N/A
MethodName	N/A
EntityId	N/A
UserType	N/A
UserIsDeleted	N/A
ExternalClientId	N/A
UserName	ユーザー (User)

ロボット ログの API エクスポートでサポートされるフィールド

以下の表に、API を使用してロボット ログをエクスポートすることで生成されるレポートで利用可能なフィールドと、そのフィールドをフィルター処理できるかどうかを示します。

API フィールド	エクスポートされたレポートの対応する列	フィルター処理可能
JobKey	N/A
TimeStamp	時刻 (絶対時間)
Level	レベル
ProcessName	プロセス
HostMachineName	ホスト名
WindowsIdentity	ホスト ID
Message	メッセージ
RawMessage	N/A
RobotName	ロボット名
MachineId	N/A
MachineKey	N/A
RuntimeType	N/A

ジョブの API エクスポートでサポートされるフィールド

API フィールド	エクスポートされたレポートの対応する列	フィルター処理可能
CreationTime	N/A
SourceType	N/A
State	ステート
SpecificPriorityValue	優先度
HostMachineName	ホスト名
LocalSystemAccount	ホスト ID
MachineName	マシン
Key	キー
JobPriority	N/A
ReleaseName	プロセス
RobotName	Robot
MachineScope	N/A
EnvironmentName	環境
Type	ジョブの種類
RuntimeType	ランタイムの種類/ライセンス
StartTime	N/A
StartTimeAbs	開始時刻 (絶対時間)
EndTime	N/A
EndTimeAbs	終了時刻 (絶対時間)
ProcessType	N/A
Source	ソース
CreationTimeAbs	作成時刻 (絶対時間)
ServerlessJobType	N/A
StartingScheduleId	N/A
Release	N/A
Machine	N/A
Robot	N/A

アラートをエクスポートする

適切な権限があれば、作成したすべてのエクスポートは [アラート] ページに記録されます。完了したエクスポートは重要度 Info でログ記録され、失敗したエクスポートは重要度 Error でログ記録されます。

既定では、完了または失敗したエクスポートに関するアラート メールが届きます。アラートの配信を停止するには、[アラートの設定] ページに移動して [エクスポート] オプションの選択を解除します。