Procesar formularios PDF interactivos rendering-interactive-pdf-forms
Los ejemplos de este documento solo son para AEM Forms en un entorno JEE.
El servicio Forms procesa PDF forms interactivos en dispositivos cliente, normalmente exploradores web, para recopilar información de los usuarios. Una vez procesado un formulario interactivo, un usuario puede introducir datos en los campos de formulario y hacer clic en un botón de envío ubicado en el formulario para enviar información de vuelta al servicio de Forms. Adobe Reader o Acrobat deben estar instalados en el equipo que aloja el explorador web del cliente para que un formulario de PDF interactivo sea visible.
Ejemplo de solicitud de préstamo
Se presenta una aplicación de préstamo de ejemplo para demostrar cómo el servicio Forms utiliza formularios interactivos para recopilar información de los usuarios. Esta aplicación permite al usuario rellenar un formulario con los datos necesarios para obtener un préstamo y, a continuación, enviar datos al servicio de Forms. El diagrama siguiente muestra el flujo lógico de la aplicación del préstamo.
En la tabla siguiente se describen los pasos de este diagrama.
GetLoanForm
El servlet Java se invoca desde una página de HTML.GetLoanForm
Java Servlet utiliza la API del cliente del servicio de Forms para procesar el formulario de préstamo en el explorador web del cliente. (Consulte Procesar un formulario interactivo de PDF mediante la API de Java.)HandleData
Servlet Java. (Consulte "Formulario de préstamo".)HandleData
Java Servlet utiliza la API de cliente del servicio Forms para procesar el envío del formulario y recuperar los datos del formulario. A continuación, los datos se almacenan en una base de datos empresarial. (Consulte Gestión de Forms enviados.)Formulario de préstamo
Este formulario de préstamo interactivo lo procesa el administrador de la solicitud de préstamo de ejemplo GetLoanForm
Servlet Java.
Formulario de confirmación
Este formulario lo procesa el administrador de la solicitud de préstamo de ejemplo HandleData
Servlet Java.
El HandleData
Java Servlet rellena previamente este formulario con el nombre y los apellidos del usuario y la cantidad. Una vez rellenado previamente el formulario, se envía al explorador web del cliente. (Consulte Rellenado previo de Forms con diseños flexibles)
Servlets Java
La aplicación de préstamo de ejemplo es un ejemplo de una aplicación de servicio de Forms que existe como servlet Java. Un servlet Java es un programa Java que se ejecuta en un servidor de aplicaciones J2EE, como WebSphere, y contiene el código de API del cliente del servicio Forms.
El siguiente código muestra la sintaxis de un servlet Java denominado GetLoanForm:
public class GetLoanForm extends HttpServlet implements Servlet {
public void doGet(HttpServletRequest req, HttpServletResponse resp
throws ServletException, IOException {
}
public void doPost(HttpServletRequest req, HttpServletResponse resp
throws ServletException, IOException {
}
Normalmente, no colocaría el código de la API del cliente del servicio de Forms dentro de un servidor Java doGet
o doPost
método. Se recomienda colocar este código en una clase independiente, crear instancias de la clase desde dentro de 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.
Resumen de los pasos
Para procesar un formulario de PDF interactivo, realice las siguientes tareas:
- Incluir archivos de proyecto.
- Cree un objeto de API de cliente de Forms.
- Especifique los valores de URI.
- Adjuntar archivos al formulario (opcional).
- Procesar un formulario interactivo de PDF.
- 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 la API de cliente del servicio de Forms, debe crear un objeto de la API de cliente 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.
Especificar valores de URI
Puede especificar los valores de URI que requiere el servicio Forms para procesar un formulario. Se puede hacer referencia a un diseño de formulario que se guarda como parte de una aplicación de Forms mediante el valor URI de raíz de contenido repository:///
. Por ejemplo, considere el siguiente diseño de formulario denominado Loan.xdp ubicado en una aplicación de Forms denominada FormsApplication:
Para acceder a este diseño de formulario, especifique Applications/FormsApplication/1.0/FormsFolder/Loan.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.
La ruta a un recurso en una aplicación de Forms es:
Applications/Application-name/Application-version/Folder.../Filename
Los siguientes valores muestran algunos ejemplos de valores de URI:
- Applications/AppraisalReport/1.0/Forms/FullForm.xdp
- Applications/AnotherApp/1.1/Assets/picture.jpg
- Applications/SomeApp/2.0/Resources/Data/XSDs/MyData.xsd
Cuando procesa un formulario interactivo, puede definir valores de URI como la dirección URL de destino donde se publican los datos del formulario. La dirección URL de destino se puede definir de una de las siguientes maneras:
- Haga clic en el botón Enviar mientras diseña el diseño de formulario en Designer
- Mediante la API de cliente del servicio de Forms
Si la dirección URL de destino se define dentro del diseño de formulario, no la anule con la API de cliente del servicio de Forms. Es decir, al establecer la dirección URL de destino mediante la API de Forms, se restablece la dirección URL especificada en el diseño de formulario a la especificada mediante la API. Si desea enviar el formulario de PDF a la URL de destino especificada en el diseño de formulario, establezca mediante programación la URL de destino en una cadena vacía.
Si tiene un formulario que contiene un botón de envío y un botón de cálculo (con una secuencia de comandos correspondiente que se ejecuta en el servidor), puede definir mediante programación la dirección URL a la que se envía el formulario para ejecutar la secuencia de comandos. Utilice el botón de envío del diseño de formulario para especificar la dirección URL a la que se publican los datos del formulario. (Consulte Calcular datos de formulario.)
com.adobe.idp.Document
al servicio Forms. El com.adobe.idp.Document
La instancia de contiene un diseño de formulario. (Consulte Pasar documentos al servicio de Forms.)Adjuntar archivos al formulario
Puede adjuntar archivos a un formulario. Cuando procesa un formulario de PDF con archivos adjuntos, los usuarios pueden recuperar los archivos adjuntos en Acrobat mediante el panel de archivos adjuntos. Puede adjuntar distintos tipos de archivo a un formulario, como un archivo de texto, o a un archivo binario, como un archivo JPG.
Procesar un formulario interactivo de PDF
Para procesar un formulario, utilice un diseño de formulario creado en Designer y guardado como archivo XDP o de PDF. Además, puede procesar un formulario creado con Acrobat y guardado como archivo de PDF. Para procesar un formulario de PDF interactivo, invoque el FormsServiceClient
del objeto renderPDFForm
método o renderPDFForm2
método.
El renderPDFForm
utiliza un URLSpec
objeto. La raíz de contenido del archivo XDP se pasa al servicio de Forms mediante el URLSpec
del objeto setContentRootURI
método. El nombre del diseño del formulario ( formQuery
) se pasa como un valor de parámetro independiente. Los dos valores se concatenan para obtener la referencia absoluta al diseño de formulario.
El renderPDFForm2
El método acepta un com.adobe.idp.Document
que contiene el documento XDP o de PDF que se va a procesar.
Procesar un formulario interactivo de PDF mediante la API de Java render-an-interactive-pdf-form-using-the-java-api
Procesar un formulario interactivo de PDF 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
-
Especificar valores de URI
- Crear un
URLSpec
que almacena los valores de URI mediante su constructor. - Invoque el
URLSpec
del objetosetApplicationWebRoot
y pasar un valor de cadena que represente la raíz web de la aplicación. - Invoque el
URLSpec
del objetosetContentRootURI
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 del formulario esté en el URI raíz del contenido. Si no es así, el servicio Forms genera una excepción. Para hacer referencia al repositorio, especifiquerepository:///
. - Invoque el
URLSpec
del objetosetTargetURL
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.
- Crear un
-
Adjuntar archivos al formulario
-
Crear un
java.util.HashMap
para almacenar los archivos adjuntos mediante su constructor. -
Invoque el
java.util.HashMap
del objetoput
para que cada archivo se adjunte al formulario procesado. Pase los siguientes valores a este método:- Valor de cadena que especifica el nombre del archivo adjunto, incluida la extensión del nombre de archivo.
-
A
com.adobe.idp.Document
que contiene el archivo adjunto.
note note NOTE Repita este paso para cada archivo que desee adjuntar al formulario. Este paso es opcional y puede pasar null
si no desea enviar archivos adjuntos. -
-
Procesar un formulario interactivo de PDF
Invoque el
FormsServiceClient
del objetorenderPDFForm
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íocom.adobe.idp.Document
objeto. - A
PDFFormRenderSpec
que almacena opciones en tiempo de ejecución. Este es un parámetro opcional y puede especificarnull
si no desea especificar opciones en tiempo de ejecución. - A
URLSpec
que contiene valores de URI requeridos por el servicio de Forms. - A
java.util.HashMap
que almacena archivos adjuntos. Este es un parámetro opcional y puede especificarnull
si no desea adjuntar archivos al formulario.
El
renderPDFForm
El método devuelve un valorFormsResult
que contiene un flujo de datos de formulario que debe escribirse en el explorador web cliente. - 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
-
Escribir el flujo de datos del formulario en el explorador web del cliente
- Crear un
com.adobe.idp.Document
invocando el objeto deFormsResult
del objetogetOutputContent
método. - Obtenga el tipo de contenido del
com.adobe.idp.Document
invocando su objetogetContentType
método. - Configure las variables
javax.servlet.http.HttpServletResponse
tipo de contenido del objeto invocando susetContentType
y pasando el tipo de contenido delcom.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 eljavax.servlet.http.HttpServletResponse
del objetogetOutputStream
método. - Crear un
java.io.InputStream
invocando el objeto decom.adobe.idp.Document
del objetogetInputStream
método. - Cree una matriz de bytes y rellénela con el flujo de datos de formulario invocando el método
InputStream
del objetoread
y pasando la matriz de bytes como argumento. - Invoque el
javax.servlet.ServletOutputStream
del objetowrite
para enviar el flujo de datos de formulario al explorador web del cliente. Pase la matriz de bytes awrite
método.
- Crear un
Procesar un formulario interactivo de PDF mediante la API de servicio web render-an-interactive-pdf-form-using-the-web-service-api
Procesar un formulario interactivo de PDF 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. -
Especificar valores de URI
- Crear un
URLSpec
que almacena los valores de URI mediante su constructor. - Invoque el
URLSpec
del objetosetApplicationWebRoot
y pasar un valor de cadena que represente la raíz web de la aplicación. - Invoque el
URLSpec
del objetosetContentRootURI
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 del formulario esté en el URI raíz del contenido. Si no es así, el servicio Forms genera una excepción. Para hacer referencia al repositorio, especifiquerepository:///
. - Invoque el
URLSpec
del objetosetTargetURL
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.
- Crear un
-
Adjuntar archivos al formulario
-
Crear un
java.util.HashMap
para almacenar los archivos adjuntos mediante su constructor. -
Invoque el
java.util.HashMap
del objetoput
para que cada archivo se adjunte al formulario procesado. Pase los siguientes valores a este método:- Valor de cadena que especifica el nombre del archivo adjunto, incluida la extensión del nombre de archivo
-
A
BLOB
objeto que contiene el archivo adjunto
note note NOTE Repita este paso para cada archivo que desee adjuntar al formulario. -
-
Procesar un formulario interactivo de PDF
Invoque el
FormsService
del objetorenderPDFForm
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, apruebenull
. - A
PDFFormRenderSpec
que almacena opciones en tiempo de ejecución. Este es un parámetro opcional y puede especificarnull
si no desea especificar opciones en tiempo de ejecución. - A
URLSpec
que contiene valores de URI requeridos por el servicio de Forms. - A
java.util.HashMap
que almacena archivos adjuntos. Este es un parámetro opcional y puede especificarnull
si no desea adjuntar archivos al formulario. - Un vacío
com.adobe.idp.services.holders.BLOBHolder
objeto que rellena el método. Se utiliza para almacenar el formulario de PDF procesado. - Un vacío
javax.xml.rpc.holders.LongHolder
objeto que rellena el método. (Este argumento almacenará el número de páginas del 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étodocom.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. - 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
-
Escribir el flujo de datos del formulario en el explorador web del cliente
- Crear un
FormResult
al obtener el valor de la variablecom.adobe.idp.services.holders.FormsResultHolder
del objetovalue
miembro de datos. - Crear un
BLOB
que contiene datos de formulario invocando elFormsResult
del objetogetOutputContent
método. - Obtenga el tipo de contenido del
BLOB
invocando su objetogetContentType
método. - Configure las variables
javax.servlet.http.HttpServletResponse
tipo de contenido del objeto invocando susetContentType
y pasando el tipo de contenido delBLOB
objeto. - Crear un
javax.servlet.ServletOutputStream
objeto utilizado para escribir el flujo de datos de formulario en el explorador web del cliente invocando eljavax.servlet.http.HttpServletResponse
del objetogetOutputStream
método. - Cree una matriz de bytes y rellénela invocando el método
BLOB
del objetogetBinaryData
método. Esta tarea asigna el contenido delFormsResult
a la matriz de bytes. - Invoque el
javax.servlet.http.HttpServletResponse
del objetowrite
para enviar el flujo de datos de formulario al explorador web del cliente. Pase la matriz de bytes awrite
método.
- Crear un
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.