リアルタイムのデータ エクスポートのデータ モデル

概要

システムの変更はすべて、JSON 形式で記録されたイベントで表されます。

次のイベントの種類がサポートされています。

• ジョブを示すイベント:
  • job.created
  • job.started
  • job.stopped
  • job.pending
  • job.completed
  • job.faulted
  • job.stopping
  • job.terminating
• キュー アイテムを示すイベント:
  • queueitem.added
  • queueItem.deferred
  • queueItem.reviewStatusChanged
  • queueItem.retried
  • queueItem.updated
  • queueItem.transactionAbandoned
  • queueItem.transactionCompleted
  • queueItem.transactionFailed
  • queueItem.transactionRetried
  • queueItem.transactionStarted
    注:

    以下のフィールドが [ queueItem.deferred ] イベントと [ queueItem.reviewStatusChanged ] イベントから削除されます。

    • 固有データ
    • SpecificContent
    • 出力
• マシンを示すイベント:
  • machine.created
  • machine.updated
  • machine.deleted
  • machineSession.status
  • machine.assign
  • machine.unassign
• ロボット ログを記述するイベントです。
  • robotlog

異なるイベントは、異なるエンティティおよびシステムの変更を表すため、内容 (JSON フィールド) も異なります。

イベントの形式とスキーマ

各イベントは JSON 形式で提供され、以下があります。

• イベント固有の本文
• 共通フィールド
• メタデータ

理解を深めるために、次の例で job.created イベントを確認してください。この例は、読みやすくするために、各セクションを説明する改行とコメントで書式設定されています。実際のイベントにはこの形式はなく、1 行の文字列として配信されます。

{
    /*********************
            event-specific body
    **********************/
    "body": {
        "Job": {
            "Key": "<job-key>",
            "CreationTime": null,
            "State": "Pending",
            "StartTime": "<job-start-time>",
            "EndTime": null,
            "ProcessName": "<process-name>",
          "DisplayName": "<display-name>",
            "RobotName": "<robot-name>",
            "HostMachineName": "<host-machine-name>"
        },
    /*********************
            common fields
    **********************/
        "EventType": "job.started",
        "SchemaVersion": "0.0.1",
        "Timestamp": "<timestamp>",
        "TenantKey": "<tenant-key>",
        "TenantName": "<tenant-name>",
        "FolderName": "<folder-name>",
        "FullFolderPath": "<folder-path>",
        "FolderKey": "<folder-key>"
        },
    /*********************
            metadata
    **********************/
    "x-opt-sequence-number": <sequence-number>,
    "x-opt-offset": "<offset>",
    "x-opt-enqueued-time": <enqueued-time>,
    "Diagnostic-Id": "<diagnostic-id>"
}

共通フィールド

共通フィールドはすべてのイベントに表示されます。

名前	入力	説明
イベントの種類	string	イベントの種類です。
SchemaVersion	string	スキーマのバージョンです。バージョンが異なると、サポートされるイベントの種類やフィールドが異なる可能性があります。
Timestamp	timestamp	イベントの UTC タイムスタンプです。
TenantKey	Guid	イベントを生成したテナントの一意の識別子です。
テナント名	string	イベントを生成したテナントの名前です。
フォルダー名	string	イベントが生成された Orchestrator フォルダーの名前です。
FullFolderPath	string	フォルダーが別のフォルダーのサブフォルダーである場合、このフィールドにはフル パスが表示されます。
FolderKey	Guid	フォルダーの一意の識別子です。

{
    "EventType": "queueItem.transactionCompleted",
    "SchemaVersion": "0.0.1",
    "Timestamp": "<timestamp>",
    "TenantKey": "<tenant-key>",
    "TenantName": "<tenant-name>",
    "FolderName": "<folder-name>",
    "FullFolderPath": "<folder-path>",
    "FolderKey": "<folder-key>"
}

ジョブイベント

