API facturables des rapports de transaction

AEM Forms fournit plusieurs API pour envoyer des formulaires, traiter des documents et générer des documents. Certaines API sont comptabilisées comme des transactions et d’autres sont libres d’utiliser. Ce document fournit une liste de toutes les API qui sont comptabilisées comme des transactions dans un rapport de transaction. Voici quelques scénarios courants dans lesquels une API facturable est utilisée :

  • Envoi d’un formulaire adaptatif, d’un formulaire HTML5 et d’un jeu de formulaires
  • Rendu d’une version imprimée ou web d’une communication interactive
  • Conversion d’un document d’un format à un autre
  • Aplatissement d’un document PDF dynamique
  • Génération d’un document d’enregistrement
  • Fusion d’un document PDF interactif avec un autre document PDF
  • Utilisation de l’étape Affecter une tâche et des étapes des services de documentation des processus AEM
  • Utilisation d’un formulaire adaptatif dans un formulaire adaptatif

Les API de facturation ne prennent pas en compte le nombre de pages, la longueur d’un document ou d’un formulaire, ni le format final du document rendu. Un rapport de transaction divise les transactions en deux catégories : Documents rendus et Forms envoyés.

  • Forms envoyée : lorsque des données sont envoyées à partir de n’importe quel type de formulaire créé avec AEM Forms et que les données sont envoyées à un référentiel de stockage de données ou à une base de données sont considérées comme des envois de formulaire. Par exemple, l’envoi d’un formulaire adaptatif, d’un formulaire HTML5, de PDF forms et d’un jeu de formulaires est comptabilisé comme des formulaires envoyés. Chaque formulaire d’un jeu de formulaires est considéré comme un envoi. Par exemple, si un jeu de formulaires comporte 5 formulaires, le service de reporting sur les transactions les comptabilise comme 5 envois lorsque le jeu de formulaires est envoyé.

  • Documents rendus : la génération d’un document en combinant un modèle et des données, la signature ou la certification numérique d’un document, l’utilisation d’une API Document Services facturable pour les services de document ou la conversion d’un document d’un format à un autre sont comptabilisées comme des documents rendus.

REMARQUE

L’interface utilisateur des rapports de transaction affiche trois catégories : Forms envoyées, documents rendus et documents traités. Les documents rendus et les documents traités sont tous deux comptabilisés comme des documents rendus.

API de services de document facturables

Service Generate PDF

API

 Description Catégorie de rapport de transaction Informations supplémentaires
createPDF Crée Adobe PDF à partir des types de fichiers pris en charge. Documents traités
createPDF2 Crée Adobe PDF à partir des types de fichiers pris en charge. Documents traités
exportPDF Convertit Adobe PDF en types de fichiers pris en charge. Documents traités
exportPDF2 Convertit Adobe PDF en types de fichiers pris en charge. Documents traités
exportPDF3 Convertit Adobe PDF en types de fichiers pris en charge. Documents traités
htmlFileToPdf

Crée un fichier PDF à partir de pages HTML.

 Documents traités
htmlToPdf Crée un fichier PDF à partir d’URL pointant vers une page HTML. Documents traités
htmlToPdf2 Crée un fichier PDF à partir d’URL pointant vers une page HTML. Documents traités
optimizePDF Optimise le format PDF pour réduire la taille du fichier en supprimant les métadonnées inutiles sans affecter la qualité. Documents traités

Service Distiller

API

 Description Catégorie de rapport de transaction Informations supplémentaires
createPDF
 Crée Adobe PDF à partir des types de fichiers pris en charge. Documents traités
createPDF2 Crée Adobe PDF à partir des types de fichiers pris en charge. Documents traités

Service de document d’enregistrement (service DoR)

API

 Description Catégorie de rapport de transaction Informations supplémentaires
render Appelle la méthode de rendu spécifiée pour générer un document d’enregistrement à l’aide des paramètres fournis. Documents traités

Service Output

API

 Description Catégorie de rapport de transaction Informations supplémentaires
