Webtoepassingen maken die Forms renderen

Webtoepassingen maken die Forms renderen

U kunt een webtoepassing maken die Java-servlets gebruikt om de Forms-service aan te roepen en formulieren te genereren. Een voordeel van het gebruik van een Java™ servlet is dat u de terugkeerwaarde van het proces aan cliëntbrowser kunt schrijven. Met andere woorden, een Java-servlet kan worden gebruikt als de koppeling tussen de Forms-service die een formulier retourneert en een clientwebbrowser.

OPMERKING

In deze sectie wordt beschreven hoe u een webtoepassing maakt die een Java-servlet gebruikt die de Forms-service aanroept en op fragmenten gebaseerde formulieren weergeeft. (Zie Forms renderen op basis van fragmenten.)

Met behulp van een Java-servlet kunt u een formulier naar een clientwebbrowser schrijven, zodat een klant gegevens in het formulier kan bekijken en invoeren. Nadat de webgebruiker het formulier met gegevens heeft gevuld, klikt hij op een verzendknop op het formulier om informatie terug te sturen naar de Java-server, waar de gegevens kunnen worden opgehaald en verwerkt. De gegevens kunnen bijvoorbeeld naar een ander proces worden verzonden.

In deze sectie wordt besproken hoe u een webtoepassing kunt maken waarmee de gebruiker op Amerika gebaseerde formuliergegevens of op Canada gebaseerde formuliergegevens kan selecteren, zoals in de volgende afbeelding wordt getoond.

cw_cw_fragmentwebclient

Het weergegeven formulier is een formulier dat is gebaseerd op fragmenten. Als de gebruiker Amerikaanse gegevens selecteert, gebruikt het geretourneerde formulier fragmenten op basis van Amerikaanse gegevens. De voettekst van het formulier bevat bijvoorbeeld een Amerikaans adres, zoals in de volgende afbeelding wordt getoond.

cw_cw_fragementformfooter

Als de gebruiker Canadese gegevens selecteert, bevat het geretourneerde formulier ook een Canadees adres, zoals in de volgende afbeelding wordt getoond.

cw_cw_fragementformfootercnd

OPMERKING

Zie Forms Designer voor informatie over het maken van formulierontwerpen op basis van fragmenten.

Voorbeeldbestanden

In deze sectie worden voorbeeldbestanden gebruikt die zich op de volgende locatie bevinden:

<>Forms Designer-installatiemap >/Samples/Forms/Purchase Order/Form Fragments

waarbij <installatiemap> het installatiepad is. Ten behoeve van de clienttoepassing is het bestand Purchase Order Dynamic.xdp gekopieerd van deze installatielocatie en geïmplementeerd in een Forms-toepassing met de naam Applications/FormsApplication. Het bestand Purchase Order Dynamic.xdp wordt in een map met de naam FormsFolder geplaatst. Op dezelfde manier worden de fragmenten in de map Fragments geplaatst, zoals in de volgende afbeelding wordt getoond.

cw_cw_fragmentsrepository

Als u toegang wilt krijgen tot het formulierontwerp Purchase Order Dynamic.xdp, geeft u Applications/FormsApplication/1.0/FormsFolder/Purchase Order Dynamic.xdp op als de formuliernaam (de eerste parameter die is doorgegeven aan de methode renderPDFForm) en repository:/// als de URI-waarde van de inhoudsbasis.

De XML-gegevensbestanden die door de webtoepassing worden gebruikt, zijn verplaatst van de map Data naar C:\Adobe (het bestandssysteem dat hoort bij de J2EE-toepassingsserver die als host fungeert voor AEM Forms). De bestandsnamen zijn Purchase Order Canada.xml en Purchase Order US.xml.

OPMERKING

Zie Workbench Help voor informatie over het maken van een Forms-toepassing met Workbench.

Overzicht van stappen

Voer de volgende stappen uit om een webtoepassing te maken die formulieren weergeeft op basis van fragmenten:

  1. Maak een nieuw webproject.
  2. Maak Java-toepassingslogica die de Java-servlet vertegenwoordigt.
  3. Maak de webpagina voor de webtoepassing.
  4. Verpak de Webtoepassing aan een dossier van WAR.
  5. Implementeer het WAR-bestand op de J2EE-toepassingsserver.
  6. Test uw webtoepassing.
OPMERKING

Sommige van deze stappen zijn afhankelijk van de J2EE-toepassing waarop AEM Forms wordt geïmplementeerd. De methode die u bijvoorbeeld gebruikt om een WAR-bestand te implementeren, is afhankelijk van de J2EE-toepassingsserver die u gebruikt. In deze sectie wordt ervan uitgegaan dat AEM Forms wordt geïmplementeerd op JBoss®.

Een webproject maken

De eerste stap voor het maken van een webtoepassing die een Java-servlet bevat die de Forms-service kan aanroepen, is het maken van een nieuw webproject. De Java-IDE waarop dit document is gebaseerd, is Eclipse 3.3. Gebruikend IDE van de Verduistering, creeer een Webproject en voeg de vereiste JAR dossiers aan uw project toe. Voeg ten slotte een HTML-pagina met de naam index.html en een Java-servlet toe aan uw project.

