跳轉到主要內容
Business Processing Reporting 會顯示文件的處理成效,並為稽核提供端到端的交易追蹤能力。Warehouse 會擷取所有交易(已完成與處理中),以便在商業智慧工具中進行分析與視覺化呈現。資料會保留 12 個月,方便在特定期間內進行分析與稽核。 會追蹤下列資料:
  • 交易 ID。
  • 技能 ID 與版本。
  • 以步驟為單位的處理路徑:
    • 步驟類型
    • 步驟名稱
    • 步驟開始與結束的日期與時間
    • 持續時間(秒)
  • 手動審核人員的名稱與電子郵件。
  • 文件與處理作業的註冊 Parameter。
**注意:**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 現在為必填欄位。
  • 新增欄位:sendEmailNotification (true/false) - 當報表可供下載時,向提出報表請求的使用者傳送電子郵件通知。
在最終結果 (/api/reporting/v2/exports/transaction-steps/{{requestId}}/result/{fileIndex}) 下載的 CSV 檔案中,新增了兩個欄位:
  • DocumentsCount:處理作業中已處理文件的數量。
  • PagesCount:處理作業中已處理頁面的數量。
請繼續閱讀以下內容,以了解 v2 端點的運作方式。

下載資料報表

注意: 只有具有 Tenant AdministratorProcessing Supervisor 角色的使用者才能從 Warehouse 下載資料報表。欲了解更多資訊,請參閱角色為基礎的存取控制。
您可以使用 Vantage API 以 CSV 檔案格式從 Warehouse 取得資料。為此,請傳送一個 POST 請求至下列資源: 請求本文中應在 filters 物件內包含下列屬性:
  • skillId:要下載其處理作業之 skill 的 ID。選填。
  • transactionId:用於篩選的處理作業 ID。選填。
  • startDate:要下載處理作業期間的第一天(範例格式:2022-01-07T13:03:38,時間必須為 UTC)。必填。
  • endDate:要下載處理作業期間的最後一天(範例格式:2022-09-07T13:03:38,時間必須為 UTC)。選填。
  • sendEmailNotification:是否傳送電子郵件給建立報表請求的使用者,以通知其報表已可供下載。選填。
{
  "filters": {
    "skillId": "d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae",
    "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "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 當報表已產生後,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"
  }
}
若要下載產生的報表檔案,請對下列位址發出 GET 請求,再次傳入 requestId,並加入 fileIndex(檔案以 0 為起始的索引值)。例如,如果 "totalFileCount": 3,則可用的檔案索引為 0、1 和 2。 以下是 CSV 回應的範例:
SkillIdSkillVersionSkillNameTransactionIdStepNameStepTypeManualReviewOperatorNameManualReviewOperatorEmailStartedUtcCompletedUtcStatusDurationDocumentsCountPagesCountdocument_SourceFileNamedocument_SourceTypetransaction_App
d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae1Redaction Test6d7e9eeb-86e3-4952-8e29-3f76b3fae59fInputInput11/17/2025 19:37:5211/17/2025 19:38:01FinishedSuccessfully9Invoice CA_2.pdfPublicAPIPublicAPI
d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae1Redaction Test6d7e9eeb-86e3-4952-8e29-3f76b3fae59fOCROcr11/17/2025 19:38:0211/17/2025 19:38:17FinishedSuccessfully15Invoice CA_2.pdfPublicAPIPublicAPI
d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae1Redaction Test6d7e9eeb-86e3-4952-8e29-3f76b3fae59fClassifyClassification11/17/2025 19:38:1711/17/2025 19:38:20FinishedSuccessfully3Invoice CA_2.pdfPublicAPIPublicAPI
d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae1Redaction Test6d7e9eeb-86e3-4952-8e29-3f76b3fae59fExtractExtraction11/17/2025 19:38:2111/17/2025 19:38:44FinishedSuccessfully23Invoice CA_2.pdfPublicAPIPublicAPI
d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae1Redaction Test6d7e9eeb-86e3-4952-8e29-3f76b3fae59fOutputOutput11/17/2025 19:38:4711/17/2025 19:39:01Failed13Invoice CA_2.pdfPublicAPIPublicAPI

回應結構

CSV 檔案中的每一列都代表在單一處理作業上所執行的一項操作。例如,匯入文件、辨識或手動審核。對於 Warehouse 中的每項操作,其詳細資料都會儲存在欄位中:
ColumnDescription
SkillId技能的 ID。
SkillVersion技能的版本。
SkillName技能的名稱。
TransactionId處理作業的 ID。
StepName事件名稱;若為流程技能,則為活動名稱。
StepType事件的類型。可能的值:
- Input(適用於所有技能類型)
- Ocr(適用於 OCR 技能或包含 OCR 活動的流程技能)
- Classification(適用於分類技能或包含 Classification 活動的流程技能)
- Extraction(適用於所有技能類型)
- Condition(適用於包含 Condition 活動的流程技能)
- CustomActivity(適用於包含 Custom 活動的流程技能)
- WaitingForManualReview(適用於包含 Manual Review 活動的流程技能)。處理作業等待手動審核的時間長度
- ManualReview(適用於包含 Manual Review 活動的流程技能)。作業人員正在驗證處理作業的時間長度
- Output(適用於所有技能類型)
ManualReviewOperatorName手動審核作業人員的名稱。
ManualReviewOperatorEmail手動審核作業人員的電子郵件地址。
StartedUtc事件開始時間(UTC)。例如,5/3/2022 1:59:02 PM。
CompletedUtc事件結束時間(UTC)。
Status事件的狀態。可能的值:
- Processing
- Finished Successfully
- Canceled
- Failed
Duration事件的持續時間(秒)。
DocumentsCount處理作業中已處理文件的數量。
PagesCount處理作業中已處理頁面的數量。
document_*, transaction_*傳遞以進行處理的文件或處理作業參數。標頭中的文件參數會加上 document_ 前綴,處理作業參數會加上 transaction_ 前綴。例如,document_SourceFileName。如果一個處理作業包含多個文件,其參數名稱相同但值不同,Warehouse 會列出此參數所有以逗號分隔的唯一值。例如,一個處理作業中的所有檔案名稱。
整理後的資料會在請求完成後保留 2 週。以 CSV 格式取得的資料可以在任何 BI 工具中進一步分析。

取得報表請求清單

若要取得在指定時間區間內建立的報表請求清單,請對以下端點執行 GET 請求,其中 createdFromcreatedTo 為日期範圍,而 statusFilter 則為下列其中一個值:NewQueuedProcessingSucceededFailedCancelled。這在遺失請求 ID 時特別有用。 回應內容包含報表請求的陣列。
{
  "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"
      }
    }
  ]
}