Crear aplicaciones web que procesen Forms

Los ejemplos de este documento solo son para AEM Forms en un entorno JEE.

Crear aplicaciones web que procesen Forms

Puede crear una aplicación basada en web que utilice servlets Java para invocar el servicio de Forms y procesar formularios. Una ventaja de utilizar un servlet Java™ es que puede escribir el valor devuelto del proceso en un explorador web de cliente. Es decir, se puede utilizar un servlet Java como vínculo entre el servicio de Forms que devuelve un formulario y un explorador web de cliente.

Con un servlet Java, puede escribir un formulario en un explorador web de cliente para que un cliente pueda ver e introducir datos en el formulario. Después de rellenar el formulario con datos, el usuario web hace clic en un botón de envío ubicado en el formulario para enviar información de vuelta al servlet Java, donde los datos se pueden recuperar y procesar. Por ejemplo, los datos se pueden enviar a otro proceso.

En esta sección se explica cómo crear una aplicación basada en web que permita al usuario seleccionar datos de formulario basados en América o en Canadá, como se muestra en la siguiente ilustración.

El formulario que se procesa es un formulario basado en fragmentos. Es decir, si el usuario selecciona datos estadounidenses, el formulario devuelto utiliza fragmentos basados en datos estadounidenses. Por ejemplo, el pie de página del formulario contiene una dirección americana, como se muestra en la siguiente ilustración.

Del mismo modo, si el usuario selecciona datos canadienses, el formulario devuelto contendrá una dirección canadiense, como se muestra en la siguiente ilustración.

Archivos de muestra

Esta sección utiliza archivos de ejemplo que pueden estar en la siguiente ubicación:

<Directorio de instalación de Forms Designer>/Samples/Forms/Purchase Order/Form Fragments

donde <directorio de instalación> es la ruta de instalación. A los efectos de la aplicación cliente, el archivo de pedido de compra Dynamic.xdp se copió desde esta ubicación de instalación y se implementó en una aplicación de Forms denominada Aplicaciones/FormsApplication. El archivo Dynamic.xdp del pedido de compra se coloca en una carpeta denominada FormsFolder. Del mismo modo, los fragmentos se colocan en una carpeta denominada Fragmentos, como se muestra en la siguiente ilustración.

Para acceder al diseño de formulario Dynamic.xdp de la orden de compra, especifique Applications/FormsApplication/1.0/FormsFolder/Purchase Order Dynamic.xdp como nombre del formulario (el primer parámetro que se pasa a la variable renderPDFForm método) y repository:/// como el valor URI de la raíz de contenido.

Los archivos de datos XML utilizados por la aplicación web se movieron de la carpeta Data a C:\Adobe(el sistema de archivos que pertenece al servidor de aplicaciones J2EE que aloja AEM Forms). Los nombres de archivo son Orden de compra Canada.xml y orden de compra US.xml.

Resumen de los pasos

Para crear aplicaciones basadas en web que procesen formularios basados en fragmentos, realice los siguientes pasos:

1. Cree un proyecto web.
2. Cree la lógica de la aplicación Java que represente el servlet Java.
3. Cree la página web para la aplicación web.
4. Empaquete la aplicación web en un archivo WAR.
5. Implemente el archivo WAR en el servidor de aplicaciones J2EE.
6. Pruebe la aplicación web.

Creación de un proyecto web

El primer paso para crear una aplicación web que contenga un servlet Java que pueda invocar el servicio Forms es crear un proyecto web. El IDE de Java en el que se basa este documento es Eclipse 3.3. Con el IDE de Eclipse, cree un proyecto web y agregue los archivos JAR necesarios al proyecto. Finalmente, agregue una página de HTML llamada index.html y un servlet Java al proyecto.

La siguiente lista especifica los archivos JAR que debe agregar al proyecto web:

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

Para ver la ubicación de estos archivos JAR, consulte Incluir archivos de biblioteca Java de AEM Forms.

Para crear un proyecto web:

1. Inicie Eclipse y haga clic en Archivo > Nuevo proyecto.
2. En el Nuevo proyecto , seleccione Web > Proyecto web dinámico.
3. Tipo FragmentsWebApplication para el nombre del proyecto y, a continuación, haga clic en Finalizar.

