Création d’applications web qui renvoient Forms

Les exemples et les exemples de ce document sont réservés à l’environnement AEM Forms on JEE.

Création d’applications web qui renvoient Forms

Vous pouvez créer une application web qui utilise des servlets Java pour appeler le service Forms et générer des formulaires. L’utilisation d’une servlet Java™ présente l’avantage de permettre d’écrire la valeur renvoyée par le processus dans un navigateur Web client. En d’autres termes, un servlet Java peut être utilisé comme lien entre le service Forms qui renvoie un formulaire et un navigateur web client.

A l’aide d’un servlet Java, vous pouvez écrire un formulaire dans un navigateur Web client afin qu’un client puisse afficher et saisir des données dans le formulaire. Après avoir rempli le formulaire avec des données, l’utilisateur web clique sur un bouton d’envoi situé sur le formulaire pour renvoyer les informations au servlet Java, où les données peuvent être récupérées et traitées. Par exemple, les données peuvent être envoyées à un autre processus.

Cette section explique comment créer une application web qui permet à l’utilisateur de sélectionner soit des données de formulaire américaines, soit des données de formulaire canadiennes, comme illustré ci-dessous.

Le formulaire rendu est un formulaire basé sur des fragments. En d’autres termes, si l’utilisateur sélectionne des données américaines, le formulaire renvoyé utilise des fragments basés sur des données américaines. Par exemple, le pied de page du formulaire contient une adresse américaine, comme illustré ci-dessous.

De même, si l'utilisateur sélectionne des données canadiennes, le formulaire renvoyé contient une adresse canadienne, comme le montre l'illustration suivante.

Exemples de fichiers

Cette section utilise des fichiers d’exemple qui peuvent se trouver à l’emplacement suivant :

<>Répertoire d’installation de Forms Designer >/Samples/Forms/Purchase Order/Form Fragments

où "a0/>install directory est le chemin d’installation. Pour les besoins de l’application cliente, le fichier Purchase Order Dynamic.xdp a été copié à partir de cet emplacement d’installation et déployé vers une application Forms nommée Applications/FormsApplication. Le fichier Purchase Order Dynamic.xdp est placé dans un dossier nommé FormsFolder. De même, les fragments sont placés dans un dossier nommé Fragments, comme illustré ci-dessous.

Pour accéder à la conception de formulaire Purchase Order Dynamic.xdp, indiquez Applications/FormsApplication/1.0/FormsFolder/Purchase Order Dynamic.xdp comme nom de formulaire (premier paramètre transmis à la méthode renderPDFForm) et repository:/// comme valeur d’URI racine du contenu.

Les fichiers de données XML utilisés par l’application web ont été déplacés du dossier Data vers C:\Adobe (système de fichiers appartenant au serveur d’applications J2EE hébergeant AEM Forms). Les noms de fichier sont Purchase Order Canada.xml et Purchase Order US.xml.

Résumé des étapes

Pour créer des applications web qui génèrent des formulaires à partir de fragments, procédez comme suit :

1. Créez un projet web.
2. Créez une logique d’application Java qui représente le servlet Java.
3. Créez la page web de l'application web.
4. Regroupez l’application web dans un fichier WAR.
5. Déployez le fichier WAR sur le serveur d’applications J2EE.
6. Testez votre application web.

Création d’un projet web

La première étape pour créer une application web contenant un servlet Java pouvant appeler le service Forms consiste à créer un projet web. L’IDE Java sur lequel repose ce document est Eclipse 3.3. À l’aide de l’IDE Eclipse, créez un projet web et ajoutez les fichiers JAR requis à votre projet. Enfin, ajoutez une page HTML nommée index.html et une servlet Java à votre projet.

La liste suivante indique les fichiers JAR que vous devez ajouter à votre projet web :

• adobe-forms-client.jar
• adobe-livecycle-client.jar
• adobe-usermanager-client.jar
• adobe-utilities.jar

Pour connaître l’emplacement de ces fichiers JAR, voir Inclusion des fichiers de bibliothèque Java AEM Forms.