In de volgende lijst worden de JAR-bestanden weergegeven die u aan uw webproject moet toevoegen:

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

Zie Including AEM Forms Java-bibliotheekbestanden voor de locatie van deze JAR-bestanden.

Een webproject maken:

  1. Start Eclipse en klik op Bestand > Nieuw project.
  2. Selecteer Web > Dynamisch webproject in het dialoogvenster Nieuw project.
  3. Typ FragmentsWebApplication voor de naam van uw project en klik vervolgens op Voltooien.

U voegt als volgt vereiste JAR-bestanden toe aan uw project:

  1. Van het venster van de Ontdekkingsreiziger van het Project, klik het FragmentsWebApplication project met de rechtermuisknop aan en selecteer Eigenschappen.
  2. Klik Java-bouwpad en klik vervolgens op het tabblad Bibliotheken.
  3. Klik op de knop Externe JAR's toevoegen en blader naar de JAR-bestanden die u wilt opnemen.

Een Java-servlet toevoegen aan uw project:

  1. Van het venster van de Ontdekkingsreiziger van het Project, klik het FragmentsWebApplication project met de rechtermuisknop aan en selecteer Nieuw > Overig.
  2. Vouw de map Web uit, selecteer Servlet en klik vervolgens op Volgende.
  3. Typ RenderFormFragment voor de naam van de servlet in het dialoogvenster Servlet maken en klik vervolgens op Voltooien.

Een HTML-pagina toevoegen aan uw project:

  1. Van het venster van de Ontdekkingsreiziger van het Project, klik het FragmentsWebApplication project met de rechtermuisknop aan en selecteer Nieuw > Overig.
  2. Vouw de map Web uit, selecteer HTML en klik op Volgende.
  3. Typ index.html voor de bestandsnaam in het dialoogvenster Nieuwe HTML en klik vervolgens op Voltooien.
OPMERKING

Zie De webpagina maken voor informatie over het maken van de HTML-pagina die het Java-servlet RenderFormFragment activeert.

Java-toepassingslogica maken voor de servlet

U maakt Java-toepassingslogica die de Forms-service aanroept vanuit de Java-servlet. De volgende code toont de syntaxis van RenderFormFragment Servlet van Java:

     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
             }

Normaal gesproken plaatst u geen clientcode in een Java-servlet- of doGet-methode. doPost Een betere programmeringspraktijk moet deze code binnen een afzonderlijke klasse plaatsen, de klasse van binnen de doPost methode (of doGet methode) concretiseren, en de aangewezen methodes roepen. Voor de beknoptheid van de code worden de codevoorbeelden in deze sectie echter tot een minimum beperkt en worden codevoorbeelden in de methode doPost geplaatst.

Als u een formulier wilt genereren op basis van fragmenten met de API van de Forms-service, voert u de volgende taken uit:

  1. Neem client-JAR-bestanden, zoals adobe-forms-client.jar, op in het klassenpad van uw Java-project. Zie Including AEM Forms Java-bibliotheekbestanden voor informatie over de locatie van deze bestanden.

  2. Haal de waarde op van het keuzerondje dat vanuit het HTML-formulier wordt verzonden en geef aan of Amerikaanse of Canadese gegevens moeten worden gebruikt. Als American wordt verzonden, maakt u een com.adobe.idp.Document waarin de gegevens worden opgeslagen die zich bevinden in Purchase Order US.xml. Op dezelfde manier, als Canadees, creeer dan com.adobe.idp.Document die gegevens opslaat die in Inkooporder Canada.xml dossier worden gevestigd.

  3. Maak een ServiceClientFactory-object dat verbindingseigenschappen bevat. (Zie Verbindingseigenschappen instellen.)

  4. Maak een FormsServiceClient-object door de constructor ervan te gebruiken en het object ServiceClientFactory door te geven.

  5. Maak een object URLSpec waarin URI-waarden worden opgeslagen met behulp van de constructor.

  6. Roep de methode URLSpec van het object setApplicationWebRoot aan en geef een tekenreekswaarde door die de hoofdmap van de toepassing vertegenwoordigt.

  7. Roep de methode setContentRootURI van het object URLSpec aan en geef een tekenreekswaarde door die de URI-waarde van de inhoudsbasis opgeeft. Zorg ervoor dat het formulierontwerp en de fragmenten zich in de URI van de inhoudsbasis bevinden. Als niet, werpt de dienst van Forms een uitzondering. Als u naar de AEM Forms-opslagplaats wilt verwijzen, geeft u repository:// op.

  8. Roep de methode setTargetURL van het object URLSpec aan en geef een tekenreekswaarde door die de doel-URL-waarde opgeeft waar de formuliergegevens worden gepost. Als u de doel-URL in het formulierontwerp definieert, kunt u een lege tekenreeks doorgeven. U kunt ook de URL opgeven waarnaar een formulier wordt verzonden om berekeningen uit te voeren.

  9. Roep de methode renderPDFForm van het object FormsServiceClient aan en geef de volgende waarden door:

    • Een tekenreekswaarde die de naam van het formulierontwerp opgeeft, inclusief de bestandsnaamextensie.
    • Een object com.adobe.idp.Document dat gegevens bevat die met het formulier moeten worden samengevoegd (gemaakt in stap 2).
    • Een PDFFormRenderSpec-object dat uitvoeringsopties opslaat. Zie AEM Forms API Reference voor meer informatie.
    • Een object URLSpec dat URI-waarden bevat die door de Forms-service worden vereist om een formulier te genereren op basis van fragmenten.
    • Een java.util.HashMap-object dat bestandsbijlagen opslaat. Dit is een optionele parameter en u kunt null opgeven als u geen bestanden aan het formulier wilt koppelen.

    De methode renderPDFForm retourneert een FormsResult-object dat een formuliergegevensstroom bevat die naar de webbrowser van de client moet worden geschreven.

  10. Maak een com.adobe.idp.Document-object door de methode getOutputContent van het object aan te roepen.FormsResult

  11. Hiermee wordt het inhoudstype van het object com.adobe.idp.Document opgehaald door de methode getContentType ervan aan te roepen.

  12. Stel het inhoudstype van het object javax.servlet.http.HttpServletResponse in door de methode setContentType ervan aan te roepen en het inhoudstype van het object com.adobe.idp.Document door te geven.

  13. Maak een javax.servlet.ServletOutputStream-object dat wordt gebruikt om de formuliergegevensstroom naar de webbrowser van de client te schrijven door de methode javax.servlet.http.HttpServletResponse van het object getOutputStream aan te roepen.

  14. Maak een java.io.InputStream-object door de methode getInputStream van het object com.adobe.idp.Document aan te roepen.

  15. Maak een bytearray die deze met de formuliergegevensstroom vult door de methode readvan het object InputStream aan te roepen en de bytearray als een argument door te geven.

  16. Roep de methode javax.servlet.ServletOutputStream van het object write aan om de gegevensstroom van het formulier naar de webbrowser van de client te verzenden. Geef de bytearray door aan de methode write.

