Show Menu
SUJETS×

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 comptabilisées comme des transactions dans un rapport de transactions. 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 d’affectation des tâches et des étapes des services de documents des processus AEM
  • Utilisation d’un formulaire adaptatif dans un formulaire adaptatif
Les API de facturation ne tiennent pas compte du nombre de pages, de la longueur d’un document ou d’un formulaire, ni du format final du document rendu. Un rapport de transaction divise les transactions en deux catégories : Documents rendus et Formulaires envoyés.
  • ​Formulaires envoyés : 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 à n’importe quel référentiel de stockage de données ou base de données, elles sont considérées comme des envois de formulaire. Par exemple, l’envoi d’un formulaire adaptatif, d’un formulaire HTML5, de formulaires PDF 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. Si, par exemple, un jeu de formulaires comporte 5 formulaires, le service de création de rapports de transactions comptabilise 5 envois lors de l’envoi du jeu de formulaires.
  • ​Documents rendus : La génération d’un document en combinant un modèle et des données, la signature numérique ou la certification d’un document, l’utilisation d’une API Document Services facturable pour Document Services ou la conversion d’un document d’un format à un autre sont comptabilisées comme des documents rendus.
L’interface utilisateur des rapports de transaction affiche trois catégories : Formulaires envoyés, documents rendus et documents traités. Les documents rendus et les documents traités sont comptabilisés comme documents rendus.

API Billable Document Services

Generate PDF Service

API
Description Catégorie de rapport de transaction Informations supplémentaires
createPDF Crée un fichier Adobe PDF à partir des types de fichiers pris en charge. Documents traités
createPDF2 Crée un fichier 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

Distiller Service

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

Service de document d’enregistrement (service de DE)

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 les données et les 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 PDF. Lorsque vous traitez un lot d’enregistrements, le service de création de rapports de transactions comptabilise chaque enregistrement comme un rendu PDF distinct. Vous pouvez utiliser l’indicateur getGenerateManyFiles pour combiner plusieurs rendus à un seul fichier PDF. Quel que soit l’état de l’indicateur, le service comptabilise chaque enregistrement comme un rendu PDF distinct.
generatePrintedOutput permet de convertir des documents XDP et PDF aux formats de fichier PostScript (PS), PCL (Printer Command Language) et ZPL. Documents traités
generatePrintedOutput permet de convertir des documents XDP et PDF aux formats de fichier 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 PDF. Lorsque vous traitez un lot d’enregistrements, le service de création de rapports de transactions comptabilise chaque enregistrement comme un rendu PDF distinct. Vous pouvez utiliser l’indicateur getGenerateManyFiles pour combiner plusieurs rendus à un seul fichier PDF. Quel que soit l’état de l’indicateur, le service comptabilise chaque enregistrement comme un rendu PDF distinct.

Service Forms

API
Description Catégorie de rapport de transaction Informations supplémentaires
renderPDFForm Génère un 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

Convert PDF Service

API
Description Catégorie de rapport de transaction Informations supplémentaires
toImage permet de convertir un document PDF en 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 d’option. Documents traités

Service Barcoded Forms

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

Incohérence affectant le service

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 cible. Documents traités Les opérations suivantes ne sont pas comptabilisées comme des transactions :
  • Création de packs ou de portefeuilles
  • Rognage de plusieurs fichiers XDP
invoke Exécute le document DDX spécifié et renvoie un objet AssemblerResult contenant les documents cible. Documents traités Tous les formats de fichier 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 fichier de sortie.
toPDFA Convertissez un document spécifié au format PDF/A à l’aide des options spécifiées. Documents traités
  • L’API d’appel du service Assembler peut, en interne, appeler 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 PDF Utility

API
Description Catégorie de rapport de transaction Informations supplémentaires
convertPDFtoXDP Convertit un document PDF en fichier XDP. Pour qu’un document PDF soit 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, des formulaires HTML5 et des jeux 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 formulaires PDF 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 à l’action d’envoi configurée. Formulaires envoyés
  • Les envois réussis sont comptabilisés pour 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 courrier électronique génère des comptes d’action d’envoi pour 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. Un formulaire adaptatif peut comporter n’importe quel nombre de formulaires adaptatifs.

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. Un formulaire adaptatif peut comporter n’importe quel nombre de formulaires adaptatifs.
  • Chaque formulaire d’un jeu de formulaires HTML5 prend en compte une transaction distincte.

Communication interactive facturable et processus AEM orientés formulaires sur les API OSGi

Affectez des étapes de tâche et de services de document aux processus AEM orientés formulaire sur OSGi et à tous les rendus de communication interactive et sont comptabilisés comme des transactions. La prévisualisation d’une communication interactive sur l’instance d’auteur 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 flux de travail comptabilise une transaction et que celle-ci échoue, le nombre de transactions n’est pas annulé.

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

Interactive Communication - Print Channel

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

Processus AEM de formulaire sur OSGi

Cas d’utilisation

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 de formulaires non standard et les implémentations 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 à partir de vos implémentations personnalisées pour enregistrer une transaction .