Representación de Forms basada en fragmentos

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

Representación de Forms basada en fragmentos

El servicio Forms puede procesar formularios basados en fragmentos creados con Designer. Un fragmento es una parte reutilizable de un formulario y se guarda como un archivo XDP independiente que se puede insertar en varios diseños de formulario. Por ejemplo, un fragmento puede incluir un bloque de direcciones o texto legal.

El uso de fragmentos simplifica y acelera la creación y el mantenimiento de una gran cantidad de formularios. Al crear un nuevo formulario, inserte una referencia al fragmento requerido y éste aparecerá en el formulario. La referencia de fragmento contiene un subformulario que señala al archivo XDP físico. Para obtener información sobre la creación de diseños de formulario basados en fragmentos, consulte Forms Designer

Un fragmento puede incluir varios subformularios que se ajustan en un conjunto de subformularios de opciones. Los conjuntos de subformularios de opciones controlan la visualización de subformularios en función del flujo de datos de una conexión de datos. Se utilizan afirmaciones condicionales para determinar qué subformulario del conjunto aparece en el formulario entregado. Por ejemplo, cada subformulario de un conjunto puede incluir información de una ubicación geográfica concreta, y el subformulario que se muestra se puede determinar en función de la ubicación del usuario.

Un fragmento de secuencia de comandos contiene funciones o valores JavaScript reutilizables que se almacenan por separado de cualquier objeto en particular, como un analizador de fechas o una invocación de servicio Web. Estos fragmentos incluyen un único objeto de secuencia de comandos que aparece como un elemento secundario de variables en la paleta Jerarquía. Los fragmentos no pueden crearse a partir de secuencias de comandos que sean propiedades de otros objetos, tales como secuencias de comandos de sucesos validate, calculate o initialize.

Estas son las ventajas de utilizar fragmentos:

  • Reutilización de contenido: Puede utilizar fragmentos para reutilizar contenido en varios diseños de formulario. Cuando necesita utilizar parte del mismo contenido en varios formularios, es más rápido y sencillo utilizar un fragmento que copiar o volver a crear el contenido. El uso de fragmentos también garantiza que las partes de un diseño de formulario utilizadas con frecuencia tengan un contenido y un aspecto coherentes en todos los formularios de referencia.
  • Actualizaciones globales: Puede utilizar fragmentos para realizar cambios globales en varios formularios solo una vez, en un archivo. Puede cambiar el contenido, los objetos de secuencia de comandos, los enlaces de datos, la presentación o los estilos de un fragmento, y todos los formularios XDP que hagan referencia al fragmento reflejarán los cambios.
  • Por ejemplo, un elemento común en muchos formularios podría ser un bloque de direcciones que incluya un objeto de lista desplegable para el país. Si necesita actualizar los valores del objeto de lista desplegable, debe abrir muchos formularios para realizar los cambios. Si incluye el bloque de direcciones en un fragmento, solo necesita abrir un archivo de fragmento para realizar los cambios.
  • Para actualizar un fragmento en un formulario PDF, debe volver a guardar el formulario en Designer.
  • Creación de formularios compartidos: Puede utilizar fragmentos para compartir la creación de formularios entre varios recursos. Los desarrolladores de formularios con conocimientos de secuencias de comandos u otras funciones avanzadas de Designer pueden desarrollar y compartir fragmentos que aprovechan las secuencias de comandos y las propiedades dinámicas. Los diseñadores de formularios pueden utilizar tales fragmentos para presentar diseños de formulario y garantizar que todas las partes de un formulario tengan un aspecto y una funcionalidad coherentes en los múltiples formularios diseñados por varias personas.

Montaje de un diseño de formulario ensamblado mediante fragmentos

Puede ensamblar un diseño de formulario para pasarlo al servicio Forms basado en varios fragmentos. Para ensamblar varios fragmentos, utilice el servicio Assembler. Para ver un ejemplo del uso del servicio Ensamblar para crear un diseño de formulario utilizado por otros servicios de Forms (el servicio Output ), consulte Creación de documentos PDF utilizando fragmentos. En lugar de utilizar el servicio Output , puede realizar el mismo flujo de trabajo mediante el servicio Forms.

