Zum Hauptinhalt springen
Berichte zur Geschäftsverarbeitung zeigen, wie gut Dokumente verarbeitet werden, und bieten eine durchgängige Vorgangsverfolgung für Prüfzwecke. Das Warehouse erfasst alle Vorgänge – 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:
  • Vorgangs-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 Manual-Review-Operators.
  • Dokument- und Vorgangsregistrierungsparameter.
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.

​
Was ist neu?

In der Anforderung (/api/reporting/v2/exports/transaction-steps):
  • Filter wurden von Abfrageparametern in den Request-Body verschoben (filters-JSON-Objekt).
  • startDate, das innerhalb des filters-Objekts angegeben wird, ist jetzt erforderlich.
  • Neues Feld: sendEmailNotification (true/false) – sendet eine E-Mail an den Benutzer der Berichtsanforderung, sobald der Bericht zum Herunterladen bereitsteht.
In den heruntergeladenen CSV-Dateien des Endergebnisses (/api/reporting/v2/exports/transaction-steps/{{requestId}}/result/{fileIndex}) wurden zwei Spalten hinzugefügt:
  • DocumentsCount: Die Anzahl der verarbeiteten Dokumente in einem Vorgang.
  • PagesCount: Die Anzahl der verarbeiteten Seiten in einem Vorgang.
Lesen Sie weiter, um unten Details zur Funktionsweise des v2-Endpunkts zu erhalten.

​
Herunterladen eines Datenberichts

Nur Benutzer mit den Rollen Tenant Administrator und Processing Supervisor können einen Datenbericht aus dem Warehouse herunterladen. Weitere Informationen finden Sie unter Rollenbasierte Zugriffssteuerung.
Sie können Daten aus dem Warehouse in einer CSV-Datei mithilfe der Vantage-API abrufen. Senden Sie dazu eine POST-Anfrage an die folgende Ressource: Ein Request-Body sollte innerhalb eines filters-Objekts die folgenden Eigenschaften enthalten:
  • skillId. Die ID des Skills, dessen Vorgänge heruntergeladen werden sollen. Optional.
  • transactionId. Die ID des Vorgangs, nach dem gefiltert werden soll. Optional.
  • startDate. Der erste Tag des Zeitraums (Beispielformat: 2022-01-07T13:03:38, die Uhrzeit muss in UTC angegeben sein), für den die Vorgänge heruntergeladen werden sollen. Erforderlich.
  • endDate. Der letzte Tag des Zeitraums (Beispielformat: 2022-09-07T13:03:38, die Uhrzeit muss in UTC angegeben sein), für den die Vorgänge heruntergeladen werden sollen. Optional.
  • sendEmailNotification. Sendet eine E-Mail an den Benutzer, der die Berichtsanforderung erstellt hat, und informiert ihn darüber, dass der Bericht zum Download bereitsteht. Optional.
Berichtsanforderungen werden asynchron ausgeführt, daher enthält die Antwort eine requestId, mit der Sie den Status der Anforderung prüfen können. Ergebnis:
Um den Status des Berichts zu prüfen, geben Sie die requestId in der GET-Anforderung an: Sobald der Report erstellt wurde, lautet der status “Succeeded” und totalFileCount gibt die Anzahl der Dateien an, die zum Herunterladen bereitstehen:
Um die resultierenden Berichtdateien herunterzuladen, senden Sie eine GET-Anfrage an die folgende Ressource und übergeben dabei erneut die requestId. Ergänzen Sie außerdem den fileIndex, also den nullbasierten Index der Datei. Wenn zum Beispiel "totalFileCount": 3 lautet, sind die verfügbaren Dateiindizes 0, 1 und 2. So sieht eine CSV-Antwort beispielhaft aus:

​
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: 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. Die Antwort enthält ein Array von Reportinganforderungen.