generatePDFOutput Fusionne les données et les modèles pour créer un document PDF. Documents traités
generatePDFOutput Fusionne les données et les modèles pour créer un document PDF. Documents traités
generatePDFOutputBatch Fusionne des données et des modèles pour créer un ensemble de documents PDF. Documents traités L’API generatePDFOutputBatch combine un modèle de formulaire avec un enregistrement et génère un fichier PDF. Lorsque vous traitez un lot d’enregistrements, le service de reporting des transactions comptabilise chaque enregistrement comme un rendu PDF distinct.
Vous pouvez utiliser l’indicateur getGenerateManyFilesflag pour combiner plusieurs rendus à un seul fichier PDF. Quel que soit l’état de l’indicateur, le service comptabilise chaque enregistrement en tant que rendu PDF distinct.
generatePrintedOutput Convertit les documents XDP et PDF en formats de fichiers PostScript (PS), PCL (Printer Command Language) et ZPL. Documents traités
generatePrintedOutput Convertit les documents XDP et PDF en formats de fichiers PostScript (PS), PCL (Printer Command Language) et ZPL. Documents traités
generatePrintedOutputBatch Convertit un ensemble de documents XDP et PDF en un ensemble de formats de fichiers PostScript (PS), PCL (Printer Command Language) et ZPL. Documents traités L’API generatePDFOutputBatch combine un modèle de formulaire avec un enregistrement et génère un fichier PDF. Lorsque vous traitez un lot d’enregistrements, le service de reporting des transactions comptabilise chaque enregistrement comme un rendu PDF distinct.
Vous pouvez utiliser l’indicateur getGenerateManyFilesflag pour combiner plusieurs rendus à un seul fichier PDF. Quel que soit l’état de l’indicateur, le service comptabilise chaque enregistrement en tant que rendu PDF distinct.

Service Forms

API

 Description Catégorie de rapport de transaction Informations supplémentaires
renderPDFForm Rendu du formulaire PDF à partir de modèles XDP. Les modèles XP sont créés dans Forms Designer. Documents traités
exportData Extrait les données d’un formulaire PDF ou de modèles XDP Documents traités

Service Convert PDF

API

 Description Catégorie de rapport de transaction Informations supplémentaires
toImage Convertit un document PDF en une liste de documents image. Les formats d’image pris en charge sont JPEG, JPEG2K, PNG et TIFF. Documents traités
toPS Convertit un fichier PDF aplati au format PostScript à l’aide des options spécifiées dans la spécification de l’option. Documents traités

Service Barcoded Forms

API

 Description Catégorie de rapport de transaction Informations supplémentaires
decode Décode tous les codes à barres d’un objet Document et renvoie un objet org.w3c.dom.Document contenant les données extraites du code à barres. Documents traités

Incohérence affectant le service assembleur

API

 Description Catégorie de rapport de transaction Informations supplémentaires
invoke Exécute le document DDX spécifié et renvoie un objet AssemblerResult contenant les documents créés. Documents traités Les opérations suivantes ne sont pas comptabilisées comme des transactions :
  • Création de packages ou de portfolio
  • Assemblage de plusieurs fichiers XDP
invoke Exécute le document DDX spécifié et renvoie un objet AssemblerResult contenant les documents créés. Documents traités Tous les formats de fichiers d’entrée pris en charge par les services PDF Generator, Forms et Output, le service Assembler prend en charge tous ces formats en tant que formats de fichiers de sortie.
toPDFA Convertissez un document spécifié en PDF/A à l’aide des options spécifiées. Documents traités
REMARQUE
  • L’API invoke du service Assembler peut appeler en interne une API facturable d’un autre service selon l’entrée. Ainsi, l’API d’appel peut être comptabilisée comme aucune, une ou plusieurs transactions. Le nombre de transactions comptabilisées dépend de l’entrée et des API internes invoquées.
  • Un document PDF unique produit à l’aide du service Assembler peut être comptabilisé comme aucune, une ou plusieurs transactions. Le nombre de transactions comptabilisées dépend du code DDX fourni.

Service d’utilitaire PDF

API

 Description Catégorie de rapport de transaction Informations supplémentaires
convertPDFtoXDP Convertit un document PDF en fichier XDP. Pour qu’un document PDF puisse être converti en fichier XDP, le document PDF doit contenir un flux XFA dans le dictionnaire AcroForm. Documents traités