Al utilizar el servicio Assembler, se pasa un diseño de formulario que se ensambló con fragmentos. El diseño de formulario creado no hace referencia a otros fragmentos. Por el contrario, en este tema se trata el paso de un diseño de formulario que haga referencia a otros fragmentos al servicio Forms. Sin embargo, Assembler no montó el diseño de formulario. Se creó en Designer.

NOTA

Para obtener más información sobre el servicio Forms, consulte Referencia de servicios para AEM Forms.

NOTA

Para obtener información sobre la creación de una aplicación basada en web que procese formularios basados en fragmentos, consulte Creación de aplicaciones web que procesen Forms.

Resumen de los pasos

Para procesar un formulario basado en fragmentos, realice las siguientes tareas:

  1. Incluir archivos de proyecto.
  2. Cree un objeto de API de cliente de Forms.
  3. Especifique valores de URI.
  4. Procese el formulario.
  5. Escriba el flujo de datos del formulario en el explorador web del cliente.

Incluir archivos de proyecto

Incluya los archivos necesarios en el proyecto de desarrollo. Si está creando una aplicación cliente mediante Java, incluya los archivos JAR necesarios. Si utiliza servicios web, asegúrese de incluir los archivos proxy.

Creación de un objeto de API de cliente de Forms

Para poder realizar mediante programación una operación de API de cliente de servicio de Forms, debe crear un cliente de servicio de Forms.

Especificar valores de URI

Para procesar correctamente un formulario basado en fragmentos, debe asegurarse de que el servicio Forms puede localizar tanto el formulario como los fragmentos (archivos XDP) a los que hace referencia el diseño de formulario. Por ejemplo, supongamos que el formulario se denomina PO.xdp y que este formulario utiliza dos fragmentos llamados FooterUS.xdp y FooterCanada.xdp. En este caso, el servicio de Forms debe poder localizar los tres archivos XDP.

Puede organizar un formulario y sus fragmentos colocando el formulario en una ubicación y los fragmentos en otra, o bien puede colocar todos los archivos XDP en la misma ubicación. A los efectos de esta sección, supongamos que todos los archivos XDP se encuentran en el repositorio de AEM Forms. Para obtener información sobre la colocación de archivos XDP en el repositorio de AEM Forms, consulte Escritura de recursos.

Al procesar un formulario basado en fragmentos, debe hacer referencia únicamente al formulario en sí y no a los fragmentos. Por ejemplo, debe hacer referencia a PO.xdp y no a FooterUS.xdp o FooterCanada.xdp. Asegúrese de colocar los fragmentos en una ubicación en la que el servicio de Forms pueda localizarlos.

Procesamiento del formulario

Un formulario basado en fragmentos se puede procesar de la misma manera que los formularios no fragmentados. Es decir, puede procesar el formulario como PDF, HTML o guías de formulario (obsoleto). El ejemplo de esta sección procesa un formulario basado en fragmentos como un formulario PDF interactivo. (Consulte Representación de PDF forms interactivos).

Escribir el flujo de datos del formulario en el explorador web del cliente

Cuando el servicio Forms procesa un formulario, devuelve un flujo de datos de formulario que debe escribir en el explorador web del cliente. Cuando se escribe en el explorador web del cliente, el formulario es visible para el usuario.

Consulte también

Representar formularios en función de fragmentos mediante la API de Java

Representar formularios en función de fragmentos mediante la API de servicio web

Inclusión de archivos de biblioteca Java de AEM Forms

Configuración de las propiedades de conexión

Inicio rápido de la API del servicio de Forms

Renderización de PDF forms interactivos

Creación de aplicaciones web que procesen Forms

Representar formularios basados en fragmentos utilizando la API de Java

