Vai al contenuto principale
La reportistica sull’elaborazione aziendale mostra l’efficacia con cui i documenti vengono elaborati e fornisce tracciabilità end-to-end delle transazioni a fini di audit. Il Warehouse acquisisce tutte le transazioni – completate e in corso – per l’analisi e la visualizzazione tramite strumenti di business intelligence. I dati vengono conservati per 12 mesi, consentendo analisi e attività di audit su periodi di tempo definiti. Vengono tracciati i seguenti dati:
  • ID transazione.
  • ID Skill e versione.
  • Percorso di elaborazione per fasi:
    • Tipologia di fase
    • Nomi delle fasi
    • Data e ora di inizio e fine della fase
    • Durata (in secondi)
  • Nome ed email dell’operatore di revisione manuale.
  • Parametri di registrazione del documento e della transazione.
Nota: Il Warehouse non memorizza informazioni sugli eventi di elaborazione dei documenti nelle attività che, in base alle relative impostazioni, non vengono mai eseguite. Ad esempio, l’impostazione “Assemble by files” corrisponde al comportamento predefinito di Vantage, pertanto l’elaborazione dei documenti in questa attività viene ignorata in un flusso di lavoro.

​
Migrazione da v1 a v2

In Vantage 3.0 e versioni successive, l’endpoint v1 transaction-steps è stato deprecato. Per garantire la compatibilità con le versioni precedenti, l’endpoint v2 funziona in modo analogo, con un cambio del nome dell’endpoint e i parametri di query spostati nel corpo della richiesta. L’endpoint v2 adotta un modello asincrono per gestire meglio le richieste con grandi volumi di dati. Dopo aver richiesto un report, puoi eseguire il polling dello stato finché il report non è pronto. Una volta completata l’elaborazione, puoi scaricare i risultati. 
// v1: One synchronous call with query parameters
1. GET {{baseUrl}}/api/reporting/v1/transaction-steps?skillId=ABCD&startDate=2025-11-01&endDate=2025-11-18

// v2: Multiple async calls
1. POST {base_url}/api/reporting/v2/exports/transaction-steps
{
  "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
}

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

// Una volta che lo stato = "Succeeded", scarica i file del report
3. GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps/{{requestId}}/result/{fileIndex}

​
Novità

Nella richiesta (/api/reporting/v2/exports/transaction-steps):
  • I filtri sono stati spostati dai parametri di query al corpo della richiesta (oggetto JSON filters).
  • startDate, specificato all’interno dell’oggetto filters, è ora obbligatorio.
  • Nuovo field: sendEmailNotification (true/false) - invia un’email all’utente che ha richiesto il report quando questo è pronto per il download.
Nei file CSV scaricati dal risultato finale (/api/reporting/v2/exports/transaction-steps/{{requestId}}/result/{fileIndex}), sono state aggiunte due colonne:
  • DocumentsCount: il numero di documenti elaborati in una transaction.
  • PagesCount: il numero di pagine elaborate in una transaction.
Continua a leggere di seguito per i dettagli su come funziona l’endpoint v2.

​
Download di un report sui dati

Nota: Solo gli utenti con i ruoli Tenant Administrator e Processing Supervisor possono scaricare un report sui dati dal Warehouse. Per ulteriori informazioni, vedere Controllo degli accessi basato sui ruoli.
È possibile ottenere i dati dal Warehouse in un file CSV utilizzando la Vantage API. A tale scopo, inviare una richiesta POST alla seguente risorsa: 
POST {base_url}/api/reporting/v2/exports/transaction-steps
Il corpo della richiesta deve includere le seguenti proprietà all’interno di un oggetto filters:
  • skillId. L’ID dello Skill le cui transaction devono essere scaricate. Facoltativo.
  • transactionId. L’ID della transaction su cui filtrare. Facoltativo.
  • startDate. Il primo giorno del periodo (esempio di formato: 2022-01-07T13:03:38, l’ora deve essere in UTC) per il quale devono essere scaricate le transaction. Obbligatorio.
  • endDate. L’ultimo giorno del periodo (esempio di formato: 2022-09-07T13:03:38, l’ora deve essere in UTC) per il quale devono essere scaricate le transaction. Facoltativo.
  • sendEmailNotification. Invia un’email all’utente che ha creato la richiesta di report per informarlo che il report è pronto per il download. Facoltativo.
{
  "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
}
Le richieste di report vengono eseguite in modo asincrono, quindi la risposta restituisce un requestId utilizzato per verificare lo stato della richiesta. Risultato: 
{
  "requestId": "8f772512-099c-4050-8dd3-6c4d7af69747”
}
Per verificare lo stato del report, invia il requestId nella richiesta GET: 
GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps/{{requestId}}/status
Quando il report è stato creato, il valore di status è “Succeeded” e totalFileCount indica il numero di file disponibili per il download: 
{
  "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"
  }
}
Per scaricare i file di report risultanti, effettua una richiesta GET al seguente endpoint, passando nuovamente il requestId e aggiungendo il fileIndex, l’indice del file a partire da zero. Ad esempio, se "totalFileCount": 3, gli indici di file disponibili saranno 0, 1 e 2. 
GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps/{{requestId}}/result/{fileIndex}
Ecco un esempio di risposta 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