API de capture de données facturables

Tous les événements d’envoi des formulaires adaptatifs, du Forms HTML5 et du jeu de formulaires sont comptabilisés comme des transactions. Par défaut, l’envoi d’un formulaire PDF n’est pas comptabilisé comme une transaction. Utilisez l’ API d’enregistrement de transaction fournie pour enregistrer un envoi de PDF forms en tant que transaction.

Formulaires adaptatifs

Exemple d’utilisation

Description Catégorie de rapport de transaction Informations supplémentaires
Envoi d’un formulaire adaptatif Envoie un formulaire adaptatif à une action d’envoi configurée. Formulaires envoyés
  • Les envois réussis comptabilisent une ou deux transactions. Le nombre de transactions comptabilisées dépend du type d’action d’envoi utilisée pour l’envoi. Par exemple, l’envoi d’un fichier PDF par le biais d’une action d’envoi par courrier électronique comptabilise deux comptes de transactions. Une transaction pour l’envoi du formulaire et une autre pour le PDF généré à l’aide du service de document d’enregistrement (DOR).
  • L’utilisation du formulaire adaptatif dans un formulaire adaptatif (jeu de formulaires adaptatifs) ne tient compte que d’une seule transaction. Vous pouvez avoir un nombre illimité de formulaires adaptatifs dans un formulaire adaptatif.

Formulaires HTML5

Exemple d’utilisation

Description Catégorie de rapport de transaction Informations supplémentaires
Envoi d’un formulaire HTML5 Envoie un formulaire HTML5 pour envoyer l’URL configurée dans le formulaire. Formulaires envoyés

Jeu de formulaires

API

 Description Catégorie de rapport de transaction Informations supplémentaires
Envoi d’un jeu de formulaires Envoie le jeu de formulaires à l’URL d’envoi configurée dans le jeu de formulaires. Formulaires envoyés
  • L’utilisation du formulaire adaptatif dans un formulaire adaptatif (jeu de formulaires adaptatifs) ne tient compte que d’une seule transaction. Vous pouvez avoir un nombre illimité de formulaires adaptatifs dans un formulaire adaptatif.
  • Chaque formulaire d’un jeu de formulaires Forms HTML5 est comptabilisé comme une transaction distincte.

Processus de communication interactive facturable et d’AEM basés sur des formulaires sur les API OSGi

Les étapes Affecter des tâches et des services de document des processus d’AEM basés sur l’utilisation de Forms sur OSGi et tous les rendus de communication interactive sont comptabilisés comme des transactions. La prévisualisation d’une communication interactive sur l’instance de création et la prévisualisation sur l’instance de publication à l’aide de l’interface utilisateur de l’agent ne sont pas comptabilisées comme des transactions. Si une étape de workflow comptabilise une transaction et que le workflow ne se termine pas, le nombre de transactions n’est pas inversé.

Communication interactive - canal Web

API

 Description Catégorie de rapport de transaction Informations supplémentaires
Rendu d’un canal web Ouvre la version web d’une communication interactive. Documents rendus

Communication interactive - Canal d’impression

API

 Description Catégorie de rapport de transaction Informations supplémentaires
render (conversion en PDF) Génère la version PDF d’une communication interactive. Documents rendus

Processus AEM de formulaire sur OSGi

Cas d’utilisation

 Catégorie de rapport de transaction Informations supplémentaires
Envoi d’une étape Affecter une tâche Formulaires envoyés
Envoi d’un point de départ d’application de workflow Formulaires envoyés
Envoi d’une communication interactive (canal d’impression) depuis l’interface utilisateur de l’agent vers un workflow Documents rendus

Enregistrement des API facturables en tant que transactions pour le code personnalisé

Les actions telles que l’envoi d’un formulaire PDF, l’utilisation de l’interface utilisateur de l’agent pour prévisualiser une communication interactive, l’envoi d’un formulaire non standard et les mises en oeuvre personnalisées ne sont pas comptabilisées comme des transactions. AEM Forms fournit une API pour enregistrer des actions telles que des transactions. Vous pouvez appeler l’API depuis vos implémentations personnalisées vers enregistrer une transaction.

Sur cette page