ビジネス処理レポート

ビジネス処理レポートは、ドキュメントがどのように処理されているかを示し、監査のためのエンドツーエンドのトランザクション追跡を提供します。Warehouse は、すべてのトランザクション（完了済みおよび処理中）を蓄積し、ビジネスインテリジェンスツールでの分析および可視化を可能にします。データは 12 か月間保持され、所定の期間にわたる分析および監査を実行できます。次のデータが追跡されます:

トランザクション ID
Skill ID とバージョン
手順ごとの処理パス:
- ステップの種類
- 名前
- ステップの開始および終了の日時
- 所要時間（秒）
Manual Review Operator（手動レビューオペレーター）の名前とメールアドレス
ドキュメントおよびトランザクションの登録パラメータ

注: Warehouse は、設定により一度も実行されないアクティビティ内のドキュメント処理イベントに関する情報は保存しません。たとえば、Assemble by files の設定は Vantage のデフォルト動作に対応しているため、このアクティビティでのドキュメント処理はワークフロー内でスキップされます。

v1 から v2 への移行

Vantage 3.0 以降では、transaction-steps v1 エンドポイントは非推奨になっています。後方互換性を確保するため、v2 エンドポイントは、エンドポイント名の変更とクエリパラメーターがリクエストボディに移動した点を除き、同様に動作します。v2 エンドポイントは、大容量データ要求をより適切に処理するため、非同期モデルに移行しています。レポートの作成をリクエストした後、そのレポートが準備完了になるまでステータスをポーリングできます。完了したら、結果をダウンロードできます。

// v1: クエリパラメータを使用した同期呼び出し(1回)
1. GET {{baseUrl}}/api/reporting/v1/transaction-steps?skillId=ABCD&startDate=2025-11-01&endDate=2025-11-18

// v2: 非同期呼び出し(複数回)
1. POST {base_url}/api/reporting/v2/exports/transaction-steps
{
  "filters": {
    "skillId": "d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae",
    "startDate": "2025-11-03T17:19:54.386Z",
    "endDate": "2025-11-17T20:05:26.097Z"
  },
  "sendEmailNotification": true
}
// リクエストIDを受信

2. GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps/{{requestId}}/status

// ステータスが "Succeeded" になったら、レポートファイルをダウンロード
3. GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps/{{requestId}}/result/{fileIndex}

v2 エンドポイントの動作の詳細については、以下をお読みください。

データレポートのダウンロード

注記: Warehouse からデータレポートをダウンロードできるのは、Tenant Administrator および Processing Supervisor ロールを持つユーザーのみです。詳細については、Role-Based Access Control を参照してください。

Vantage API を使用して、Warehouse から CSV ファイル形式でデータを取得できます。これを行うには、次のリソースに対して POST リクエストを送信します。

POST {base_url}/api/reporting/v2/exports/transaction-steps

リクエストボディには、filters オブジェクト内に次のプロパティを含める必要があります。

skillId。トランザクションをダウンロードする対象となるスキルの ID。
startDate。トランザクションをダウンロードする対象期間の開始日時（例: 2022-01-07T13:03:38、時刻は UTC で指定）。
endDate。トランザクションをダウンロードする対象期間の終了日時（例: 2022-09-07T13:03:38、時刻は UTC で指定）。
sendEmailNotification。レポートリクエストを作成したユーザーに、レポートのダウンロード準備が完了したことを知らせるメールを送信します。

{
  "filters": {
    "skillId": "d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae",
    "startDate": "2025-11-03T17:19:54.386Z",
    "endDate": "2025-11-17T20:05:26.097Z"
  },
  "sendEmailNotification": true
}

レポートリクエストは非同期で実行されるため、レスポンスにはリクエストのステータスを確認するための requestId が返されます。結果：

{
  "requestId": "8f772512-099c-4050-8dd3-6c4d7af69747”
}

レポートのステータスを確認するには、GET リクエストに requestId を指定します。

GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps/{{requestId}}/status

レポートの作成が完了すると、status が “Succeeded” となり、totalFileCount にダウンロード可能なファイル数が表示されます。

{
  "status": "Succeeded",
  "totalFileCount": 3,
  "filters": {
      "skillId": "d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae",
      "startDate": "2025-11-03T17:19:54.386+00:00",
      "endDate": "2025-11-17T20:05:26.097+00:00"
  }
}

生成されたレポートファイルをダウンロードするには、requestId をもう一度渡し、さらにファイルのゼロ始まりインデックスである fileIndex を指定して、以下に対して GET リクエストを送信します。たとえば "totalFileCount": 3 の場合、利用可能なファイルインデックスは 0、1、2 となります。

GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps/{{requestId}}/result/{fileIndex}

CSV レスポンスのサンプルは次のとおりです。

