Création dynamique de Documents DDX

Vous pouvez créer de manière dynamique un document DDX qui peut être utilisé pour effectuer une opération Assembler. La création dynamique d’un document DDX vous permet d’utiliser dans le document DDX des valeurs obtenues lors de l’exécution. Pour créer de manière dynamique un document DDX, utilisez des classes qui appartiennent au langage de programmation que vous utilisez. Par exemple, si vous développez votre application cliente à l’aide de Java, utilisez des classes qui appartiennent au package org.w3c.dom.*. De même, si vous utilisez Microsoft .NET, utilisez des classes qui appartiennent à l'espace de nommage System.Xml.

Avant de transmettre le document DDX au service Assembler, convertissez le XML d’une instance org.w3c.dom.Document en instance com.adobe.idp.Document. Si vous utilisez des services Web, convertissez le XML du type de données utilisé pour créer le XML (par exemple, XmlDocument) en une instance BLOB.

Pour cette discussion, supposons que le document DDX suivant soit créé dynamiquement.

 <?xml version="1.0" encoding="UTF-8"?> 
 <DDX xmlns="https://ns.adobe.com/DDX/1.0/"> 
      <PDFsFromBookmarks prefix="stmt"> 
     <PDF source="AssemblerResultPDF.pdf"/> 
 </PDFsFromBookmarks> 
 </DDX>

Ce document DDX désassemble un document PDF. Il est recommandé de se familiariser avec le démontage des documents PDF.

Résumé des étapes

Pour désassembler un document PDF à l’aide d’un document DDX créé dynamiquement, effectuez les tâches suivantes :

1. Incluez des fichiers de projet.
2. Créez un client PDF Assembler.
3. Créez le document DDX.
4. Conversion du document DDX.
5. Définissez les options d’exécution.
6. Désassemblez le document PDF.
7. Enregistrez les documents PDF déassemblés.

Inclure les fichiers de projet

Incluez les fichiers nécessaires dans votre projet de développement. Si vous créez une application cliente à l’aide de Java, incluez les fichiers JAR nécessaires. Si vous utilisez des services Web, veillez à inclure les fichiers proxy.

Les fichiers JAR suivants doivent être ajoutés au chemin de classe de votre projet :

• adobe-livecycle-client.jar
• adobe-usermanager-client.jar
• adobe-assembler-client.jar
• adobe-utilities.jar (requis si AEM Forms est déployé sur JBoss)
• jbossall-client.jar (requis si AEM Forms est déployé sur JBoss)

Création d’un client PDF Assembler

Avant de pouvoir exécuter une opération Assembler par programmation, vous devez créer un client de service Assembler.

Création du document DDX

Créez un document DDX à l’aide du langage de programmation utilisé. Pour créer un document DDX qui désassemble un document PDF, assurez-vous qu’il contient l’élément PDFsFromBookmarks. Convertissez le type de données utilisé pour créer le document DDX en instance com.adobe.idp.Document si vous utilisez l’API Java. Si vous utilisez des services Web, convertissez le type de données en instance BLOB.

Conversion du document DDX

Un document DDX créé à l’aide des classes org.w3c.dom doit être converti en objet com.adobe.idp.Document. Pour effectuer cette tâche lors de l’utilisation de l’API Java, utilisez les classes de transformation XML Java. Si vous utilisez des services Web, convertissez le document DDX en objet BLOB.

Référence à un document PDF à désassembler

Pour désassembler un document PDF, référencez un fichier PDF représentant le document PDF à désassembler. Lorsqu’il est transmis au service Assembler, un document PDF distinct est renvoyé pour chaque signet de niveau 1 du document.

Définition des options d’exécution

Vous pouvez définir des options d’exécution qui contrôlent le comportement du service Assembler lorsqu’il effectue une tâche. Par exemple, vous pouvez définir une option qui indique au service Assembler de continuer à traiter une tâche en cas d’erreur. Pour définir les options d’exécution, vous utilisez un objet AssemblerOptionSpec.

Désassembler le document PDF

