Passer au contenu principal
Les rapports sur le traitement métier indiquent la qualité de traitement des documents et fournissent une traçabilité des transactions de bout en bout pour les besoins d’audit. Le Warehouse enregistre toutes les transactions — terminées ou en cours — pour l’analyse et la visualisation dans des outils de business intelligence. Les données sont conservées pendant 12 mois, ce qui permet l’analyse et l’audit sur des périodes de temps définies. Les données suivantes sont suivies :
  • ID de transaction.
  • ID de Skill et version.
  • Chemin de traitement par étapes :
    • Types d’étapes
    • Noms
    • Date et heure de début et de fin de l’étape
    • Durée (en secondes)
  • Nom et e-mail de l’opérateur de révision manuelle.
  • Paramètres d’enregistrement du document et de la transaction.
Remarque : Le Warehouse ne stocke pas d’informations sur les événements de traitement de documents dans les activités qui ne sont jamais exécutées selon leur configuration. Par exemple, le paramètre « Assemble by files » correspond au comportement par défaut de Vantage ; par conséquent, le traitement de documents dans cette activité sera ignoré dans un workflow.

​
Migration de v1 vers v2

Dans Vantage 3.0 et versions ultérieures, le point de terminaison v1 transaction-steps est obsolète. Pour assurer la compatibilité descendante, le point de terminaison v2 fonctionne de manière similaire, avec un changement de nom et le déplacement des paramètres de requête vers le corps de la requête. Le point de terminaison v2 utilise désormais un modèle asynchrone afin de mieux gérer les requêtes de données volumineuses. Une fois un rapport demandé, vous pouvez interroger périodiquement son statut jusqu’à ce qu’il soit prêt. Une fois le traitement terminé, vous pouvez télécharger les résultats. 
// 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

// Une fois que le statut = "Succeeded", télécharger les fichiers de rapport
3. GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps/{{requestId}}/result/{fileIndex}

​
Quoi de neuf ?

Dans la requête (/api/reporting/v2/exports/transaction-steps) :
  • Les filtres ont été déplacés des paramètres de requête vers le corps de la requête (objet JSON filters).
  • startDate, spécifié dans l’objet filters, est désormais obligatoire.
  • Nouveau champ : sendEmailNotification (true/false) - envoie un e-mail à l’utilisateur ayant demandé le rapport lorsque celui-ci est prêt à être téléchargé.
Dans les fichiers CSV téléchargés du résultat final (/api/reporting/v2/exports/transaction-steps/{{requestId}}/result/{fileIndex}), deux colonnes ont été ajoutées :
  • DocumentsCount : le nombre de documents traités dans une transaction.
  • PagesCount : le nombre de pages traitées dans une transaction.
Poursuivez la lecture ci-dessous pour plus de détails sur le fonctionnement de l’endpoint v2.

​
Téléchargement d’un rapport de données

Remarque : seuls les utilisateurs ayant les rôles Tenant Administrator et Processing Supervisor peuvent télécharger un rapport de données depuis le Warehouse. Pour plus d’informations, consultez Contrôle d’accès fondé sur les rôles (RBAC).
Vous pouvez obtenir des données du Warehouse dans un fichier CSV à l’aide de l’API Vantage. Pour ce faire, envoyez une requête POST à la ressource suivante : 
POST {base_url}/api/reporting/v2/exports/transaction-steps
Un corps de requête doit inclure les propriétés suivantes dans un objet filters :
  • skillId. L’ID du Skill dont les transactions doivent être téléchargées. Facultatif.
  • transactionId. L’ID de la transaction à utiliser pour le filtrage. Facultatif.
  • startDate. Le premier jour de la période (format d’exemple : 2022-01-07T13:03:38, l’heure doit être en UTC) pour laquelle les transactions doivent être téléchargées. Obligatoire.
  • endDate. Le dernier jour de la période (format d’exemple : 2022-09-07T13:03:38, l’heure doit être en UTC) pour laquelle les transactions doivent être téléchargées. Facultatif.
  • sendEmailNotification. Envoyer un e-mail à l’utilisateur qui a créé la demande de rapport pour l’informer que le rapport est prêt à être téléchargé. Facultatif.
{
  "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
}
Les requêtes de rapport sont exécutées de manière asynchrone, ainsi la réponse renvoie un requestId utilisé pour vérifier l’état de la requête. Résultat : 
{
  "requestId": "8f772512-099c-4050-8dd3-6c4d7af69747”
}
Pour vérifier l’état du rapport, incluez le requestId dans la requête GET : 
GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps/{{requestId}}/status
Une fois le rapport créé, le status a la valeur “Succeeded” et totalFileCount indique le nombre de fichiers disponibles au téléchargement : 
{
  "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"
  }
}
Pour télécharger les fichiers de rapport générés, effectuez une requête GET vers l’URL suivante, en transmettant de nouveau le requestId et en ajoutant le fileIndex, l’index de base zéro du fichier. Par exemple, si "totalFileCount": 3, alors les index de fichier disponibles seraient 0, 1 et 2. 
GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps/{{requestId}}/result/{fileIndex}
Voici un exemple de réponse 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