Representar un formulario basado en fragmentos utilizando la API de Forms (Java):

  1. Incluir archivos de proyecto

    Incluya archivos JAR del cliente, como adobe-forms-client.jar, en la ruta de clase de su proyecto Java.

  2. Creación de un objeto de API de cliente de Forms

    • Cree un objeto ServiceClientFactory que contenga propiedades de conexión.
    • Cree un objeto FormsServiceClient utilizando su constructor y pasando el objeto ServiceClientFactory.

  3. Especificar valores de URI

    • Cree un objeto URLSpec que almacene valores de URI usando su constructor.
    • Invoque el método URLSpec del objeto setApplicationWebRoot y pase un valor de cadena que represente la raíz web de la aplicación.
    • Invoque el método URLSpec del objeto setContentRootURI y pase un valor de cadena que especifique el valor de URI raíz del contenido. Asegúrese de que el diseño de formulario y los fragmentos se encuentran en el URI raíz del contenido. Si no es así, el servicio de Forms genera una excepción. Para hacer referencia al repositorio, especifique repository://.
    • Invoque el método URLSpec del objeto setTargetURL y pase un valor de cadena que especifique el valor de la dirección URL de destino donde se registran 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.

  4. Procesamiento del formulario

    Invoque el método FormsServiceClient del objeto renderPDFForm y pase los siguientes valores:

    • Un valor de cadena que especifica el nombre del diseño de formulario, incluida la extensión del nombre de archivo. Si hace referencia a un diseño de formulario que forma parte de una aplicación de Forms, asegúrese de especificar la ruta completa, como Applications/FormsApplication/1.0/FormsFolder/Loan.xdp.
    • Un objeto com.adobe.idp.Document que contiene datos para combinar con el formulario. Si no desea combinar datos, pase un objeto com.adobe.idp.Document vacío.
    • Un objeto PDFFormRenderSpec que almacena opciones en tiempo de ejecución.
    • Un objeto URLSpec que contiene valores de URI necesarios para el servicio Forms para procesar un formulario basado en fragmentos.
    • Un objeto java.util.HashMap que almacena archivos adjuntos. Se trata de un parámetro opcional y puede especificar null si no desea adjuntar archivos al formulario.

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

  5. Escribir el flujo de datos del formulario en el explorador web del cliente

    • Cree un objeto com.adobe.idp.Document invocando el método FormsResult del objeto ‘s getOutputContent.
    • Obtenga el tipo de contenido del objeto com.adobe.idp.Document invocando su método getContentType.
    • Establezca el tipo de contenido del objeto javax.servlet.http.HttpServletResponse invocando su método setContentType y pasando el tipo de contenido del objeto com.adobe.idp.Document.
    • Cree un objeto javax.servlet.ServletOutputStream que se utilice para escribir el flujo de datos del formulario en el explorador web del cliente invocando el método javax.servlet.http.HttpServletResponse del objeto getOutputStream.
    • Cree un objeto java.io.InputStream invocando el método com.adobe.idp.Document del objeto getInputStream.
    • Cree una matriz de bytes rellénela con la secuencia de datos del formulario invocando el método InputStream del objeto ready pasando la matriz de bytes como argumento.
    • Invoque el método javax.servlet.ServletOutputStream del objeto write para enviar la secuencia de datos del formulario al explorador web del cliente. Pase la matriz de bytes al método write.

Consulte también

Representación de Forms basada en fragmentos

Inicio rápido (modo SOAP): Representación de un formulario basado en fragmentos mediante la API de Java

Inclusión de archivos de biblioteca Java de AEM Forms

Configuración de las propiedades de conexión

Representar formularios basados en fragmentos utilizando la API de servicio web