Démontez le document PDF en appelant l’opération invokeDDX. Transmettez le document DDX créé de manière dynamique. Le service Assembler renvoie des documents PDF désassemblés dans un objet de collection.

Enregistrer les documents PDF déassemblés

Tous les documents PDF déassemblés sont renvoyés dans un objet de collection. Effectuez une itération dans l’objet de collection et enregistrez chaque document PDF au format PDF.

Voir également

Création dynamique d’un document DDX à l’aide de l’API Java

Création dynamique d’un document DDX à l’aide de l’API du service Web

Inclusion des fichiers de bibliothèque Java AEM Forms

Réglage des propriétés de la connexion

Démontage programmatique des Documents PDF

Création dynamique d’un document DDX à l’aide de l’API Java

Créez de manière dynamique un document DDX et désassemblez un document PDF à l’aide de l’API Assembler Service (Java) :

1. Incluez des fichiers de projet.

   Incluez des fichiers JAR client, tels que adobe-assembler-client.jar, dans le chemin de classe de votre projet Java.

2. Créez un client PDF Assembler.

   • Créez un objet ServiceClientFactory qui contient des propriétés de connexion.
   • Créez un objet AssemblerServiceClient en utilisant son constructeur et en transmettant l'objet ServiceClientFactory.

3. Créez le document DDX.

   • Créez un objet Java DocumentBuilderFactory en appelant la méthode DocumentBuilderFactory class’ newInstance.

   • Créez un objet Java DocumentBuilder en appelant la méthode DocumentBuilderFactory de l'objet newDocumentBuilder.

   • Appelez la méthode DocumentBuilder de l'objet newDocument pour instancier un objet org.w3c.dom.Document.

   • Créez l’élément racine du document DDX en appelant la méthode org.w3c.dom.Document de l’objet createElement. Cette méthode crée un objet Element qui représente l’élément racine. Transmettez une valeur de chaîne représentant le nom de l’élément à la méthode createElement. Convertissez la valeur de retour en Element. Ensuite, définissez une valeur pour l’élément enfant en appelant sa méthode setAttribute. Enfin, ajoutez l’élément à l’élément d’en-tête en appelant la méthode appendChild de l’élément d’en-tête et transmettez l’objet d’élément enfant en tant qu’argument. Les lignes de code suivantes présentent cette logique d’application :

      Element root = (Element)document.createElement("DDX");  root.setAttribute("xmlns","https://ns.adobe.com/DDX/1.0/");  document.appendChild(root);

   • Créez l’élément PDFsFromBookmarks en appelant la méthode Document de l’objet createElement. Transmettez une valeur de chaîne représentant le nom de l’élément à la méthode createElement. Convertissez la valeur de retour en Element. Définissez une valeur pour l’élément PDFsFromBookmarks en appelant sa méthode setAttribute. Ajoutez l’élément PDFsFromBookmarks à l’élément DDX en appelant la méthode appendChild de l’élément DDX. Transmettez l'objet d'élément PDFsFromBookmarks en argument. Les lignes de code suivantes présentent cette logique d’application :

      Element PDFsFromBookmarks = (Element)document.createElement("PDFsFromBookmarks");  PDFsFromBookmarks.setAttribute("prefix","stmt");  root.appendChild(PDFsFromBookmarks);

   • Créez un élément PDF en appelant la méthode Document de l’objet createElement. Transmettez une valeur de chaîne qui représente le nom de l’élément. Convertissez la valeur de retour en Element. Définissez une valeur pour l’élément PDF en appelant sa méthode setAttribute. Ajoutez l’élément PDF à l’élément PDFsFromBookmarks en appelant la méthode PDFsFromBookmarks de l’élément appendChild. Transmettez l'objet d'élément PDF en argument. Les lignes de code suivantes présentent cette logique d’application :

      Element PDF = (Element)document.createElement("PDF");  PDF.setAttribute("source","AssemblerResultPDF.pdf");  PDFsFromBookmarks.appendChild(PDF);

