Procesar formularios basados en fragmentos

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

Procesar formularios basados en fragmentos

El servicio Forms puede procesar formularios basados en fragmentos creados con Designer. A 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 este 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 envueltos en un conjunto de subformularios de opción. Los conjuntos de subformularios de opción controlan la visualización de subformularios en función del flujo de datos desde 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 determinada y el subformulario que se muestra se puede determinar en función de la ubicación del usuario.

A fragmento de script contiene funciones o valores JavaScript reutilizables que se almacenan separadamente de cualquier objeto concreto, 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 el contenido y el aspecto de las partes de un diseño de formulario que se utilizan con frecuencia sean 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 script, los enlaces de datos, el diseño o los estilos de un fragmento, y todos los formularios XDP que hagan referencia a él 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 de 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.

Combinar un diseño de formulario ensamblado mediante fragmentos

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

Al utilizar el servicio Assembler, pasa un diseño de formulario que se ensambló mediante fragmentos. El diseño de formulario creado no hace referencia a otros fragmentos. Por el contrario, este tema trata sobre cómo pasar un diseño de formulario que hace referencia a otros fragmentos al servicio de Forms. Sin embargo, Assembler no ensambló 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 Crear 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 los 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.

Crear 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 pueda localizar el formulario y los fragmentos (los archivos XDP) a los que hace referencia el diseño de formulario. Por ejemplo, supongamos que el formulario se denomina PO.xdp y que utiliza dos fragmentos llamados FooterUS.xdp y FooterCanada.xdp. En este caso, el servicio Forms debe poder localizar los tres archivos XDP.

Puede organizar un formulario y sus fragmentos colocándolo en una ubicación y los fragmentos en otra ubicación, 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 cómo colocar archivos XDP en el repositorio de AEM Forms, consulte Recursos de escritura.

Al procesar un formulario basado en fragmentos, solo debe hacer referencia al propio formulario 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 Forms pueda localizarlos.

Procesar el formulario

Un formulario basado en fragmentos se puede procesar del mismo modo que los formularios no fragmentados. Es decir, puede procesar el formulario como PDF, HTML o guías del formulario (obsoleto). El ejemplo de esta sección procesa un formulario basado en fragmentos como un formulario PDF interactivo. (Consulte Procesamiento 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

Procesar formularios basados en fragmentos mediante la API de Java

Procesar formularios basados en fragmentos mediante la API de servicio web

Incluir archivos de biblioteca Java de AEM Forms

Estableciendo propiedades de conexión

Inicio rápido de la API del servicio de Forms

Procesar formularios PDF interactivos

Crear aplicaciones web que procesen Forms

Procesar formularios basados en fragmentos mediante la API de Java

Procesar un formulario basado en fragmentos mediante la API de Forms (Java):

  1. Incluir archivos de proyecto

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

  2. Crear un objeto de API de cliente de Forms

    • Crear un ServiceClientFactory que contiene las propiedades de conexión.
    • Crear un FormsServiceClient usando su constructor y pasando el objeto ServiceClientFactory objeto.

  3. Especificar valores de URI

    • Crear un URLSpec que almacena los valores de URI mediante su constructor.
    • Invoque el URLSpec del objeto setApplicationWebRoot y pase un valor de cadena que represente la raíz web de la aplicación.
    • 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 se encuentran en el URI raíz de contenido. Si no es así, el servicio Forms genera una excepción. Para hacer referencia al repositorio, especifique repository://.
    • 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.

  4. Procesar el formulario

    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. Si hace referencia a un diseño de formulario que forma parte de una aplicación de Forms, asegúrese de especificar la ruta de acceso completa, como Applications/FormsApplication/1.0/FormsFolder/Loan.xdp.
    • A com.adobe.idp.Document que contiene datos para combinar con el formulario. Si no desea combinar datos, pase un vacío com.adobe.idp.Document objeto.
    • A PDFFormRenderSpec que almacena opciones en tiempo de ejecución.
    • 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.

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

    • Crear un com.adobe.idp.Document invocando el objeto de FormsResult objeto ‘s getOutputContent método.
    • Obtenga el tipo de contenido del com.adobe.idp.Document invocando su objeto getContentType método.
    • 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.
    • 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.
    • Crear un java.io.InputStream invocando el objeto de com.adobe.idp.Document del objeto getInputStream método.
    • 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.
    • 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.

Consulte también

Procesar formularios basados en fragmentos

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

Incluir archivos de biblioteca Java de AEM Forms

Estableciendo propiedades de conexión

Procesar formularios basados en fragmentos mediante la API de servicio web

Procesar 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 de proxy Java en la ruta de clase.

  2. Crear un objeto de API de cliente de Forms

    Crear un FormsService y establezca los valores de autenticación.

  3. Especificar valores de URI

    • Crear un URLSpec que almacenan valores de URI utilizando su constructor.
    • Invoque el URLSpec del objeto setApplicationWebRoot y pase un valor de cadena que represente la raíz web de la aplicación.
    • 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 esté ubicado en el URI raíz del contenido. Si no es así, el servicio Forms genera una excepción. Para hacer referencia al repositorio, especifique repository://.
    • 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.

  4. Procesar el formulario

    Invoque el FormsService 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. Si hace referencia a un diseño de formulario que forma parte de una aplicación de Forms, asegúrese de especificar la ruta de acceso completa, como Applications/FormsApplication/1.0/FormsFolder/Loan.xdp.
    • A BLOB que contiene datos para combinar con el formulario. Si no desea combinar los datos, apruebe null.
    • A PDFFormRenderSpec que almacena opciones en tiempo de ejecución. Tenga en cuenta que la opción de PDF etiquetado no se puede establecer si el documento de entrada es un documento de PDF. Si el archivo de entrada es un archivo XDP, se puede establecer la opción de PDF etiquetado.
    • A URLSpec que contiene los valores de URI requeridos por el servicio Forms.
    • 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.
    • Un vacío com.adobe.idp.services.holders.BLOBHolder objeto que rellena el método. Este parámetro se utiliza para almacenar el formulario procesado.
    • Un vacío javax.xml.rpc.holders.LongHolder objeto que rellena el método. Este argumento almacenará el número de páginas en el formulario.
    • Un vacío javax.xml.rpc.holders.StringHolder objeto que rellena el método. Este argumento almacenará el valor de configuración regional.
    • Un vacío com.adobe.idp.services.holders.FormsResultHolder que contendrá los resultados de esta operación.

    El renderPDFForm rellena el método 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

    • Crear un FormResult al obtener el valor de la variable com.adobe.idp.services.holders.FormsResultHolder del objeto value miembro de datos.
    • Crear un BLOB que contiene datos de formulario invocando el FormsResult del objeto getOutputContent método.
    • Obtenga el tipo de contenido del BLOB invocando su objeto getContentType método.
    • Configure las variables javax.servlet.http.HttpServletResponse tipo de contenido del objeto invocando su setContentType y pasando el tipo de contenido del BLOB objeto.
    • 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.
    • Cree una matriz de bytes y rellénela invocando el método BLOB del objeto getBinaryData método. Esta tarea asigna el contenido del FormsResult a la matriz de bytes.
    • Invoque el javax.servlet.http.HttpServletResponse 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.

Consulte también

Procesar formularios basados en fragmentos

Invocar AEM Forms con codificación Base64

En esta página