Pour créer un projet web :

1. Démarrez Eclipse et cliquez sur Fichier > Nouveau projet.
2. Dans la boîte de dialogue Nouveau projet, sélectionnez Web > Projet Web dynamique.
3. Saisissez FragmentsWebApplication pour le nom de votre projet, puis cliquez sur Terminer.

Pour ajouter les fichiers JAR requis à votre projet :

1. Dans la fenêtre Explorateur de projets, cliquez avec le bouton droit sur le projet FragmentsWebApplication et sélectionnez Propriétés.
2. Cliquez sur Chemin de la version Java, puis sur l’onglet Bibliothèques.
3. Cliquez sur le bouton Ajouter des fichiers JAR externes et accédez aux fichiers JAR à inclure.

Pour ajouter une servlet Java au projet :

1. Dans la fenêtre Explorateur de projets, cliquez avec le bouton droit sur le projet FragmentsWebApplication et sélectionnez Nouveau > Autre.
2. Développez le dossier Web, sélectionnez Servlet, puis cliquez sur Suivant.
3. Dans la boîte de dialogue Créer un servlet, saisissez RenderFormFragment pour le nom du servlet, puis cliquez sur Terminer.

Pour ajouter une page HTML à votre projet :

1. Dans la fenêtre Explorateur de projets, cliquez avec le bouton droit sur le projet FragmentsWebApplication et sélectionnez Nouveau > Autre.
2. Développez le dossier Web, sélectionnez HTML, puis cliquez sur Suivant.
3. Dans la boîte de dialogue Nouveau HTML, saisissez index.html pour le nom du fichier, puis cliquez sur Terminer.

Création d’une logique d’application Java pour le servlet