4. Conversion du document DDX.

   • Créez un objet javax.xml.transform.Transformer en appelant la méthode statique javax.xml.transform.Transformer de l'objet newInstance.
   • Créez un objet Transformer en appelant la méthode TransformerFactory de l'objet newTransformer.
   • Créez un objet ByteArrayOutputStream en utilisant son constructeur.
   • Créez un objet javax.xml.transform.dom.DOMSource en utilisant son constructeur. Transmettez l’objet org.w3c.dom.Document qui représente le document DDX.
   • Créez un objet javax.xml.transform.dom.DOMSource en utilisant son constructeur et en transmettant l’objet ByteArrayOutputStream.
   • Renseignez l’objet Java ByteArrayOutputStream en appelant la méthode javax.xml.transform.Transformer de l’objet transform. Transmettez les objets javax.xml.transform.dom.DOMSource et javax.xml.transform.stream.StreamResult.
   • Créez un tableau d’octets et affectez la taille de l’objet ByteArrayOutputStream au tableau d’octets.
   • Renseignez le tableau d’octets en appelant la méthode ByteArrayOutputStream de l’objet toByteArray.
   • Créez un objet com.adobe.idp.Document en utilisant son constructeur et en transmettant le tableau d’octets.

5. Référencez un document PDF à désassembler.

   • Créez un objet java.util.Map utilisé pour stocker des documents PDF d’entrée à l’aide d’un constructeur HashMap.

   • Créez un objet java.io.FileInputStream en utilisant son constructeur et en transmettant l’emplacement du document PDF à désassembler.

   • Créez un objet com.adobe.idp.Document. Transmettez l’objet java.io.FileInputStream contenant le document PDF à désassembler.

   • Ajoutez une entrée à l'objet java.util.Map en invoquant sa méthode put et en transmettant les arguments suivants :

     • Valeur de chaîne qui représente le nom de la clé. Cette valeur doit correspondre à la valeur de l’élément source PDF spécifié dans le document DDX. (Dans le document DDX créé dynamiquement, la valeur est AssemblerResultPDF.pdf.)
     • Objet com.adobe.idp.Document contenant le document PDF à désassembler.

6. Définissez les options d’exécution.

   • Créez un objet AssemblerOptionSpec qui stocke les options d’exécution à l’aide de son constructeur.
   • Définissez des options d'exécution pour répondre aux besoins de votre entreprise en appelant une méthode appartenant à l'objet AssemblerOptionSpec. Par exemple, pour demander au service Assembler de continuer à traiter une tâche en cas d’erreur, appelez la méthode AssemblerOptionSpec de l’objet setFailOnError et transmettez false.

7. Désassemblez le document PDF.

   Appelez la méthode invokeDDX de l’objet AssemblerServiceClient et transmettez les valeurs suivantes :

   • Un objet com.adobe.idp.Document qui représente le document DDX créé de manière dynamique
   • Objet java.util.Map contenant le document PDF à désassembler
   • Un objet com.adobe.livecycle.assembler.client.AssemblerOptionSpec qui spécifie les options d’exécution, y compris la police par défaut et le niveau du journal des tâches

   La méthode invokeDDX renvoie un objet com.adobe.livecycle.assembler.client.AssemblerResult contenant les documents PDF désassemblés et les exceptions survenues.

8. Enregistrez les documents PDF déassemblés.

   Pour obtenir les documents PDF déassemblés, effectuez les actions suivantes :

   • Appelez la méthode AssemblerResult de l’objet getDocuments. Cette méthode renvoie un objet java.util.Map.
   • Effectuez une itération dans l'objet java.util.Map jusqu'à ce que vous trouviez l'objet com.adobe.idp.Document obtenu.
   • Appelez la méthode com.adobe.idp.Document de l’objet copyToFile pour extraire le document PDF.

Voir également

Début rapide (mode SOAP) : Création dynamique d’un document DDX à l’aide de l’API Java

Inclusion des fichiers de bibliothèque Java AEM Forms

Réglage des propriétés de la connexion

