メインコンテンツへスキップ
ビジネス処理レポートは、ドキュメントがどのように処理されているかを示し、監査のためのエンドツーエンドのトランザクション追跡を提供します。Warehouse は、すべてのトランザクション (完了済みおよび処理中) を蓄積し、ビジネスインテリジェンスツールでの分析および可視化を可能にします。データは 12 か月間保持され、所定の期間にわたる分析および監査を実行できます。 次のデータが追跡されます:
  • トランザクション ID.
  • Skill ID とバージョン.
  • 手順ごとの処理パス:
    • ステップの種類
    • 名前
    • ステップの開始および終了の日時
    • 所要時間 (秒)
  • 手動確認オペレーター (手動確認オペレーター) の名前とメールアドレス.
  • ドキュメントおよびトランザクションの登録パラメータ.
Warehouse は、設定により一度も実行されないアクティビティ内のドキュメント処理イベントに関する情報は保存しません。たとえば、Assemble by files の設定は Vantage のデフォルト動作に対応しているため、このアクティビティでのドキュメント処理はワークフロー内でスキップされます。

​
v1 から v2 への移行

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

​
新機能

リクエスト（/api/reporting/v2/exports/transaction-steps）では、次の変更があります。
  • フィルタがクエリパラメーターからリクエストボディ（filters JSON オブジェクト）に移動しました。
  • filters オブジェクト内で指定する startDate が必須になりました。
  • 新しい field: sendEmailNotification（true/false） - レポートのダウンロード準備が整ったときに、レポートをリクエストしたユーザーにメール通知を送信します。
最終結果（/api/reporting/v2/exports/transaction-steps/{{requestId}}/result/{fileIndex}）としてダウンロードされる CSV ファイルには、新たに 2 つの列が追加されました。
  • DocumentsCount: トランザクション内で処理された Document の数。
  • PagesCount: トランザクション内で処理されたページの数。
以下で、v2 エンドポイントの動作について詳しく説明します。

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

Warehouse からデータレポートをダウンロードできるのは、Tenant Administrator および Processing Supervisor のロールを持つユーザーのみです。詳細については、ロールベースアクセス制御 (RBAC) を参照してください。
Vantage API を使用して、Warehouse から CSV ファイル形式でデータを取得できます。これを行うには、次のリソースに POST リクエストを送信します。 リクエストボディには、filters オブジェクト内に次のプロパティを含める必要があります。
  • skillId. ダウンロード対象とするトランザクションが属する Skill の ID。任意。
  • transactionId. フィルタ対象とするトランザクションの ID。任意。
  • startDate. トランザクションをダウンロードする期間の開始日 (形式の例: 2022-01-07T13:03:38、時刻は UTC) 。必須。
  • endDate. トランザクションをダウンロードする期間の終了日 (形式の例: 2022-09-07T13:03:38、時刻は UTC) 。任意。
  • sendEmailNotification. レポートリクエストを作成したユーザーに、レポートをダウンロードできる状態になったことを通知するメールを送信します。任意。
レポートリクエストは非同期で実行されるため、レスポンスではリクエストのステータスを確認するために使用する requestId が返されます。 結果：
レポートのステータスを確認するには、GET リクエストに requestId を指定します。 レポートが作成されると、status が “Succeeded” になり、totalFileCount にダウンロード可能なファイル数が表示されます。
生成されたレポートファイルをダウンロードするには、requestId を再度渡し、さらにファイルのゼロ始まりインデックスである fileIndex を追加して、以下のエンドポイントに対して GET リクエストを行います。たとえば、"totalFileCount": 3 の場合、利用可能なファイルインデックスは 0、1、2 となります。 CSV レスポンスの例を次に示します。

​
レスポンス構造

CSV ファイルの各行は、トランザクションに対して実行された 1 つの操作を表します。たとえば、ドキュメントのインポート、認識、または手動確認などです。Warehouse では各操作について、その詳細が次の列として保存されます。 準備されたデータは、リクエストの完了後 2 週間保存されます。CSV 形式で取得したデータは、任意の BI ツールでさらに分析できます。

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

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