​
Structure de la réponse

Chaque ligne d’un fichier CSV correspond à une opération effectuée sur une transaction, par exemple l’importation de documents, la reconnaissance ou la revue manuelle. Pour chaque opération dans le Warehouse, ses détails sont stockés dans des colonnes :
ColonneDescription
SkillIdL’ID du skill.
SkillVersionLa version du skill.
SkillNameLe nom du skill.
TransactionIdL’ID de la transaction.
StepNameLe nom de l’événement ou le nom de l’activité dans le cas d’un Process skill.
StepTypeLe type d’événement. Valeurs possibles :
- Input (disponible pour tous les types de skill)
- Ocr (disponible pour les OCR skills ou les Process skills avec une activité OCR ajoutée)
- Classification (disponible pour les Classification skills ou les Process skills avec une activité Classification ajoutée)
- Extraction (disponible pour tous les types de skill)
- Condition (disponible pour les Process skills avec une activité Condition ajoutée)
- CustomActivity (disponible pour les Process skills avec une activité Custom ajoutée)
- WaitingForManualReview (disponible pour les Process skills avec une activité Manual Review ajoutée). La durée pendant laquelle une transaction est en attente de revue manuelle
- ManualReview (disponible pour les Process skills avec une activité Manual Review ajoutée). La durée pendant laquelle l’opérateur vérifie une transaction
- Output (disponible pour tous les types de skill)
ManualReviewOperatorNameLe nom de l’opérateur de revue manuelle.
ManualReviewOperatorEmailL’e-mail de l’opérateur de revue manuelle.
StartedUtcL’heure de début de l’événement (UTC). Par exemple, 05/03/2022 13:59:02.
CompletedUtcL’heure de fin de l’événement (UTC).
StatusLe statut de l’événement. Valeurs possibles :
- Processing
- Finished Successfully
- Canceled
- Failed
DurationLa durée de l’événement (en secondes).
DocumentsCountLe nombre de documents traités dans la transaction.
PagesCountLe nombre de pages traitées dans la transaction.
document_*, transaction_*Les paramètres de document ou de transaction transmis pour le traitement. Le préfixe document_ est ajouté aux paramètres de document dans l’en-tête, et le préfixe transaction_ est ajouté aux paramètres de transaction. Par exemple, document_SourceFileName. Si une transaction contient des documents avec des paramètres ayant le même nom mais des valeurs différentes, le Warehouse répertorie toutes les valeurs uniques de ce paramètre, séparées par des virgules, par exemple tous les noms de fichier au sein d’une transaction.
Les données préparées sont stockées pendant 2 semaines après l’exécution de la requête. Les données obtenues au format CSV peuvent ensuite être analysées dans n’importe quel outil de Business Intelligence (BI).

​
Récupération de la liste des demandes de rapport

Pour récupérer la liste des demandes de rapport effectuées sur une période donnée, effectuez une requête GET vers le point de terminaison suivant, où createdFrom et createdTo représentent la plage de dates et statusFilter est l’une des valeurs suivantes : New, Queued, Processing, Succeeded, Failed ou Cancelled. Cette opération est utile si vous avez égaré des identifiants de demande. 
GET {{baseUrl}}/api/reporting/v2/exports/transaction-steps?statusFilter=Succeeded&createdFrom=2025-11-05&createdTo=2025-11-17
La réponse contient un tableau de requêtes de reporting. 
{
  "requests": [
    {
      "requestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "status": "Nouveau",
      "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": "Réussi",
      "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"
      }
    }
  ]
}