Zum Hauptinhalt springen
Berichte zur Geschäftsverarbeitung zeigen, wie gut Dokumente verarbeitet werden, und bieten eine durchgängige Transaktionsverfolgung für Prüfzwecke. Das Warehouse erfasst alle Transaktionen – abgeschlossene und laufende – zur Analyse und Visualisierung in Business-Intelligence-Tools. Die Daten werden 12 Monate lang aufbewahrt, wodurch Analysen und Prüfungen über definierte Zeiträume hinweg möglich sind. Die folgenden Daten werden nachverfolgt:
  • Transaktions-ID.
  • Skill-ID und -Version.
  • Verarbeitungsweg nach Schritten:
    • Schritttypen
    • Namen
    • Datum und Uhrzeit des Beginns und Endes des Schritts
    • Dauer (in Sekunden)
  • Name und E-Mail-Adresse des Bearbeiters der manuellen Prüfung.
  • Dokument- und Transaktionsregistrierungsparameter.
Hinweis: Das Warehouse speichert keine Informationen über Ereignisse der Dokumentverarbeitung in Aktivitäten, die gemäß ihren Einstellungen niemals ausgeführt werden. Beispielsweise entspricht die Einstellung Assemble by files dem Standardverhalten von Vantage, daher wird die Dokumentverarbeitung in dieser Aktivität in einem Workflow übersprungen.

Migration von v1 auf v2

In Vantage 3.0 und höher wurde der transaction-steps-v1-Endpunkt als veraltet eingestuft. Aus Gründen der Abwärtskompatibilität funktioniert der v2-Endpunkt ähnlich, mit einem geänderten Endpunktnamen und Abfrageparametern, die in den Request-Body verschoben wurden. Der v2-Endpunkt verwendet nun ein asynchrones Modell, um große Datenmengen besser zu verarbeiten. Nachdem ein Bericht angefordert wurde, können Sie den Status abfragen, bis der Bericht bereitsteht. Sobald die Verarbeitung abgeschlossen ist, können Sie die Ergebnisse herunterladen.
// v1: Ein synchroner Aufruf mit Abfrageparametern
1. GET {{baseUrl}}/api/reporting/v1/transaction-steps?skillId=ABCD&startDate=2025-11-01&endDate=2025-11-18

// v2: Mehrere asynchrone Aufrufe
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
}
// Anfrage-ID erhalten

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

// Sobald Status = „Succeeded", Berichtsdateien herunterladen
3. GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps/{{requestId}}/result/{fileIndex}
Im Folgenden finden Sie Details dazu, wie der v2-Endpunkt funktioniert.

Herunterladen eines Datenberichts

Hinweis: Nur Benutzer mit den Rollen Tenant Administrator und Processing Supervisor können einen Datenbericht aus dem Warehouse herunterladen. Weitere Informationen finden Sie unter „Role-Based Access Control“.
Sie können Daten aus dem Warehouse im CSV-Format mithilfe der Vantage API abrufen. Senden Sie dazu eine POST-Anfrage an die folgende Ressource:
POST {base_url}/api/reporting/v2/exports/transaction-steps
Ein Request-Body sollte innerhalb eines filters-Objekts die folgenden Eigenschaften enthalten:
  • skillId. Die ID des Skills, dessen Transaktionen heruntergeladen werden sollen.
  • startDate. Der erste Tag des Zeitraums (Beispielformat: 2022-01-07T13:03:38, die Zeit muss in UTC angegeben sein), für den die Transaktionen heruntergeladen werden sollen.
  • endDate. Der letzte Tag des Zeitraums (Beispielformat: 2022-09-07T13:03:38, die Zeit muss in UTC angegeben sein), für den die Transaktionen heruntergeladen werden sollen.
  • sendEmailNotification. Sendet eine E-Mail an den Benutzer, der die Berichtsanforderung erstellt hat, und informiert ihn darüber, dass der Bericht zum Herunterladen bereitsteht.
{
  "filters": {
    "skillId": "d0e27b2d-bcc6-4129-bfd1-c1e37ee3efae",
    "startDate": "2025-11-03T17:19:54.386Z",
    "endDate": "2025-11-17T20:05:26.097Z"
  },
  "sendEmailNotification": true
}
Berichtsanforderungen werden asynchron ausgeführt, sodass in der Antwort eine requestId zurückgegeben wird, mit der Sie den Status der Anforderung überprüfen können. Ergebnis:
{
  "requestId": "8f772512-099c-4050-8dd3-6c4d7af69747”
}
Um den Status des Berichts zu prüfen, geben Sie die requestId in der GET-Anfrage an:
GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps/{{requestId}}/status
Nachdem der Bericht erstellt wurde, hat status den Wert “Succeeded” und totalFileCount zeigt die Anzahl der Dateien, die zum Herunterladen bereitstehen:
{
  "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"
  }
}
Um die erzeugten Berichtsdateien herunterzuladen, senden Sie eine GET-Anfrage an Folgendes. Übergeben Sie dabei erneut die requestId und fügen Sie den fileIndex hinzu, also den nullbasierten Index der Datei. Wenn zum Beispiel "totalFileCount": 3 ist, sind die verfügbaren Dateiindizes 0, 1 und 2.
GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps/{{requestId}}/result/{fileIndex}
Hier ist ein Beispiel, wie die CSV-Antwort aussieht:
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