In het volgende codevoorbeeld ziet u het Java-servlet dat de Forms-service activeert en een formulier genereert op basis van fragmenten.

 /*
     * 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());
       }
     }
 }

De webpagina maken

De webpagina index.html biedt een ingangspunt voor de Java-server en roept de Forms-service aan. Deze webpagina is een standaard-HTML-formulier dat twee keuzerondjes en een verzendknop bevat. De naam van de keuzerondjes is keuzerondjes. Wanneer de gebruiker op de verzendknop klikt, worden formuliergegevens naar de Java-servlet RenderFormFragment gepost.

De Java-servlet legt de gegevens vast die vanuit de HTML-pagina zijn gepost met de volgende Java-code:

             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);
             }

De volgende HTML-code bevindt zich in het bestand index.html dat tijdens de installatie van de ontwikkelomgeving is gemaakt. (Zie Een webproject maken.)

 <!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>

De webtoepassing verpakken

Als u de Java-servlet wilt implementeren die de Forms-service aanroept, moet u uw webtoepassing verpakken naar een WAR-bestand. Zorg ervoor dat externe JAR-bestanden waarvan de bedrijfslogica van de component afhankelijk is, zoals adobe-livecycle-client.jar en adobe-forms-client.jar, ook worden opgenomen in het WAR-bestand.

Een webtoepassing verpakken naar een WAR-bestand:

  1. Klik in het venster Projectverkenner met de rechtermuisknop op het FragmentsWebApplication-project en selecteer Exporteren > WAR-bestand.
  2. Typ FragmentsWebApplication voor de naam van het Java-project in het tekstvak Webmodule.
  3. Typ FragmentsWebApplication.warin het tekstvak Doel voor de bestandsnaam de locatie voor het WAR-bestand en klik op Voltooien.

WAR-bestand gebruiken op de J2EE-toepassingsserver

U kunt het WAR-bestand implementeren op de J2EE-toepassingsserver waarop AEM Forms is geïmplementeerd. Nadat het WAR-bestand is geïmplementeerd, kunt u de HTML-webpagina openen met een webbrowser.

Het WAR-bestand implementeren op de J2EE-toepassingsserver:

  • Kopieer het WAR-bestand van het exportpad naar [Forms Install]\Adobe\Adobe Experience Manager Forms\jboss\server\all\deploy.

Uw webtoepassing testen

Nadat u de webtoepassing hebt geïmplementeerd, kunt u deze testen met een webbrowser. Ervan uitgaande dat u dezelfde computer gebruikt als die waarop AEM Forms wordt gehost, kunt u de volgende URL opgeven:

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

    Selecteer een keuzerondje en klik op Verzenden. Een formulier dat is gebaseerd op fragmenten, wordt weergegeven in de webbrowser. Als er problemen optreden, raadpleegt u het logbestand van de J2EE-toepassingsserver.

Op deze pagina