Création dynamique d’un document DDX à l’aide de l’API de service Web

Créez de manière dynamique un document DDX et désassemblez un document PDF à l’aide de l’API Assembler Service (service Web) :

1. Incluez des fichiers de projet.

   Créez un projet Microsoft .NET qui utilise MTOM. Assurez-vous d’utiliser la définition WSDL suivante lors de la définition d’une référence de service : http://localhost:8080/soap/services/AssemblerService?WSDL&lc_version=9.0.1.

   REMARQUE

   Remplacez localhost par l’adresse IP du serveur hébergeant AEM Forms.

2. Créez un client PDF Assembler.

   • Créez un objet AssemblerServiceClient en utilisant son constructeur par défaut.

   • Créez un objet AssemblerServiceClient.Endpoint.Address en utilisant le constructeur System.ServiceModel.EndpointAddress. Transmettez une valeur de chaîne qui spécifie le WSDL au service AEM Forms (par exemple, http://localhost:8080/soap/services/AssemblerService?blob=mtom). Vous n'avez pas besoin d'utiliser l'attribut lc_version. Cet attribut est utilisé lorsque vous créez une référence de service.

   • Créez un objet System.ServiceModel.BasicHttpBinding en obtenant la valeur du champ AssemblerServiceClient.Endpoint.Binding. Convertissez la valeur de retour en BasicHttpBinding.

   • Définissez le champ MessageEncoding de l’objet System.ServiceModel.BasicHttpBinding sur WSMessageEncoding.Mtom. Cette valeur garantit l’utilisation de MTOM.

   • Activez l’authentification HTTP de base en exécutant les tâches suivantes :

     • Attribuez le nom d’utilisateur AEM forms au champ AssemblerServiceClient.ClientCredentials.UserName.UserName.
     • Attribuez la valeur de mot de passe correspondante au champ AssemblerServiceClient.ClientCredentials.UserName.Password.
     • Affectez la valeur constante HttpClientCredentialType.Basic au champ BasicHttpBindingSecurity.Transport.ClientCredentialType.
     • Affectez la valeur constante BasicHttpSecurityMode.TransportCredentialOnly au champ BasicHttpBindingSecurity.Security.Mode.

3. Créez le document DDX.

   • Créez un objet System.Xml.XmlElement en utilisant son constructeur.

   • Créez l’élément racine du document DDX en appelant la méthode XmlElement de l’objet CreateElement. Cette méthode crée un objet Element qui représente l’élément racine. Transmettez une valeur de chaîne représentant le nom de l’élément à la méthode CreateElement. Définissez une valeur pour l’élément DDX en appelant sa méthode SetAttribute. Enfin, ajoutez l’élément au document DDX en appelant la méthode XmlElement de l’objet AppendChild. Transférez l’objet DDX en argument. Les lignes de code suivantes présentent cette logique d’application :

      System.Xml.XmlElement root = ddx.CreateElement("DDX");  root.SetAttribute("xmlns", "https://ns.adobe.com/DDX/1.0/");  ddx.AppendChild(root);

   • Créez l’élément PDFsFromBookmarks du document DDX en appelant la méthode XmlElement de l’objet CreateElement. Transmettez une valeur de chaîne représentant le nom de l’élément à la méthode CreateElement. Ensuite, définissez une valeur pour l’élément en appelant sa méthode SetAttribute. Ajoutez l’élément PDFsFromBookmarks à l’élément racine en appelant la méthode AppendChild de l’élément DDX. Transmettez l'objet d'élément PDFsFromBookmarks en argument. Les lignes de code suivantes présentent cette logique d’application :

      XmlElement PDFsFromBookmarks = ddx.CreateElement("PDFsFromBookmarks");  PDFsFromBookmarks.SetAttribute("prefix", "stmt");  root.AppendChild(PDFsFromBookmarks);

   • Créez l’élément PDF du document DDX en appelant la méthode XmlElement de l’objet CreateElement. Transmettez une valeur de chaîne représentant le nom de l’élément à la méthode CreateElement. Ensuite, définissez une valeur pour l’élément enfant en appelant sa méthode SetAttribute. Ajoutez l’élément PDF à l’élément PDFsFromBookmarks en appelant la méthode PDFsFromBookmarks de l’élément AppendChild. Transmettez l'objet d'élément PDF en argument. Les lignes de code suivantes présentent cette logique d’application :

      XmlElement PDF = ddx.CreateElement("PDF");  PDF.SetAttribute("source", "AssemblerResultPDF.pdf");  PDFsFromBookmarks.AppendChild(PDF);

4. Conversion du document DDX.

   • Créez un objet System.IO.MemoryStream en utilisant son constructeur.

   • Renseignez l’objet MemoryStream avec le document DDX en utilisant l’objet XmlElement qui représente le document DDX. Appelez la méthode XmlElement de l'objet Save et transmettez l'objet MemoryStream.

   • Créez un tableau d’octets et remplissez-le avec les données situées dans l’objet MemoryStream. Le code suivant affiche cette logique d’application :

      int bufLen = Convert.ToInt32(stream.Length);  byte[] byteArray = new byte[bufLen];  stream.Position = 0;  int count = stream.Read(byteArray, 0, bufLen);

   • Créez un objet BLOB. Affectez le tableau d’octets au champ MTOM de l’objet BLOB.

5. Référencez un document PDF à désassembler.

   • Créez un objet BLOB en utilisant son constructeur. L’objet BLOB est utilisé pour stocker le document PDF d’entrée. Cet objet BLOB est transmis à invokeOneDocument en tant qu'argument.
   • Créez un objet System.IO.FileStream en appelant son constructeur. Transmettez une valeur de chaîne qui représente l’emplacement du fichier du document PDF d’entrée et le mode d’ouverture du fichier.
   • Créez un tableau d’octets qui stocke le contenu de l’objet System.IO.FileStream. Vous pouvez déterminer la taille du tableau d’octets en obtenant la propriété System.IO.FileStream de l’objet Length.
   • Renseignez le tableau d’octets avec les données de flux en appelant la méthode System.IO.FileStream de l’objet Read et en transmettant le tableau d’octets, la position de départ et la longueur du flux à lire.
   • Renseignez l’objet BLOB en attribuant sa propriété MTOM au contenu du tableau d’octets.

6. Définissez les options d’exécution.

   • Créez un objet AssemblerOptionSpec qui stocke les options d’exécution à l’aide de son constructeur.
   • Définissez des options d'exécution pour répondre aux besoins de votre entreprise en attribuant une valeur à un membre de données qui appartient à l'objet AssemblerOptionSpec. Par exemple, pour demander au service Assembler de continuer à traiter une tâche en cas d’erreur, affectez false au membre de données failOnError de l’objet AssemblerOptionSpec.

7. Désassemblez le document PDF.

   Appelez la méthode invokeDDX de l’objet AssemblerServiceClient et transmettez les valeurs suivantes :

   • Un objet BLOB qui représente le document DDX créé de manière dynamique
   • Tableau mapItem contenant le document PDF d’entrée
   • Objet AssemblerOptionSpec qui spécifie les options d’exécution

   La méthode invokeDDX renvoie un objet AssemblerResult contenant les résultats de la tâche et les exceptions survenues.

8. Enregistrez les documents PDF déassemblés.

   Pour obtenir les documents PDF nouvellement créés, effectuez les opérations suivantes :

   • Accédez au champ documents de l’objet AssemblerResult, qui est un objet Map contenant les documents PDF désassemblés.
   • Effectuez une itération dans l'objet Map pour obtenir chaque document cible. Ensuite, définissez value sur BLOB.
   • Extrayez les données binaires qui représentent le document PDF en accédant à la propriété BLOB MTOM de l’objet. Cette opération renvoie un tableau d’octets que vous pouvez écrire dans un fichier PDF.

Voir également

Appel de AEM Forms à l’aide de MTOM

Appel de AEM Forms à l’aide de SwaRef