Vous créez une logique d’application Java qui appelle le service Forms depuis le servlet Java. Le code suivant affiche la syntaxe du servlet Java RenderFormFragment :

     public class RenderFormFragment extends HttpServlet implements Servlet {
         public void doGet(HttpServletRequest req, HttpServletResponse resp
         throws ServletException, IOException {
         doPost(req,resp);
 
         }
         public void doPost(HttpServletRequest req, HttpServletResponse resp
         throws ServletException, IOException {
             //Add code here to invoke the Forms service
             }

Normalement, vous ne placez pas de code client dans la méthode doGet ou doPost d’une servlet Java. Une meilleure pratique de programmation consiste à placer ce code dans une classe distincte, à instancier la classe à partir de la méthode doPost (ou de la méthode doGet) et à appeler les méthodes appropriées. Toutefois, pour des raisons de concision du code, les exemples de code de cette section sont conservés au minimum et les exemples de code sont placés dans la méthode doPost .

Pour générer un formulaire basé sur des fragments à l’aide de l’API du service Forms, effectuez les tâches suivantes :

1. Incluez les fichiers JAR client, tels que adobe-forms-client.jar, dans le chemin de classe de votre projet Java. Pour plus d’informations sur l’emplacement de ces fichiers, voir Inclusion des fichiers de bibliothèque Java AEM Forms.

2. Récupérez la valeur du bouton radio qui est envoyé à partir du formulaire HTML et indiquez s’il faut utiliser des données américaines ou canadiennes. Si American est envoyé, créez une com.adobe.idp.Document qui stocke les données situées dans la balise Purchase Order US.xml. De même, si elle est canadienne, créez un com.adobe.idp.Document qui stocke les données situées dans le fichier Purchase Order Canada.xml.

3. Créez un objet ServiceClientFactory qui contient des propriétés de connexion. (Voir Réglage des propriétés de la connexion.)

4. Créez un objet FormsServiceClient en utilisant son constructeur et en transmettant l’objet ServiceClientFactory.

5. Créez un objet URLSpec qui stocke les valeurs URI à l’aide de son constructeur.

6. Appelez la méthode setApplicationWebRoot de l’objet URLSpec et transmettez une valeur string qui représente la racine web de l’application.

7. Appelez la méthode setContentRootURI de l’objet URLSpec et transmettez une valeur string qui spécifie la valeur de l’URI racine du contenu. Assurez-vous que la conception de formulaire et les fragments se trouvent dans l’URI racine du contenu. Dans le cas contraire, le service Forms renvoie une exception. Pour référencer le référentiel AEM Forms, spécifiez repository://.

8. Appelez la méthode setTargetURL de l’objet URLSpec et transmettez une valeur string qui spécifie la valeur de l’URL cible à l’endroit où les données de formulaire sont publiées. Si vous définissez l’URL cible dans la conception de formulaire, vous pouvez transmettre une chaîne vide. Vous pouvez également spécifier l’URL vers laquelle un formulaire est envoyé pour effectuer les calculs.

9. Appelez la méthode renderPDFForm de l’objet FormsServiceClient et transmettez les valeurs suivantes :

   • Une valeur string qui spécifie le nom de la conception de formulaire, y compris l’extension du nom de fichier.
   • Objet com.adobe.idp.Document contenant les données à fusionner avec le formulaire (créé à l’étape 2).
   • Objet PDFFormRenderSpec qui stocke les options d’exécution. Pour plus d’informations, voir Référence de l’API AEM Forms.
   • Objet URLSpec contenant les valeurs URI requises par le service Forms pour générer un formulaire basé sur des fragments.
   • Objet java.util.HashMap qui stocke les pièces jointes. Il s’agit d’un paramètre facultatif qui vous permet de spécifier null si vous ne souhaitez pas joindre de fichiers au formulaire.

   La méthode renderPDFForm renvoie un objet FormsResult contenant un flux de données de formulaire qui doit être écrit dans le navigateur Web client.

10. Créez un objet com.adobe.idp.Document en appelant la méthode FormsResult de l’objet getOutputContent.

11. Obtenez le type de contenu de l’objet com.adobe.idp.Document en appelant sa méthode getContentType.

12. Définissez le type de contenu de l’objet javax.servlet.http.HttpServletResponse en appelant sa méthode setContentType et en transmettant le type de contenu de l’objet com.adobe.idp.Document.

13. Créez un objet javax.servlet.ServletOutputStream utilisé pour écrire le flux de données de formulaire dans le navigateur Web client en appelant la méthode getOutputStream de l’objet javax.servlet.http.HttpServletResponse.

14. Créez un objet java.io.InputStream en appelant la méthode getInputStream de l’objet com.adobe.idp.Document.

15. Créez un tableau d’octets pour le remplir avec le flux de données de formulaire en appelant la méthode InputStream de l’objet readet en transmettant le tableau d’octets en tant qu’argument.

16. Appelez la méthode write de l’objet javax.servlet.ServletOutputStream pour envoyer le flux de données de formulaire au navigateur Web client. Transmettez le tableau d’octets à la méthode write .

L’exemple de code suivant représente le servlet Java qui appelle le service Forms et effectue le rendu d’un formulaire basé sur des fragments.

 /*
     * This Java Quick Start uses the following JAR files
     * 1. adobe-forms-client.jar
     * 2. adobe-livecycle-client.jar
     * 3. adobe-usermanager-client.jar
     *
     * (Because Forms quick starts are implemented as Java servlets, it is
     * not necessary to include J2EE specific JAR files - the Java project
     * that contains this quick start is exported as a WAR file which
     * is deployed to the J2EE application server)
     *
     * These JAR files are located in the following path:
     * <install directory>/sdk/client-libs
     *
     * For complete details about the location of these JAR files,
     * see "Including AEM Forms library files" in Programming with AEM forms
     */
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.IOException;
 import java.io.PrintWriter;
 
 import javax.servlet.Servlet;
 import javax.servlet.ServletException;
 import javax.servlet.ServletOutputStream;
 import javax.servlet.http.HttpServlet;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import com.adobe.livecycle.formsservice.client.*;
 import java.util.*;
 import java.io.InputStream;
 import java.net.URL;
 
 import com.adobe.idp.Document;
 import com.adobe.idp.dsc.clientsdk.ServiceClientFactory;
 import com.adobe.idp.dsc.clientsdk.ServiceClientFactoryProperties;
 
 public class RenderFormFragment extends HttpServlet implements Servlet {
 
     public void doGet(HttpServletRequest req, HttpServletResponse resp)
         throws ServletException, IOException {
             doPost(req,resp);
 
     }
     public void doPost(HttpServletRequest req, HttpServletResponse resp)
     throws ServletException, IOException {
 
 
 
         try{
             //Set connection properties required to invoke AEM Forms
             Properties connectionProps = new Properties();
             connectionProps.setProperty(ServiceClientFactoryProperties.DSC_DEFAULT_SOAP_ENDPOINT, "https://'[server]:[port]'");
             connectionProps.setProperty(ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL,ServiceClientFactoryProperties.DSC_SOAP_PROTOCOL);
             connectionProps.setProperty(ServiceClientFactoryProperties.DSC_SERVER_TYPE, "JBoss");
             connectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_USERNAME, "administrator");
             connectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_PASSWORD, "password");
 
             //Get the value of selected radio button
             String radioValue = req.getParameter("radio");
 
             //Create an Document object to store form data
             Document oInputData = null;
 
             //The value of the radio button determines the form data to use
             //which determines which fragments used in the form
             if (radioValue.compareTo("AMERICAN") == 0)            {
                 FileInputStream myData = new FileInputStream("C:\\Adobe\Purchase Order US.xml");
                 oInputData = new Document(myData);
             }
             else if (radioValue.compareTo("CANADIAN") == 0)            {
                 FileInputStream myData = new FileInputStream("C:\\Adobe\Purchase Order Canada.xml");
                 oInputData = new Document(myData);
             }
 
             //Create a ServiceClientFactory object
             ServiceClientFactory myFactory = ServiceClientFactory.createInstance(connectionProps);
 
             //Create a FormsServiceClient object
             FormsServiceClient formsClient = new FormsServiceClient(myFactory);
 
             //Set the parameter values for the renderPDFForm method
             String formName = "Applications/FormsApplication/1.0/FormsFolder/Purchase Order Dynamic.xdp";
 
             //Cache the PDF form
             PDFFormRenderSpec pdfFormRenderSpec = new PDFFormRenderSpec();
             pdfFormRenderSpec.setCacheEnabled(new Boolean(true));
 
             //Specify URI values that are required to render a form
             //design based on fragments
             URLSpec uriValues = new URLSpec();
             uriValues.setApplicationWebRoot("https://'[server]:[port]'/RenderFormFragment");
             uriValues.setContentRootURI("repository:///");
             uriValues.setTargetURL("https://'[server]:[port]'/FormsServiceClientApp/HandleData");
 
             //Invoke the renderPDFForm method and write the
             //results to a client web browser
             FormsResult formOut = formsClient.renderPDFForm(
                         formName,               //formQuery
                         oInputData,             //inDataDoc
                         pdfFormRenderSpec,      //PDFFormRenderSpec
                         uriValues,                //urlSpec
                         null                    //attachments
                         );
 
             //Create a Document object that stores form data
             Document myData = formOut.getOutputContent();
 
             //Get the content type of the response and
             //set the HttpServletResponse object’s content type
             String contentType = myData.getContentType();
             resp.setContentType(contentType);
 
             //Create a ServletOutputStream object
             ServletOutputStream oOutput = resp.getOutputStream();
 
             //Create an InputStream object
             InputStream inputStream = myData.getInputStream();
 
             //Write the data stream to the web browser
             byte[] data = new byte[4096];
             int bytesRead = 0;
             while ((bytesRead = inputStream.read(data)) > 0)
             {
                 oOutput.write(data, 0, bytesRead);
             }
 
         }catch (Exception e) {
              System.out.println("The following exception occurred: "+e.getMessage());
       }
     }
 }

Création de la page web

La page web index.html fournit un point d’entrée au servlet Java et appelle le service Forms. Cette page web est un formulaire HTML de base qui contient deux boutons radio et un bouton d’envoi. Le nom des boutons radio est radio. Lorsque l’utilisateur clique sur le bouton d’envoi, les données de formulaire sont publiées sur le servlet Java RenderFormFragment.

Le servlet Java capture les données publiées à partir de la page HTML à l’aide du code Java suivant :

             Document oInputData = null;
 
             //Get the value of selected radio button
             String radioValue = req.getParameter("radio");
 
             //The value of the radio button determines the form data to use
             //which determines which fragments used in the form
             if (radioValue.compareTo("AMERICAN") == 0)            {
                 FileInputStream myData = new FileInputStream("C:\\Adobe\Purchase Order US.xml");
                 oInputData = new Document(myData);
             }
             else if (radioValue.compareTo("CANADIAN") == 0)            {
                 FileInputStream myData = new FileInputStream("C:\\Adobe\Purchase Order Canada.xml");
                 oInputData = new Document(myData);
             }

Le code HTML suivant se trouve dans le fichier index.html créé lors de la configuration de l’environnement de développement. (Voir Création d’un projet web.)

 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="https://www.w3.org/1999/xhtml">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <title>Untitled Document</title>
 </head>
 
 <body>
 <form name="myform" action="https://'[server]:[port]'/FragmentsWebApplication/RenderFormFragment" method="post">
      <table>
      <tr>
        <th>Forms Fragment Web Client</th>
      </tr>
      <tr>
        <td>
          <label>
          <input type="radio" name="radio" id="radio_Data" value="CANADIAN" />
          Canadian data<br />
          </label>
          <p>
            <label>
            <input type="radio" name="radio" id="radio_Data" value="AMERICAN" checked/>
            American data</label>
          </p>
        </td>
      </tr>
      <tr>
      <td>
        <label>
          <input type="submit" name="button_Submit" id="button_Submit" value="Submit" />
            </label>
            </td>
         </tr>
        </table>
      </form>
 </body>
 </html>

Regroupement de l’application web

Pour déployer le servlet Java qui appelle le service Forms, compressez votre application web dans un fichier WAR. Assurez-vous que les fichiers JAR externes dont dépend la logique métier du composant, tels que adobe-livecycle-client.jar et adobe-forms-client.jar, sont également inclus dans le fichier WAR.

Pour compresser une application web dans un fichier WAR :

1. Dans la fenêtre Explorateur de projets, cliquez avec le bouton droit sur le projet FragmentsWebApplication et sélectionnez Exporter > Fichier WAR.
2. Dans la zone de texte Module Web, saisissez FragmentsWebApplication pour le nom du projet Java.
3. Dans la zone de texte Destination, saisissez FragmentsWebApplication.warpour le nom de fichier, indiquez l’emplacement de votre fichier WAR, puis cliquez sur Terminer.

Déploiement du fichier WAR sur le serveur d’applications J2EE

Vous pouvez déployer le fichier WAR sur le serveur d’applications J2EE sur lequel AEM Forms est déployé. Une fois le fichier WAR déployé, vous pouvez accéder à la page Web HTML à l’aide d’un navigateur Web.

Pour déployer le fichier WAR sur le serveur d’applications J2EE :

• Copiez le fichier WAR du chemin d’exportation vers [Forms Install]\Adobe\Adobe Experience Manager Forms\jboss\server\all\deploy.

Test de votre application web

Une fois l’application web déployée, vous pouvez la tester à l’aide d’un navigateur web. En supposant que vous utilisiez le même ordinateur qui héberge AEM Forms, vous pouvez spécifier l’URL suivante :

• http://localhost:8080/FragmentsWebApplication/index.html

  Sélectionnez un bouton radio et cliquez sur le bouton Envoyer . Un formulaire basé sur des fragments apparaît dans le navigateur web. En cas de problème, consultez le fichier journal du serveur d’applications J2EE.