Passer au contenu principal
Le Rapport sur le traitement métier indique la qualité de traitement des documents et fournit 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 relecture manuelle.
  • Paramètres d’enregistrement du document et de la transaction.
Le Warehouse ne stocke pas d’informations sur les événements de traitement des 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 des 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.

​
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

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 : 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.
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 :
Pour vérifier l’état du rapport, incluez le requestId dans la requête GET : Une fois le rapport créé, le status a la valeur “Succeeded” et totalFileCount indique le nombre de fichiers disponibles au téléchargement :
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. Voici un exemple de réponse CSV :

​
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 : 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. La réponse contient un tableau de requêtes de reporting.