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 état de transaction. Voici quelques scénarios courants dans lesquels une API facturable est utilisée :
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 transactions divise les transactions en deux catégories : Documents rendus et Forms envoyés.
Forms Submitted : 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 ou base de données d’enregistrement de données est considéré comme un envoi 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, lorsque le jeu de formulaires est envoyé, le service de rapports de transactions le compte comme 5 envois.
Documents générés : Génération d’un document en combinant un modèle et des données, en signant ou certifiant numériquement un document, en utilisant une API de services de document facturables pour les services de document ou en convertissant un document d’un format à un autre sont comptabilisés comme des documents rendus.
L’interface utilisateur des rapports sur les transactions affiche trois catégories : Forms envoyée, Documents rendus et Documents traités. Les Documents générés et les Documents traités sont comptabilisés comme Documents générés.
API |
Description | Catégorie de rapports de transactions | 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 superflues sans affecter la qualité. | Documents traités |
API |
Description | Catégorie de rapports de transactions | 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 |
API |
Description | Catégorie de rapports de transactions | 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 |
API |
Description | Catégorie de rapports de transactions | 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 rapports de transactions comptabilise chaque enregistrement comme un rendu PDF distinct. Vous pouvez utiliser l’indicateur getGenerateManyFilesafin de combiner plusieurs rendus dans 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 aux formats de fichier PostScript (PS), PCL (Printer Command Language) et ZPL. | Documents traités | |
generatePrintedOutput | Convertit les 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 fichier 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 rapports de transactions comptabilise chaque enregistrement comme un rendu PDF distinct. Vous pouvez utiliser l’indicateur getGenerateManyFilesafin de combiner plusieurs rendus dans un seul fichier PDF. Quel que soit l’état de l’indicateur, le service comptabilise chaque enregistrement en tant que rendu PDF distinct. |
API |
Description | Catégorie de rapports de transactions | 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 |
API |
Description | Catégorie de rapports de transactions | Informations supplémentaires |
toImage | Convertit un document PDF en liste de documents d’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’options. | Documents traités |
API |
Description | Catégorie de rapports de transactions | 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 |
API |
Description | Catégorie de rapports de transactions | Informations supplémentaires |
invoke | Exécute le document DDX spécifié et renvoie un objet AssemblerResult contenant les documents résultants. | Documents traités | Les opérations suivantes ne sont pas comptabilisées comme des transactions :
|
appeler | Exécute le document DDX spécifié et renvoie un objet AssemblerResult contenant les documents résultants. | 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é en PDF/A à l’aide des options spécifiées. | Documents traités |
API |
Description | Catégorie de rapports de transactions | 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 |
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 transactions fournie pour enregistrer un envoi PDF forms en tant que transaction.
Exemple d’utilisation |
Description | Catégorie de rapports de transactions | Informations supplémentaires |
Envoi d’un formulaire adaptatif | Envoie un formulaire adaptatif à l’action d’envoi configurée. | Formulaires envoyés |
|
Exemple d’utilisation |
Description | Catégorie de rapports de transactions | Informations supplémentaires |
Envoi d’un formulaire HTML5 | Envoie un formulaire HTML5 pour envoyer l’URL configurée dans le formulaire. | Formulaires envoyés |
API |
Description | Catégorie de rapports de transactions | 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 |
|
Affectez des étapes de tâche et de services de document des Workflows d'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 workflow comptabilise une transaction et que celle-ci ne se termine pas, le décompte de transaction n'est pas inversé.
API |
Description | Catégorie de rapports de transactions | Informations supplémentaires |
Rendu d’un canal Web | Ouvre la version Web d’une communication interactive. | Documents rendus |
|
API |
Description | Catégorie de rapports de transactions | Informations supplémentaires |
render (convertir au format PDF) | Génère la version PDF d’une communication interactive. | Documents rendus |
|
Cas d’utilisation |
Catégorie de rapports de transactions | Informations supplémentaires |
Envoi d’une étape d’affectation de Tâche | Formulaires envoyés |
|
Envoi d’un point de départ d’application de processus | Formulaires envoyés | |
Envoi d’une communication interactive (Canal d’impression) depuis l’interface utilisateur de l’agent vers un processus | Documents rendus |
Les actions telles que l’envoi d’un formulaire PDF, l’utilisation de l’interface utilisateur de l’agent pour prévisualisation 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 depuis vos implémentations personnalisées pour enregistrer une transaction.