Administrar formularios enviados handling-submitted-forms
Los ejemplos de este documento solo son para AEM Forms en un entorno JEE.
Las aplicaciones basadas en Web que permiten a un usuario rellenar formularios interactivos requieren que los datos se devuelvan al servidor. Con el servicio Forms, puede recuperar los datos introducidos por el usuario en un formulario interactivo. Una vez recuperados los datos, puede procesarlos para satisfacer sus necesidades empresariales. Por ejemplo, puede almacenar los datos en una base de datos, enviarlos a otra aplicación, enviarlos a otro servicio, combinar los datos en un diseño de formulario, mostrar los datos en un explorador web, etc.
Los datos de formulario se envían al servicio Forms como datos XML o de PDF, que es una opción que se establece en Designer. Un formulario enviado como XML permite extraer valores de datos de campo individuales. Es decir, puede extraer el valor de cada campo de formulario que el usuario haya introducido en el formulario. Un formulario enviado como datos de PDF son datos binarios, no datos XML. Puede guardar el formulario como archivo de PDF o enviarlo a otro servicio. Si desea extraer datos de un formulario enviado como XML y, a continuación, utilizar los datos del formulario para crear un documento de PDF, invoque otra operación de AEM Forms. (Consulte Crear documentos de PDF con datos XML enviados)
El diagrama siguiente muestra los datos que se envían a un servlet Java denominado HandleData
desde un formulario interactivo que se muestra en un explorador web.
En la tabla siguiente se explican los pasos del diagrama.
HandleData
Servlet Java como datos XML.HandleData
Java Servlet contiene lógica de aplicación para recuperar los datos.Administrar los datos XML enviados handling-submitted-xml-data
Cuando los datos del formulario se envían como XML, puede recuperar datos XML que representen los datos enviados. Todos los campos de formulario aparecen como nodos en un esquema XML. Los valores de nodo corresponden a los valores que rellenó el usuario. Imagine un formulario de préstamo en el que cada campo del formulario aparece como un nodo dentro de los datos XML. El valor de cada nodo corresponde al valor que rellena un usuario. Supongamos que un usuario rellena el formulario de préstamo con los datos que se muestran en el siguiente formulario.
La siguiente ilustración muestra los datos XML correspondientes que se recuperan mediante la API de cliente del servicio de Forms.
Los campos del formulario de préstamo. Estos valores se pueden recuperar mediante clases XML de Java.
Gestión de datos de PDF enviados handling-submitted-pdf-data
Considere una aplicación web que invoque el servicio de Forms. Una vez que el servicio Forms procesa un formulario interactivo de PDF en un explorador web de cliente, el usuario rellena el formulario y lo vuelve a enviar como datos de PDF. Cuando el servicio de Forms recibe los datos del PDF PDF, puede enviarlos a otro servicio o guardarlos como un archivo de PDF. El diagrama siguiente muestra el flujo lógico de la aplicación.
En la tabla siguiente se describen los pasos de este diagrama.
Gestión de los datos de URL enviados UTF-16 handling-submitted-url-utf-16-data
Si los datos del formulario se envían como datos UTF-16 de la dirección URL, el equipo cliente requiere Adobe Reader o Acrobat 8.1 o posterior. Además, si el diseño de formulario contiene un botón de envío con codificación de datos URL (HTTP Post) y la opción de codificación de datos es UTF-16, el diseño de formulario debe modificarse en un editor de texto como el Bloc de notas. Puede establecer la opción de codificación en UTF-16LE
o UTF-16BE
para el botón enviar. Designer no proporciona esta funcionalidad.
Resumen de los pasos summary-of-steps
Para gestionar los formularios enviados, realice las siguientes tareas:
- Incluir archivos de proyecto.
- Cree un objeto de API de cliente de Forms.
- Recuperar datos de formulario.
- Determine si el envío del formulario contiene archivos adjuntos.
- Procesar los datos enviados.
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. Si utiliza la API de Java, cree un FormsServiceClient
objeto. Si utiliza la API del servicio web de Forms, cree un FormsService
objeto.
Recuperar datos de formulario
Para recuperar los datos de formulario enviados, invoque el método FormsServiceClient
del objeto processFormSubmission
método. Al invocar este método, debe especificar el tipo de contenido del formulario enviado. Cuando los datos se envían desde un explorador web de cliente al servicio de Forms, pueden enviarse como datos XML o de PDF. Para recuperar los datos introducidos en los campos del formulario, los datos se pueden enviar como datos XML.
También puede recuperar campos de formulario de un formulario enviado como datos de PDF estableciendo las siguientes opciones en tiempo de ejecución:
- Pase el siguiente valor a
processFormSubmission
como parámetro de tipo de contenido:CONTENT_TYPE=application/pdf
. - Configure las variables
RenderOptionsSpec
del objetoPDFToXDP
valor hastatrue
- Configure las variables
RenderOptionsSpec
del objetoExportDataFormat
valor hastaXMLData
Especifique el tipo de contenido del formulario enviado al invocar el processFormSubmission
método. La siguiente lista especifica los valores de tipo de contenido aplicables:
- text/xml: representa el tipo de contenido que se utiliza cuando un formulario de PDF envía datos de formulario como XML.
- application/x-www-form-urlencoded: representa el tipo de contenido que se utiliza cuando un formulario de HTML envía datos como XML.
- application/pdf: representa el tipo de contenido que se utiliza cuando un formulario de PDF envía datos como PDF.
application/pdf
. El Inicio rápido Gestión de PDF forms enviados como XML mediante la API de Java muestra cómo gestionar los datos XML enviados desde un formulario de PDF. El tipo de contenido especificado en este inicio rápido es text/xml
. Del mismo modo, el Inicio rápido Administrar formularios de HTML enviados como XML mediante la API de Java muestra cómo administrar los datos XML enviados desde un formulario de HTML. El tipo de contenido especificado en este inicio rápido es application/x-www-form-urlencoded.Los datos de formulario que se publicaron en el servicio Forms se recuperan y se determina su estado de procesamiento. Es decir, cuando se envían datos al servicio de Forms, no significa necesariamente que el servicio de Forms haya terminado de procesar los datos y que estos estén listos para procesarse. Por ejemplo, se pueden enviar datos al servicio Forms para poder realizar un cálculo. Cuando se completa el cálculo, el formulario se devuelve al usuario con los resultados del cálculo mostrados. Antes de procesar los datos enviados, se recomienda determinar si el servicio Forms ha terminado de procesar los datos.
El servicio Forms devuelve los siguientes valores para indicar si ha terminado de procesar los datos:
- 0 (Enviar): Los datos enviados están listos para procesarse.
- 1 (Calcular): El servicio Forms realizó una operación de cálculo de los datos y los resultados deben devolverse al usuario.
- 2 (Validar): El servicio Forms validó los datos del formulario y los resultados deben devolverse al usuario.
- 3 (Siguiente): La página actual ha cambiado con resultados que deben escribirse en la aplicación cliente.
- 4 (Anterior)): La página actual ha cambiado con resultados que deben escribirse en la aplicación cliente.
Determinar si el envío del formulario contiene archivos adjuntos
Forms enviado al servicio Forms puede contener archivos adjuntos. Por ejemplo, con el panel de archivos adjuntos integrado de Acrobat, un usuario puede seleccionar archivos adjuntos para enviarlos junto con el formulario. Además, un usuario también puede seleccionar archivos adjuntos mediante una barra de herramientas del HTML que se representa con un archivo del HTML.
Después de determinar si un formulario contiene archivos adjuntos, puede procesar los datos. Por ejemplo, puede guardar el archivo adjunto en el sistema de archivos local.
Procesamiento de los datos enviados
Según el tipo de contenido de los datos enviados, puede extraer valores de campo de formulario individuales de los datos XML enviados o guardar los datos del PDF enviado como un archivo de PDF (o enviarlos a otro servicio). Para extraer campos de formulario individuales, convierta los datos XML enviados a una fuente de datos XML y, a continuación, recupere los valores de la fuente de datos XML utilizando org.w3c.dom
clases.
Consulte también
Incluir archivos de biblioteca Java de AEM Forms
Estableciendo propiedades de conexión
Inicio rápido de la API del servicio de Forms
Pasar documentos al servicio de Forms
Crear aplicaciones web que procesen Forms
Administrar formularios enviados mediante la API de Java handle-submitted-forms-using-the-java-api
Administrar un formulario enviado mediante la API de Forms (Java):
-
Incluir archivos de proyecto
Incluya archivos JAR de cliente, como adobe-forms-client.jar, en la ruta de clase del proyecto Java.
-
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 objetoServiceClientFactory
objeto.
- Crear un
-
Recuperar datos de formulario
- Para recuperar datos de formulario publicados en un servlet Java, cree un
com.adobe.idp.Document
mediante su constructor e invocando al objetojavax.servlet.http.HttpServletResponse
del objetogetInputStream
dentro del constructor. - Crear un
RenderOptionsSpec
mediante su constructor. Establezca el valor locale invocando elRenderOptionsSpec
del objetosetLocale
y pasando un valor de cadena que especifica el valor de configuración regional.
note note NOTE Puede indicar al servicio Forms que cree datos XDP o XML a partir del contenido de PDF enviado invocando el RenderOptionsSpec
del objetosetPDF2XDP
método y pasotrue
y también llamando asetXMLData
y pasandotrue
. A continuación, puede invocar elFormsResult
del objetogetOutputXML
para recuperar los datos XML correspondientes a los datos XDP/XML. (LaFormsResult
el objeto es devuelto por elprocessFormSubmission
método, que se explica en el siguiente subpaso).-
Invoque el
FormsServiceClient
del objetoprocessFormSubmission
y pasar los siguientes valores:- El
com.adobe.idp.Document
que contiene los datos del formulario. - Un valor de cadena que especifica variables de entorno, incluidos todos los encabezados HTTP relevantes. Especifique el tipo de contenido que desea gestionar. Para gestionar datos XML, especifique el siguiente valor de cadena para este parámetro:
CONTENT_TYPE=text/xml
. Para gestionar los datos del PDF, especifique el siguiente valor de cadena para este parámetro:CONTENT_TYPE=application/pdf
. - Un valor de cadena que especifica la variable
HTTP_USER_AGENT
valor de encabezado, por ejemplo, .Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)
. Este valor de parámetro es opcional. - A
RenderOptionsSpec
que almacena opciones en tiempo de ejecución.
El
processFormSubmission
El método devuelve un valorFormsResult
que contiene los resultados del envío del formulario. - El
-
Determine si el servicio Forms ha terminado de procesar los datos del formulario invocando el
FormsResult
del objetogetAction
método. Si este método devuelve el valor0
, los datos están listos para procesarse.
- Para recuperar datos de formulario publicados en un servlet Java, cree un
-
Determinar si el envío del formulario contiene archivos adjuntos
- Invoque el
FormsResult
del objetogetAttachments
método. Este método devuelve unjava.util.List
que contiene los archivos enviados con el formulario. - Itere a través de
java.util.List
para determinar si hay archivos adjuntos. Si hay archivos adjuntos, cada elemento es uncom.adobe.idp.Document
ejemplo. Puede guardar los archivos adjuntos invocando la variablecom.adobe.idp.Document
del objetocopyToFile
método y pasar unjava.io.File
objeto.
note note NOTE Este paso solo es aplicable si el formulario se envía como PDF. - Invoque el
-
Procesamiento de los datos enviados
-
Si el tipo de contenido de datos es
application/vnd.adobe.xdp+xml
otext/xml
, cree lógica de aplicación para recuperar valores de datos XML.- Crear un
com.adobe.idp.Document
invocando el objeto deFormsResult
del objetogetOutputContent
método. - Crear un
java.io.InputStream
invocando el objeto dejava.io.DataInputStream
y pasando elcom.adobe.idp.Document
objeto. - Crear un
org.w3c.dom.DocumentBuilderFactory
llamando a la función estáticaorg.w3c.dom.DocumentBuilderFactory
del objetonewInstance
método. - Crear un
org.w3c.dom.DocumentBuilder
invocando el objeto deorg.w3c.dom.DocumentBuilderFactory
del objetonewDocumentBuilder
método. - Crear un
org.w3c.dom.Document
invocando el objeto deorg.w3c.dom.DocumentBuilder
del objetoparse
y pasando eljava.io.InputStream
objeto. - Recupere el valor de cada nodo dentro del documento XML. Una forma de realizar esta tarea es crear un método personalizado que acepte dos parámetros:
org.w3c.dom.Document
y el nombre del nodo cuyo valor desea recuperar. Este método devuelve un valor de cadena que representa el valor del nodo. En el ejemplo de código que sigue este proceso, se llama a este método personalizadogetNodeText
. Se muestra el cuerpo de este método.
- Crear un
-
Si el tipo de contenido de datos es
application/pdf
, cree una lógica de aplicación para guardar los datos del PDF enviado como un archivo de PDF.- Crear un
com.adobe.idp.Document
invocando el objeto deFormsResult
del objetogetOutputContent
método. - Crear un
java.io.File
mediante su constructor público. Asegúrese de especificar PDF como la extensión del nombre de archivo. - Rellene el archivo del PDF invocando el
com.adobe.idp.Document
del objetocopyToFile
y pasando eljava.io.File
objeto.
- Crear un
-
Consulte también
Inicio rápido (modo SOAP): Gestión de PDF forms enviados como XML mediante la API de Java
Inicio rápido (modo SOAP): Gestión de PDF forms enviados como PDF mediante la API de Java
Incluir archivos de biblioteca Java de AEM Forms
Estableciendo propiedades de conexión
Administrar los datos de los PDF enviados mediante la API del servicio web handle-submitted-pdf-data-using-the-web-service-api
Administrar un formulario enviado mediante la API de Forms (servicio web):
-
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.
-
Crear un objeto de API de cliente de Forms
Crear un
FormsService
y establezca los valores de autenticación. -
Recuperar datos de formulario
-
Para recuperar datos de formulario publicados en un servlet Java, cree un
BLOB
mediante su constructor. -
Crear un
java.io.InputStream
invocando el objeto dejavax.servlet.http.HttpServletResponse
del objetogetInputStream
método. -
Crear un
java.io.ByteArrayOutputStream
utilizando su constructor y pasando la longitud del objetojava.io.InputStream
objeto. -
Copie el contenido del
java.io.InputStream
en eljava.io.ByteArrayOutputStream
objeto. -
Cree una matriz de bytes invocando el método
java.io.ByteArrayOutputStream
del objetotoByteArray
método. -
Rellene el
BLOB
invocando su objetosetBinaryData
y pasando la matriz de bytes como argumento. -
Crear un
RenderOptionsSpec
mediante su constructor. Establezca el valor locale invocando elRenderOptionsSpec
del objetosetLocale
y pasando un valor de cadena que especifica el valor de configuración regional. -
Invoque el
FormsService
del objetoprocessFormSubmission
y pasar los siguientes valores:- El
BLOB
que contiene los datos del formulario. - Un valor de cadena que especifica variables de entorno, incluidos todos los encabezados HTTP relevantes. Especifique el tipo de contenido que desea gestionar. Para gestionar datos XML, especifique el siguiente valor de cadena para este parámetro:
CONTENT_TYPE=text/xml
. Para gestionar los datos del PDF, especifique el siguiente valor de cadena para este parámetro:CONTENT_TYPE=application/pdf
. - Un valor de cadena que especifica la variable
HTTP_USER_AGENT
valor del encabezado; por ejemplo,Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)
. - A
RenderOptionsSpec
que almacena opciones en tiempo de ejecución. - Un vacío
BLOBHolder
objeto que rellena el método. - Un vacío
javax.xml.rpc.holders.StringHolder
objeto que rellena el método. - Un vacío
BLOBHolder
objeto que rellena el método. - Un vacío
BLOBHolder
objeto que rellena el método. - Un vacío
javax.xml.rpc.holders.ShortHolder
objeto que rellena el método. - Un vacío
MyArrayOf_xsd_anyTypeHolder
objeto que rellena el método. Este parámetro se utiliza para almacenar los archivos adjuntos enviados junto con el formulario. - Un vacío
FormsResultHolder
que rellena el método con el formulario que se envía.
El
processFormSubmission
rellena el métodoFormsResultHolder
con los resultados del envío del formulario. - El
-
Determine si el servicio Forms ha terminado de procesar los datos del formulario invocando el
FormsResult
del objetogetAction
método. Si este método devuelve el valor0
, los datos del formulario están listos para procesarse. Puede obtener unaFormsResult
al obtener el valor de la variableFormsResultHolder
del objetovalue
miembro de datos.
-
-
Determinar si el envío del formulario contiene archivos adjuntos
Obtener el valor de
MyArrayOf_xsd_anyTypeHolder
del objetovalue
miembro de datos (elMyArrayOf_xsd_anyTypeHolder
se pasó alprocessFormSubmission
método). Este miembro de datos devuelve una matriz deObjects
. Cada elemento dentro deObject
la matriz es unObject
que corresponde a los archivos enviados junto con el formulario. Puede obtener cada elemento dentro de la matriz y convertirlo en unBLOB
objeto. -
Procesamiento de los datos enviados
-
Si el tipo de contenido de datos es
application/vnd.adobe.xdp+xml
otext/xml
, cree lógica de aplicación para recuperar valores de datos XML.- Crear un
BLOB
invocando el objeto deFormsResult
del objetogetOutputContent
método. - Cree una matriz de bytes invocando el método
BLOB
del objetogetBinaryData
método. - Crear un
java.io.InputStream
invocando el objeto dejava.io.ByteArrayInputStream
y pasando la matriz de bytes. - Crear un
org.w3c.dom.DocumentBuilderFactory
llamando a la función estáticaorg.w3c.dom.DocumentBuilderFactory
del objetonewInstance
método. - Crear un
org.w3c.dom.DocumentBuilder
invocando el objeto deorg.w3c.dom.DocumentBuilderFactory
del objetonewDocumentBuilder
método. - Crear un
org.w3c.dom.Document
invocando el objeto deorg.w3c.dom.DocumentBuilder
del objetoparse
y pasando eljava.io.InputStream
objeto. - Recupere el valor de cada nodo dentro del documento XML. Una forma de realizar esta tarea es crear un método personalizado que acepte dos parámetros:
org.w3c.dom.Document
y el nombre del nodo cuyo valor desea recuperar. Este método devuelve un valor de cadena que representa el valor del nodo. En el ejemplo de código que sigue este proceso, se llama a este método personalizadogetNodeText
. Se muestra el cuerpo de este método.
- Crear un
-
Si el tipo de contenido de datos es
application/pdf
, cree una lógica de aplicación para guardar los datos del PDF enviado como un archivo de PDF.- Crear un
BLOB
invocando el objeto deFormsResult
del objetogetOutputContent
método. - Cree una matriz de bytes invocando el método
BLOB
del objetogetBinaryData
método. - Crear un
java.io.File
mediante su constructor público. Asegúrese de especificar PDF como la extensión del nombre de archivo. - Crear un
java.io.FileOutputStream
usando su constructor y pasando el objetojava.io.File
objeto. - Rellene el archivo del PDF invocando el
java.io.FileOutputStream
del objetowrite
y pasando la matriz de bytes.
- Crear un
-
Consulte también
Invocar AEM Forms con codificación Base64