​
Struttura della risposta

Ogni riga in un file CSV rappresenta un’operazione eseguita su una transazione, ad esempio l’importazione di documenti, il riconoscimento o la revisione manuale. Per ogni operazione nel Warehouse, i relativi dettagli vengono memorizzati nelle colonne:
ColumnDescription
SkillIdL’ID della skill.
SkillVersionLa versione della skill.
SkillNameIl nome della skill.
TransactionIdL’ID della transazione.
StepNameIl nome dell’evento o il nome dell’attività nel caso della Process skill.
StepTypeIl tipo di evento. Valori possibili:
- Input (disponibile per tutti i tipi di skill)
- Ocr (disponibile per le skill OCR o le Process skill con attività OCR aggiunta)
- Classification (disponibile per le skill di Classification o le Process skill con attività di Classification aggiunta)
- Extraction (disponibile per tutti i tipi di skill)
- Condition (disponibile per le Process skill con attività Condition aggiunta)
- CustomActivity (disponibile per le Process skill con attività Custom aggiunta)
- WaitingForManualReview (disponibile per le Process skill con attività Manual Review aggiunta). Il periodo di tempo in cui una transazione è in attesa di revisione manuale
- ManualReview (disponibile per le Process skill con attività Manual Review aggiunta). Il periodo di tempo in cui l’operatore sta verificando una transazione
- Output (disponibile per tutti i tipi di skill)
ManualReviewOperatorNameIl nome dell’operatore di Manual Review.
ManualReviewOperatorEmailL’indirizzo email dell’operatore di Manual Review.
StartedUtcOra di inizio dell’evento (UTC). Ad esempio, 5/3/2022 1:59:02 PM.
CompletedUtcOra di fine dell’evento (UTC).
StatusLo stato dell’evento. Valori possibili:
- Processing
- Finished Successfully
- Canceled
- Failed
DurationDurata dell’evento (in secondi).
DocumentsCountIl numero di documenti elaborati in una transazione.
PagesCountIl numero di pagine elaborate in una transazione.
document_*, transaction_*I parametri del documento o della transazione passati per l’elaborazione. Il prefisso document_ viene aggiunto ai parametri del documento nell’intestazione e il prefisso transaction_ viene aggiunto ai parametri della transazione. Ad esempio, document_SourceFileName. Se una transazione contiene documenti con parametri identici nel nome ma diversi nel valore, il Warehouse elencherà tutti i valori univoci di questo parametro separati da virgole. Ad esempio, tutti i nomi di file all’interno di una transazione.
I dati preparati vengono conservati per 2 settimane dopo il completamento della richiesta. I dati ottenuti in formato CSV possono essere analizzati ulteriormente in qualsiasi strumento di BI.

​
Recupero di un elenco di richieste di report

Per recuperare l’elenco delle richieste di report effettuate in un determinato periodo di tempo, invia una richiesta GET al seguente endpoint, dove createdFrom e createdTo rappresentano l’intervallo di date e statusFilter è uno dei seguenti valori: New, Queued, Processing, Succeeded, Failed o Cancelled. Questa operazione è utile nel caso di ID di richiesta smarriti. 
GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps?statusFilter=Succeeded&createdFrom=2025-11-05&createdTo=2025-11-17
La risposta include un array di richieste di reporting. 
{
  "requests": [
    {
      "requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "Nuovo",
      "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": "Riuscito",
      "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"
      }
    }
  ]
}