Para agregar los archivos JAR necesarios al proyecto:

1. En la ventana Explorador de proyectos, haga clic con el botón secundario en el FragmentsWebApplication proyecto y seleccione Propiedades.
2. Clic Ruta de compilación de Java y, a continuación, haga clic en Bibliotecas pestaña.
3. Haga clic en Añadir JAR externos y busque los archivos JAR que desea incluir.

Para añadir un servlet Java al proyecto:

1. En la ventana Explorador de proyectos, haga clic con el botón secundario en el FragmentsWebApplication proyecto y seleccione Nuevo > Otros.
2. Expanda el Web carpeta, seleccione Servlet y haga clic en Siguiente.
3. En el cuadro de diálogo Crear servlet, escriba RenderFormFragment para el nombre del servlet y, a continuación, haga clic en Finalizar.

Para agregar una página de HTML al proyecto:

1. En la ventana Explorador de proyectos, haga clic con el botón secundario en el FragmentsWebApplication proyecto y seleccione Nuevo > Otros.
2. Expanda el Web carpeta, seleccione HTML y haga clic en Siguiente.
3. En el cuadro de diálogo Nuevo HTML, escriba index.html para el nombre de archivo y haga clic en Finalizar.

Creación de la lógica de la aplicación Java para el servlet

Puede crear una lógica de aplicación Java que invoque el servicio de Forms desde el servlet Java. El siguiente código muestra la sintaxis de la variable RenderFormFragment Servlet 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
             }

Normalmente, no colocaría el código de cliente dentro del de un servlet Java doGet o doPost método. Una práctica recomendada en programación es colocar este código en una clase independiente, crear instancias de la clase desde el doPost método (o doGet método) y llame a los métodos adecuados. Sin embargo, para que el código sea más breve, los ejemplos de código de esta sección se mantienen al mínimo y los ejemplos de código se colocan en el doPost método.

Para procesar un formulario basado en fragmentos mediante la API de servicio de Forms, realice las siguientes tareas:

1. Incluya archivos JAR de cliente, como adobe-forms-client.jar, en la ruta de clase del proyecto Java. Para obtener información acerca de la ubicación de estos archivos, consulte Incluir archivos de biblioteca Java de AEM Forms.

2. Recupere el valor del botón de opción enviado desde el formulario de HTML y especifica si se deben utilizar datos estadounidenses o canadienses. Si se envía American, cree un com.adobe.idp.Document que almacena datos en Pedido de compra US.xml. Del mismo modo, si es canadiense, cree un com.adobe.idp.Document que almacena datos en Pedido de compra Canada.xml archivo.

3. Crear un ServiceClientFactory que contiene las propiedades de conexión. (Consulte Estableciendo propiedades de conexión.)

4. Crear un FormsServiceClient usando su constructor y pasando el objeto ServiceClientFactory objeto.

5. Crear un URLSpec que almacena los valores de URI mediante su constructor.

6. Invoque el URLSpec del objeto setApplicationWebRoot y pase un valor de cadena que represente la raíz web de la aplicación.

7. Invoque el URLSpec del objeto setContentRootURI y pasan un valor de cadena que especifica el valor de URI de la raíz de contenido. Asegúrese de que el diseño de formulario y los fragmentos estén en el URI raíz de contenido. Si no es así, el servicio Forms genera una excepción. Para hacer referencia al repositorio de AEM Forms, especifique repository://.

8. Invoque el URLSpec del objeto setTargetURL y pasan un valor de cadena que especifica el valor de la dirección URL de destino donde se publican los datos del formulario. Si define la dirección URL de destino en el diseño de formulario, puede pasar una cadena vacía. También puede especificar la dirección URL a la que se envía un formulario para realizar cálculos.