Representar un formulario basado en fragmentos mediante la API de Forms (servicio web):

  1. Incluir archivos de proyecto

    • Cree clases de proxy Java que consuman el WSDL del servicio Forms.
    • Incluya las clases proxy de Java en la ruta de clase.

  2. Creación de un objeto de API de cliente de Forms

    Cree un objeto FormsService y establezca valores de autenticación.

  3. Especificar valores de URI

    • Cree un objeto URLSpec que almacene valores de URI usando su constructor.
    • Invoque el método URLSpec del objeto setApplicationWebRoot y pase un valor de cadena que represente la raíz web de la aplicación.
    • Invoque el método URLSpec del objeto setContentRootURI y pase un valor de cadena que especifique el valor de URI raíz del contenido. Asegúrese de que el diseño de formulario se encuentra en el URI raíz del contenido. Si no es así, el servicio de Forms genera una excepción. Para hacer referencia al repositorio, especifique repository://.
    • Invoque el método URLSpec del objeto setTargetURL y pase un valor de cadena que especifique el valor de la dirección URL de destino donde se registran 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.

  4. Procesamiento del formulario

    Invoque el método FormsService del objeto renderPDFForm y pase los siguientes valores:

    • Un valor de cadena que especifica el nombre del diseño de formulario, incluida la extensión del nombre de archivo. Si hace referencia a un diseño de formulario que forma parte de una aplicación de Forms, asegúrese de especificar la ruta completa, como Applications/FormsApplication/1.0/FormsFolder/Loan.xdp.
    • Un objeto BLOB que contiene datos para combinar con el formulario. Si no desea combinar datos, pase null.
    • Un objeto PDFFormRenderSpec que almacena opciones en tiempo de ejecución. Tenga en cuenta que la opción PDF con etiquetas no se puede establecer si el documento de entrada es un documento PDF. Si el archivo de entrada es un archivo XDP, se puede configurar la opción PDF con etiquetas.
    • Un objeto URLSpec que contiene valores de URI requeridos por el servicio de Forms.
    • Un objeto java.util.HashMap que almacena archivos adjuntos. Se trata de un parámetro opcional y puede especificar null si no desea adjuntar archivos al formulario.
    • Un objeto com.adobe.idp.services.holders.BLOBHolder vacío que se rellena con el método . Este parámetro se utiliza para almacenar el formulario procesado.
    • Un objeto javax.xml.rpc.holders.LongHolder vacío que se rellena con el método . Este argumento almacenará el número de páginas del formulario.
    • Un objeto javax.xml.rpc.holders.StringHolder vacío que se rellena con el método . Este argumento almacenará el valor de configuración regional.
    • Un objeto com.adobe.idp.services.holders.FormsResultHolder vacío que contendrá los resultados de esta operación.

    El método renderPDFForm rellena el objeto com.adobe.idp.services.holders.FormsResultHolder que se pasa como el último valor de argumento con un flujo de datos de formulario que debe escribirse en el explorador web del cliente.

  5. Escribir el flujo de datos del formulario en el explorador web del cliente

    • Cree un objeto FormResult obteniendo el valor del miembro de datos com.adobe.idp.services.holders.FormsResultHolder del objeto value.
    • Cree un objeto BLOB que contenga datos de formulario invocando el método FormsResult del objeto getOutputContent.
    • Obtenga el tipo de contenido del objeto BLOB invocando su método getContentType.
    • Establezca el tipo de contenido del objeto javax.servlet.http.HttpServletResponse invocando su método setContentType y pasando el tipo de contenido del objeto BLOB.
    • Cree un objeto javax.servlet.ServletOutputStream que se utilice para escribir el flujo de datos del formulario en el explorador web del cliente invocando el método javax.servlet.http.HttpServletResponse del objeto getOutputStream.
    • Cree una matriz de bytes y rellénela invocando el método BLOB del objeto getBinaryData. Esta tarea asigna el contenido del objeto FormsResult a la matriz de bytes.
    • Invoque el método javax.servlet.http.HttpServletResponse del objeto write para enviar la secuencia de datos del formulario al explorador web del cliente. Pase la matriz de bytes al método write.

Consulte también

Representación de Forms basada en fragmentos

Invocación de AEM Forms mediante la codificación Base64

En esta página