Antwortstruktur

Jede Zeile in einer CSV-Datei ist ein Vorgang, der für eine Transaktion ausgeführt wurde, z. B. der Import von Dokumenten, die Erkennung oder die manuelle Überprüfung. Für jeden Vorgang im Warehouse werden die Details in Spalten gespeichert:
SpalteBeschreibung
SkillIdDie Skill-ID.
SkillVersionDie Version des Skills.
SkillNameDer Name des Skills.
TransactionIdDie ID der Transaktion.
StepNameDer Name des Ereignisses oder der Name der Aktivität im Fall des Process Skills.
StepTypeDer Typ des Ereignisses. Mögliche Werte:
- Input (verfügbar für alle Skill-Typen)
- Ocr (verfügbar für OCR-Skills oder Process Skills mit hinzugefügter OCR-Aktivität)
- Classification (verfügbar für Classification-Skills oder Process Skills mit hinzugefügter Classification-Aktivität)
- Extraction (verfügbar für alle Skill-Typen)
- Condition (verfügbar für Process Skills mit hinzugefügter Condition-Aktivität)
- CustomActivity (verfügbar für Process Skills mit hinzugefügter Custom-Aktivität)
- WaitingForManualReview (verfügbar für Process Skills mit hinzugefügter Manual Review-Aktivität). Die Zeitspanne, während der eine Transaktion auf die manuelle Überprüfung wartet
- ManualReview (verfügbar für Process Skills mit hinzugefügter Manual Review-Aktivität). Die Zeitspanne, während der der Operator eine Transaktion überprüft
- Output (verfügbar für alle Skill-Typen)
ManualReviewOperatorNameDer Name des Manual-Review-Operators.
ManualReviewOperatorEmailDie E-Mail-Adresse des Manual-Review-Operators.
StartedUtcStartzeit des Ereignisses (UTC). Zum Beispiel 5/3/2022 1:59:02 PM.
CompletedUtcEndzeit des Ereignisses (UTC).
StatusDer Status des Ereignisses. Mögliche Werte:
- Processing
- Finished Successfully
- Canceled
- Failed
DurationDauer des Ereignisses (in Sekunden).
document_*, transaction_*Die Dokument- oder Transaktionsparameter, die zur Verarbeitung übergeben wurden. Dem Header von Dokumentparametern wird das Präfix document_ vorangestellt und den Transaktionsparametern das Präfix transaction_. Zum Beispiel document_SourceFileName. Wenn eine Transaktion Dokumente mit Parametern enthält, die im Namen identisch, aber im Wert unterschiedlich sind, listet das Warehouse alle eindeutigen Werte dieses Parameters, durch Kommas getrennt, auf – zum Beispiel alle Dateinamen innerhalb einer Transaktion.
Die aufbereiteten Daten werden 2 Wochen lang nach Abschluss der Anfrage gespeichert. Daten, die im CSV-Format abgerufen wurden, können anschließend in jedem BI-Tool weiter analysiert werden.

Abrufen einer Liste von Reporting-Anforderungen

Um die Liste der Reporting-Anforderungen abzurufen, die innerhalb eines festgelegten Zeitraums gestellt wurden, senden Sie eine GET-Anfrage an den folgenden Endpunkt, wobei createdFrom und createdTo den Datumsbereich angeben und statusFilter einer der folgenden Werte ist: New,Queued,Processing,Succeeded,Failed oder Cancelled. Dies ist hilfreich, falls Anforderungs-IDs nicht mehr auffindbar sind.
GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps?statusFilter=Succeeded&createdFrom=2025-11-05&createdTo=2025-11-17
Die Antwort enthält ein Array von Reportinganforderungen.
{
  "requests": [
    {
      "requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "Neu",
      "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": "Erfolgreich",
      "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"
      }
    }
  ]
}