9. Invoque el FormsServiceClient del objeto renderPDFForm y pasar los siguientes valores:

   • Un valor de cadena que especifica el nombre del diseño del formulario, incluida la extensión del nombre de archivo.
   • A com.adobe.idp.Document objeto que contiene datos para combinar con el formulario (creado en el paso 2).
   • A PDFFormRenderSpec que almacena opciones en tiempo de ejecución. Para obtener más información, consulte Referencia de API de AEM Forms.
   • A URLSpec que contiene valores de URI requeridos por el servicio Forms para procesar un formulario basado en fragmentos.
   • A java.util.HashMap que almacena archivos adjuntos. Este es un parámetro opcional y puede especificar null si no desea adjuntar archivos al formulario.

   El renderPDFForm El método devuelve un valor FormsResult que contiene un flujo de datos de formulario que debe escribirse en el explorador web cliente.

10. Crear un com.adobe.idp.Document invocando el objeto de FormsResult objeto ‘s getOutputContent método.

11. Obtenga el tipo de contenido del com.adobe.idp.Document invocando su objeto getContentType método.

12. Configure las variables javax.servlet.http.HttpServletResponse tipo de contenido del objeto invocando su setContentType y pasando el tipo de contenido del com.adobe.idp.Document objeto.

13. Crear un javax.servlet.ServletOutputStream objeto utilizado para escribir el flujo de datos de formulario en el explorador web del cliente invocando el javax.servlet.http.HttpServletResponse del objeto getOutputStream método.

14. Crear un java.io.InputStream invocando el objeto de com.adobe.idp.Document del objeto getInputStream método.

15. Cree una matriz de bytes y rellénela con el flujo de datos de formulario invocando el método InputStream del objeto ready pasando la matriz de bytes como argumento.

16. Invoque el javax.servlet.ServletOutputStream del objeto write para enviar el flujo de datos de formulario al explorador web del cliente. Pase la matriz de bytes a write método.

El siguiente ejemplo de código representa el servlet Java que invoca el servicio Forms y procesa un formulario basado en fragmentos.

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

Creación de la página web

La página web index.html proporciona un punto de entrada al servlet Java e invoca el servicio Forms. Esta página web es un formulario básico para HTML que contiene dos botones de opción y un botón de envío. El nombre de los botones de opción es radio. Cuando el usuario hace clic en el botón Enviar, los datos del formulario se publican en la RenderFormFragment Servlet Java.

El servlet Java captura los datos publicados desde la página del HTML mediante el siguiente código Java:

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

El siguiente código de HTML se encuentra en el archivo index.html que se creó durante la configuración del entorno de desarrollo. (Consulte Creación de un proyecto 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>

Empaquetado de la aplicación web

Para implementar el servlet Java que invoca el servicio Forms, empaquete la aplicación web en un archivo WAR. Asegúrese de que los archivos JAR externos de los que depende la lógica empresarial del componente, como adobe-livecycle-client.jar y adobe-forms-client.jar, también se incluyan en el archivo WAR.

Para empaquetar una aplicación web en un archivo WAR:

1. Desde el Explorador de proyectos , haga clic con el botón derecho en FragmentsWebApplication proyecto y seleccione Exportar > Archivo WAR.
2. En el Módulo web cuadro de texto, escriba FragmentsWebApplication para el nombre del proyecto Java.
3. En el Destino cuadro de texto, escriba FragmentsWebApplication.warpara el nombre de archivo, especifique la ubicación del archivo WAR y, a continuación, haga clic en Finalizar.

Implementación del archivo WAR en el servidor de aplicaciones J2EE

Puede implementar el archivo WAR en el servidor de aplicaciones J2EE en el que está implementado AEM Forms. Una vez implementado el archivo WAR, puede acceder a la página web del HTML mediante un explorador web.

Para desplegar el archivo WAR en el servidor de aplicaciones J2EE:

• Copie el archivo WAR de la ruta de exportación a [Forms Install]\Adobe\Adobe Experience Manager Forms\jboss\server\all\deploy.

Prueba de la aplicación web

Después de implementar la aplicación web, puede probarla con un explorador web. Si utiliza el mismo equipo que aloja AEM Forms, puede especificar la siguiente dirección URL:

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

  Seleccione un botón de opción y haga clic en el botón Enviar. Un formulario basado en fragmentos aparecerá en el explorador web. Si se producen problemas, consulte el archivo de registro del servidor de aplicaciones J2EE.