API facturables pour les rapports de transaction pour AEM Forms sur OSGi transaction-reports-billable-apis

Version
Lien de l’article
AEM as a Cloud Service
Cliquez ici
AEM 6.5
Cet article

AEM Forms fournit plusieurs API permettant d’envoyer des formulaires, de traiter et de générer des documents. Certaines API sont comptabilisées comme des transactions et d’autres sont gratuites. Ce document fournit une liste de toutes les API 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 des étapes Affecter des tâches et des services de document des workflows AEM
  • Utilisation d’un formulaire adaptatif dans un autre formulaire adaptatif

Les API de facturation ne prennent pas en compte le nombre de pages, la taille 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 : les documents rendus et les formulaires envoyés.

  • Formulaires envoyés : les données envoyées à partir de n’importe quel type de formulaire créé avec AEM Forms et les données envoyées à nʼimporte quel référentiel de stockage de données ou base de données sont considérées comme un envoi de formulaire. Par exemple, l’envoi d’un formulaire adaptatif, d’un HTML5, de formulaires PDF et d’un jeu de formulaires est comptabilisé comme un formulaire envoyé. 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 rapport sur les transactions compte 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 documents ou la conversion d’un document d’un format à un autre sont comptabilisés comme des documents rendus.

NOTE
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 tous deux comptabilisés comme des documents rendus.

API de Document Services facturables billable-document-services-apis

Service Generate PDF generate-pdf-service

API
Description
Catégorie de rapport de transaction
Informations supplémentaires
createPDF
Crée des fichiers Adobe PDF à partir des types de fichiers pris en charge.
Documents traités
createPDF2
Crée des fichiers Adobe PDF à partir des types de fichiers pris en charge.
Documents traités
exportPDF
Convertit des fichiers Adobe PDF en types de fichiers pris en charge.
Documents traités
exportPDF2
Convertit des fichiers Adobe PDF en types de fichiers pris en charge.
Documents traités
exportPDF3
Convertit des fichiers Adobe PDF en types de fichiers pris en charge.
Documents traités
htmlFileToPdf
Crée des fichiers 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 un fichier PDF pour réduire la taille du fichier en supprimant les métadonnées inutiles sans réduire la qualité.
Documents traités

Service DocAssurance DocAssurance-Service

API
Description
Catégorie de rapport de transaction
Informations supplémentaires
secureDocument
Cette API vous permet de protéger votre document. Vous pouvez utiliser l’API pour signer, certifier, étendre Reader ou chiffrer un document PDF.
Documents traités
Seule l’opération de signature et de certification du secureDocument est facturée.

Service Distiller distiller-service

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

Service Document of Record (service DoR) document-of-record-service-dor-service

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 output-service

API
Description
Catégorie de rapport de transaction
Informations supplémentaires
generatePDFOutput
Fusionne des données et des modèles pour créer un document PDF.
Documents traités
generatePDFOutput
Fusionne des données et des 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 PDF. Lorsque vous traitez un lot d’enregistrements, le service de reporting des transactions comptabilise chaque enregistrement comme un rendu de PDF distinct.
Vous pouvez utiliser l’indicateur getGenerateManyFiles pour combiner plusieurs rendus en un seul fichier PDF. Quel que soit l’état de l’indicateur, le service comptabilise chaque enregistrement comme un rendu de PDF distinct.
generatePrintedOutput
Convertit les documents XDP et PDF aux formats PostScript (PS), PCL (Printer Command Language) et ZPL.
Documents traités
generatePrintedOutput
Convertit les documents XDP et PDF aux formats 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 reporting des transactions comptabilise chaque enregistrement comme un rendu de PDF distinct.
Vous pouvez utiliser l’indicateur getGenerateManyFiles pour combiner plusieurs rendus en un seul fichier PDF. Quel que soit l’état de l’indicateur, le service comptabilise chaque enregistrement comme un rendu de PDF distinct.

Service Forms forms-service

API
Description
Catégorie de rapport de transaction
Informations supplémentaires
renderPDFForm
Rend le 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 convert-pdf-service

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 plat au format PostScript à l’aide des options spécifiées dans la spécification de l’option.
Documents traités

Service Barcoded Forms barcoded-forms-service

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-barre.
Documents traités

Incohérence affectant le service assembleur assembler-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 créés.
Documents traités

Les opérations suivantes ne sont pas comptabilisées comme des transactions :

  • Créer des packages ou des portfolios
  • Assembler 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 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 format PDF/A à l’aide d’options indiquées.
Documents traités

L’utilisation de l’API d’appel est comptabilisée comme une transaction lorsque vous effectuez une ou plusieurs des opérations suivantes :

  1. Conversion de formats non PDF en formats PDF. Par exemple, la conversion du format XDP au format PDF, qui prend en charge les formes de communication interactives et non interactives, et la conversion de Word au format PDF.
  2. Conversion du format PDF au format PDF/A.
  3. Conversion du format PDF aux formats non PDF. Les exemples incluent la transformation du format PDF au format Image ou la conversion du format PDF au format Texte.
NOTE
  • L’API Invoke du service Assembler peut appeler en interne une API facturable d’un autre service selon l’entrée. Ainsi, l’API Invoke 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 appelées.
  • Un seul document PDF 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 pdf-utility-service

API
Description
Catégorie de rapport de transaction
Informations supplémentaires
convertPDFtoXDP
Convertit un document PDF en fichier XDP. Pour réussir la conversion d’un document PDF 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 billable-data-capture-apis

Tous les événements d’envoi des formulaires adaptatifs, de formulaires 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 les API d’enregistrement de transaction pour enregistrer un envoi de formulaires PDF en tant que transaction.

Formulaires adaptatifs adaptive-forms

Cas 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 PDF par le biais d’une action d’envoi par e-mail comptabilise deux transactions. Une transaction pour l’envoi de formulaire et une autre pour le PDF généré à l’aide du service Document of Record (DOR).
  • L’utilisation du formulaire adaptatif dans un formulaire adaptatif (jeu de formulaires adaptatifs) comptabilise une seule transaction. Vous pouvez avoir un nombre illimité de formulaires adaptatifs dans un formulaire adaptatif.

Formulaires HTML5 html-forms

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

Jeu de formulaires form-set

API
Description
Catégorie de rapport de transaction
Informations supplémentaires
Envoyer 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) comptabilise une seule transaction. Vous pouvez avoir un nombre illimité de formulaires adaptatifs dans un formulaire adaptatif.
  • Chaque formulaire d’un jeu de formulaires HTML5 est comptabilisé comme une transaction distincte.

Communication interactive facturable et workflows AEM basés sur des formulaires sur les API OSGi billable-interactive-communication-and-form-centric-aem-workflows-on-osgi-apis

Les étapes Affecter des tâches et des services de document des workflows AEM basés sur des formulaires 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 interactive-communication-web-channel

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 interactive-communication-print-channel

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

Processus AEM de formulaire sur OSGi form-centric-aem-workflows-on-osgi

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

Enregistrer les API de facturation en tant que transactions pour le code personnalisé recording-billable-apis-as-transactions-for-custom-code

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’utilisation d’un formulaire non standard et les implémentations personnalisées ne sont pas comptabilisées comme des transactions. AEM Forms fournit une API pour enregistrer ces actions en tant que transactions. Vous pouvez appeler l’API à partir de vos implémentations personnalisées pour enregistrer une transaction.

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2