SkillId	SkillVersion	SkillName	TransactionId	StepName	StepType	StartedUtc	CompletedUtc	Status	Duration	document_SourceFileName	document_SourceType	transaction_App
d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae	1	Redaction Test	6d7e9eeb-86e3-4952-8e29-3f76b3fae59f	Input	Input	11/17/2025 19:37:52	11/17/2025 19:38:01	FinishedSuccessfully	9	Invoice CA_2.pdf	PublicAPI	PublicAPI
d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae	1	Redaction Test	6d7e9eeb-86e3-4952-8e29-3f76b3fae59f	OCR	Ocr	11/17/2025 19:38:02	11/17/2025 19:38:17	FinishedSuccessfully	15	Invoice CA_2.pdf	PublicAPI	PublicAPI
d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae	1	Redaction Test	6d7e9eeb-86e3-4952-8e29-3f76b3fae59f	Classify	Classification	11/17/2025 19:38:17	11/17/2025 19:38:20	FinishedSuccessfully	3	Invoice CA_2.pdf	PublicAPI	PublicAPI
d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae	1	Redaction Test	6d7e9eeb-86e3-4952-8e29-3f76b3fae59f	Extract	Extraction	11/17/2025 19:38:21	11/17/2025 19:38:44	FinishedSuccessfully	23	Invoice CA_2.pdf	PublicAPI	PublicAPI
d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae	1	Redaction Test	6d7e9eeb-86e3-4952-8e29-3f76b3fae59f	Output	Output	11/17/2025 19:38:47	11/17/2025 19:39:01	Failed	13	Invoice CA_2.pdf	PublicAPI	PublicAPI

レスポンス構造

CSV ファイルの各行は、トランザクションに対して実行された 1 つの操作を表します。たとえば、ドキュメントのインポート、認識、または手動確認などです。Warehouse では各操作について、その詳細が次の列として保存されます。

Column	Description
`SkillId`	スキル ID。
`SkillVersion`	スキルのバージョン。
`SkillName`	スキル名。
`TransactionId`	トランザクション ID。
`StepName`	イベント名、または Process スキルの場合はアクティビティ名。
`StepType`	イベントの種類。取りうる値: - Input (すべてのスキルタイプで利用可能) - Ocr (OCR スキル、または OCR アクティビティを追加した Process スキルで利用可能) - Classification (Classification スキル、または Classification アクティビティを追加した Process スキルで利用可能) - Extraction (すべてのスキルタイプで利用可能) - Condition (Condition アクティビティを追加した Process スキルで利用可能) - CustomActivity (Custom アクティビティを追加した Process スキルで利用可能) - WaitingForManualReview (Manual Review アクティビティを追加した Process スキルで利用可能)。トランザクションが手動確認待ちとなっている時間 - ManualReview (Manual Review アクティビティを追加した Process スキルで利用可能)。オペレーターがトランザクションを確認している時間 - Output (すべてのスキルタイプで利用可能)
`ManualReviewOperatorName`	Manual Review オペレーター名。
`ManualReviewOperatorEmail`	Manual Review オペレーターのメールアドレス。
`StartedUtc`	イベントの開始時刻 (UTC)。例: 5/3/2022 1:59:02 PM。
`CompletedUtc`	イベントの終了時刻 (UTC)。
`Status`	イベントのステータス。取りうる値: - Processing - Finished Successfully - Canceled - Failed
`Duration`	イベントの継続時間 (秒単位)。
`document_`, `transaction_`	処理に渡されたドキュメントまたはトランザクションのパラメーター。ヘッダーのドキュメントパラメーターには接頭辞 document_ が、トランザクションパラメーターには接頭辞 transaction_ が追加されます。例: document_SourceFileName。トランザクションに、同じ名前で値のみが異なるパラメーターを持つドキュメントが含まれている場合、Warehouse はこのパラメーターの一意なすべての値をカンマ区切りで一覧表示します。たとえば、トランザクション内のすべてのファイル名が対象となります。

準備されたデータは、リクエストの完了後 2 週間保存されます。CSV 形式で取得したデータは、任意の BI ツールでさらに分析できます。

レポート要求の一覧を取得する

指定した期間内に作成されたレポート要求の一覧を取得するには、次のエンドポイントに対して GET リクエストを送信します。このとき、createdFrom と createdTo は日付範囲を表し、statusFilter には次のいずれかの値を指定します: New、Queued、Processing、Succeeded、Failed、Cancelled。これは、リクエスト ID をどこかに紛失してしまった場合などに役立ちます。

GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps?statusFilter=Succeeded&createdFrom=2025-11-05&createdTo=2025-11-17

レスポンスにはレポート要求の配列が含まれます。

{
  "requests": [
    {
      "requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "New",
      "completedUtc": "2025-11-18T22:22:00.294Z",
      "createdUtc": "2025-11-18T22:20:49.294Z",
      "totalFileCount": "2",
      "filters": {
        "skillId": "d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae",
        "startDate": "2025-11-03T17:19:54.386+00:00",
        "endDate": "2025-11-17T20:05:26.097+00:00"
      }
    },
    {
      "requestId": "48293032-5717-4562-b3fc-2c963f66afa6",
      "status": "Succeeded",
      "completedUtc": "2025-12-18T22:22:00.294Z",
      "createdUtc": "2025-12-18T22:20:49.294Z",
      "totalFileCount": "4",
      "filters": {
        "skillId": "dk3ioda-bcc6-4129-bfd1-c1e37ee3efae",
        "startDate": "2025-11-03T17:19:54.386+00:00",
        "endDate": "2025-11-17T20:05:26.097+00:00"
      }
    }
  ]
}

入門

出力ファイル形式

Vantage Processing REST API

Vantage レポーティング API

v1 から v2 への移行

データレポートのダウンロード

レスポンス構造

レポート要求の一覧を取得する

入門

出力ファイル形式

Vantage Processing REST API

Vantage レポーティング API

​v1 から v2 への移行

​データレポートのダウンロード

​レスポンス構造

​レポート要求の一覧を取得する

v1 から v2 への移行

データレポートのダウンロード

レスポンス構造

レポート要求の一覧を取得する