名前	入力	説明
キー	Guid	ジョブの一意の識別子です。
作成時刻	timestamp	ジョブが作成された日時を示すタイムスタンプです。
開始時刻	timestamp	ジョブが開始した日時を示すタイムスタンプです。
終了時刻	timestamp	ジョブが完了した日時を示すタイムスタンプです。
ステート	string	ジョブのステートです。サポートされている値: Pending Running Stopping Terminating Faulted Successful Stopped Suspended Resumed
プロセス名	string	ジョブの作成元のパッケージの名前です。
表示名	string	Orchestrator でプロセスに指定した名前です。
ロボット名	string	ジョブを実行しているロボットの名前です。
ホスト マシン名	string	ジョブが実行されているマシンです。

{
    "body": {
        "Job": {
        "Key": "<job-key>",
        "CreationTime": "<creation-time>",
        "State": "Running",
        "StartTime": "<start-time>",
        "EndTime": null,
        "ProcessName": "<process-name>",
        "DisplayName": "<display-name>",
        "RobotName": "<robot-name>",
        "HostMachineName": "<host-machine-name>",
    },
    ... common fields ...
    "EventType": "job.started",
    ... more common fields ...
}

QueueItem イベント

名前	入力	説明
QueueItem	JSON オブジェクト
キー	Guid	キュー アイテムの一意の識別子です。
QueueDefinitionId	number	キュー アイテムが属するキューの数値識別子です。
ステータス	string	キュー アイテムのステータスです。サポートされている値: New InProgress Failed Successful Abandoned Retried Deleted Unknown
レビュー ステータス	string	キュー アイテムのレビュー ステータスです。サポートされている値: None InReview Verified Retried Unknown
期限日	datetime	アイテムが処理されなければならない最遅の日時です。
優先度	string	キュー アイテムの優先度です。サポートされている値: High Normal Low Unknown
作成時刻	datetime	キュー アイテムが作成された日時を示すタイムスタンプです。
処理の開始時刻	datetime	キュー アイテムが処理を開始した日時を示すタイムスタンプです。
処理の終了時刻	datetime	キュー アイテムの処理が (成功か失敗かにかかわらず) 完了した日時を示すタイムスタンプです。
DefferDate	datetime	アイテムが処理可能な最短の日時です。空白の場合は、アイテムを可能な限り早く処理できます。
過去の試行 (秒)	number	失敗した最後の処理試行が継続した秒数です。
リトライ回数	number	このキュー アイテムが処理された回数です。
進行状況	string	開発者が UiPath Studio で追加した String 型のファイルです。ビジネス フローの進行状況を追跡するために使用されます。
分析データ	string	開発者が Studio で [トランザクションのステータスを設定] アクティビティを使用して追加した Analytics プロパティのデータを含むキーと値のペアのコレクションです。
出力	string	開発者が Studio で [トランザクションのステータスを設定] アクティビティを使用して追加した Output プロパティのデータを含むキーと値のペアのコレクションです。
固有データ	string	開発者が [トランザクションのステータスを設定] アクティビティを介して Studio で追加した Specific Content プロパティのデータを含む、キーと値のペアのコレクションです。UiPath Studio の [キュー アイテムを追加] アクティビティで設定した、カスタム データを含む、キーと値の組み合わせの集合です。
作成ジョブ ID	number	キュー アイテムを作成したジョブの ID です。
実行ジョブ ID	number	キュー アイテムを実行したジョブの ID です。
ProcessExceptionReason	string	キュー アイテムの処理が失敗した理由の概要です。
ProcessExceptionDetails	string	キュー アイテムの失敗に関するその他の詳細です。
ProcessExceptionType	string	エラーで終了したキュー アイテムの場合、このフィールドにエラー (例外) の種類が表示されます。サポートされている値: ApplicationException BusinessException None
キュー	JSON オブジェクト
キー	Guid	キューの一意の識別子です。
名前	string	キューの名前です。
説明	string	キューに関する追加情報です。キューを特定しやすくします。
MaxNumberOfRetries	number	このキュー内のアイテムの処理に失敗した場合にアイテムをリトライできる回数です。
EnforceUniqueReference	boolean	Item Reference フィールドがキュー アイテムごとに一意であるかどうかを示します。
SlaInMinutes	number	キュー SLA を表す整数値 (分単位) です。
RiskSlaInMinutes	number	キューのリスク SLA を表す整数値 (分単位) です。

{
    "body": {
        "QueueItem": {
            "Key": "<queue-item-key>",
            "QueueDefinitionId": <queue-definition-id>,
          "Status": "New",
            "ReviewStatus": "None",
            "DueDate": "<due-date>",
            "Priority": "High",
            "CreationTime": "<creation-time>",
            "StartProcessing": "<start-processing-time>",
            "EndProcessing": null,
            "DefferDate": "<deffer-time>",
            "SecondsInPreviousAttempt": 0,
            "RetryNumber": 1,
            "Progress": "<progress>",
            "ProcessExceptionReason": null,
            "ProcessExceptionDetails": null,
            "ProcessExceptionType": null
        },
        "Queue": {
            "Key": "<queue-key>",
            "Name": "<queue-name>",
            "Description": "<queue-description>",
            "MaxNumberOfRetries": 1,
            "EnforceUniqueReference": false,
            "SlaInMinutes": 0,
            "RiskSlaInMinutes": 0
        },
    },
    ... common fields ...
}

マシン セッション イベント

名前	入力	説明
マシン キー	Guid	マシンの一意の識別子です。
マシン名	string	マシンのカスタム名です。
ホスト マシン名	string	UiPath マシンにマッピングされているホスト マシンの名前です。
サービス ユーザー名	string	マシン上の Robot サービスの実行に使用されているユーザーの名前です。
マシンのステータス	string	マシンのステータスです。サポートされている値: Available Busy Disconnected Unknown
Timestamp	datetime	マシン セッション イベントのタイムスタンプです。
IsUnresponsive	boolean	マシンが Orchestrator からの接続に応答するかどうかを確認するためのチェックです。サポートされている値: true false A machine can still be available but be unresponsive. Once it is unresponsive for ten minutes, it becomes disconnected or unknown.

{
    "body": {
        "MachineSession": {
            "MachineKey": "<machine-key>",
            "MachineName": "<machine-name>",
            "MachineId": <machine-id>,
            "HostMachineName": "<host-machine-name>",
            "ServiceUsername": "<service-username>",
            "MachineStatus": "Disconnected",
            "ReportingTime": "<reporting-time>",
            "IsUnresponsive": false
        },
        ... common fields ...
        "EventType":"machineSession.status",
        ... more common fields ...
}

マシン イベント

名前	入力	説明
AutomationCloudSlots	number	実行時に確保される Automation Cloud<b>TM</b> のスロットの数です。
HeadlessSlots	number	実行時に確保されるヘッドレス スロットの数です。
マシン ID	number	マシンの整数 ID です。Orchestrator インスタンスごとに一意です。
マシン キー	Guid	マシンの一意の識別子です。
マシン名	string	マシンのカスタム名です。
NonProductionSlots	number	実行時に確保される NonProduction スロットの数です。
UnattendedSlots	number	実行時に確保される Unattended スロットの数です。

{
    "body": {
        "Machine": {
            "MachineName": "<machine-name>",
            "MachineKey": "<machine-key>",
            "NonProductionSlots": 1,
            "HeadlessSlots": 0,
            "AutomationCloudSlots": 0,
            "UnattendedSlots": 0
        },
        ... common fields ...
}

マシンの割り当てイベント

名前	入力	値
マシン キー	Guid	マシンの一意の識別子です。
マシン名	string	マシンのカスタム名です。

{
    "body": {
        "MachineAssign": {
            "MachineKey": "<machine-key>",
            "MachineName": "<machine-name>"
        },
        "EventType": "machine.unassigned",
        ... common fields ...
    }
}

ロボット ログ

名前	入力	説明
ファイル名	string	実行されている .xaml ファイルの名前です。
initiatedBy	string	実行のソースです。予想される値: Assistant Studio StudioX StudioPro Orchestrator CommandLine RobotAPI
ジョブ ID	string/guid	JobKey です。ジョブの一意の識別子です。
レベル	string	ログのログ レベルです。予想される値: Trace Info Warn Error Fatal
ログの種類	string	ロボット ログの種類です。予想される値: User Default Error Business ExecutionStep BusinessIteration Info Security Technical
マシン ID	number	マシンの整数 ID です。Orchestrator インスタンスごとに一意です。
マシン名	string	マシンのカスタム名です。
メッセージ	string	ロボット ログのメッセージです。予想される値: execution started execution ended custom message
プロセス名	string	ロボットが実行しているプロセスの名前です。
プロセス バージョン	string	プロセスのバージョンです。
ロボット名	string	ロボットの名前です。
Windows ID	string	記録されたアクションを実行したユーザーの名前です。
ProcessingExceptionReason	string	例外の理由です。Transaction End ログにのみ存在します。
プロセスの例外の種類	string	例外の種類です。Transaction End ログにのみ存在します。予想される値: ApplicationException BusinessException
queueItemPriority	string	キュー アイテムの優先度です。Transaction End ログにのみ存在します。予想される値: High Normal Low
queueItemReviewStatus	string	キュー アイテムのレビュー ステータスです。Transaction End ログにのみ存在します。予想される値: InReview Verified Reported Retried
QueueName	string	ロボットがキュー アイテムを実行するキュー名です。
トランザクション実行時間	number	トランザクションの実行時間 (秒単位) です。キュー アイテムを処理する場合にのみ値があります。
トランザクション ID	string/Guid	トランザクションの一意のキーです。キュー アイテムを処理する場合にのみ値があります。
transactionState	string	トランザクションのステートです。キュー アイテムを処理する場合にのみ値があります。予想される値: Started Ended Postponed
transactionStatus	string	トランザクションのステータスです。キュー アイテムを処理する場合にのみ値があります。予想される値: ApplicationException Start SystemError Failed BusinessException Success InProgress
totalExecutionTimeInSeconds	number	トランザクションの実行時間 (秒単位) です。キュー アイテムを処理する場合にのみ値があります。
アクティビティ情報	JSON	アクティビティ情報の JSON です。DisplayName、State (Faulted、Closed、Executing)、Activity、および Arguments が含まれます。
Timestamp	datetime	イベントが生成された時刻です。
マシン キー	Guid	ジョブを実行しているマシンの一意の識別子です。
カスタム フィールド	JSON	Studio で [ログ フィールドを追加] アクティビティに定義したフィールドを含む JSON です。

{
    "body": {
        "Level": "Info",
        "MachineKey": "<machine-key>",
        "RobotLog": {
            "Message": "Transaction Ended",
            "Level": "Information",
            "LogType": "Default",
            "CustomFields": {
                "Custom fields 1": "value1",
                "Custom fields 2": 2,
            },
        "TimeStamp": "<timestamp>",
        "Fingerprint": "<fingerprint>",
        "WindowsIdentity": "<windows-identity>",
        "MachineName": "<machine-name>",
        "FileName": "<filename>",
        "TransactionExecutionTime": 0.6733966,
        "QueueItemPriority": "Normal",
        "ProcessingExceptionReason": "",
        "TransactionStatus": "Successful",
        "QueueName": "<queue-name>",
        "TransactionState": "Ended",
        "ProcessingExceptionType": "",
        "TransactionId": "<transaction-id>",
        "QueueItemReviewStatus": "None",
        "ProcessName": "<process-name>",
        "ProcessVersion": "1.0.6",
        "JobId": "<job-id>",
        "RobotName": "<robot-name>",
        "MachineId": <machine-id>,
        "OrganizationUnitId": <organization-unit-id>
        },
        "EventType": "robotlog",
        ... common fields ...
    },
}