Skip to main content
Business Processing Reporting is used to understand if the system copes with the processing of document well, as well as provide traceability for every transaction in the system so that you can audit on what was happening to a particular transaction throughout the entire business process. The Warehouse stores data about all transactions (both finished transactions and transactions in processing) so that it can be used for further analysis and visualization in business intelligence tools. Data is stored for 12 months, which allows you to analyze the business process and track data for specific periods of time. The following data is tracked:
  • Transaction ID.
  • Skill ID and version.
  • Processing path by steps:
    • Step types
    • Names
    • Date and time of the start and finish of the step
    • Duration (in seconds)
  • Manual Review Operator name and email.
  • Document and transaction registration parameters.
Note: The Warehouse does not store information about document processing events in activities that are never executed according to their settings. For example, the Assemble by files setting corresponds to the default behavior of Vantage, therefore document processing in this activity will be skipped in a workflow.

Downloading a data report

Note: Only users with the Tenant Administrator and Processing Supervisor role can download a data report from the Warehouse. For more information, see Role-Based Access Control.
You can obtain data from the Warehouse in a CSV file using the Vantage API. To do so, send a GET request to the following resource:
GET {base_url}/api/reporting/v1/transaction-steps
A request body should contain the following parameters:
  • skillId. The ID of the skill the transactions of which should be downloaded.
  • startDate. The first day of the period (sample formatting: 2022-01-07T13:03:38, time should be in UTC) for which the transactions should be downloaded.
  • endDate. The last day of the period (sample formatting: 2022-09-07T13:03:38, time should be in UTC) for which the transactions should be downloaded.
Each row in a CSV file is an operation performed on a transaction. For example, the import of documents, recognition, or manual review. For each operation in the Warehouse, its details are stored in columns:
ColumnDescription
SkillIdThe skill ID.
SkillVersionThe version of the skill.
SkillNameThe name of the skill.
TransactionIdID of the transaction.
StepNameThe name of the event or the name of the activity in case of the Process skill.
StepTypeThe type of event. Possible values:
- Input (available for all skill types)
- Ocr (available for OCR skills or Process skills with added OCR activity)
- Classification (available for Classification skills or Process skills with added Classification activity)
- Extraction (available for all skill types)
- Condition (available for Process skills with added Condition activity)
- CustomActivity (available for Process skills with added Custom activity)
- WaitingForManualReview (available for Process skills with added Manual Review activity). The amount of time during which a transaction is waiting for manual review
- ManualReview (available for Process skills with added Manual Review activity). The amount of time during which the Operator is verifying a transaction
- Output (available for all skill types)
ManualReviewOperatorNameThe name of the Manual Review Operator.
ManualReviewOperatorEmailThe email of the Manual Review Operator.
StartedUtcStart time of the event (UTC). For example, 5/3/2022 1:59:02 PM.
CompletedUtcEnd time of the event (UTC).
StatusThe status of the event. Possible values:
- Processing
- Finished Successfully
- Canceled
- Failed
DurationDuration of the event (in seconds).
document_*, transaction_*The document or transaction parameters passed for processing. The prefix document_ is added to document parameters in the header, and the transaction_ prefix is added to the transaction parameters. For example, document_SourceFileName. If a transaction contains documents with parameters identical in name but different in value, the Warehouse will list all unique values of this parameter separated by commas. For example, all filenames within a transaction.
Data obtained in CSV format may be further analyzed in any BI tool.