Manuseio de Forms enviado handling-submitted-forms
Os exemplos e amostras neste documento são somente para AEM Forms no ambiente JEE.
Aplicativos baseados na Web que permitem que um usuário preencha formulários interativos exigem que os dados sejam enviados de volta ao servidor. Usando o serviço Forms, você pode recuperar os dados inseridos pelo usuário em um formulário interativo. Após recuperar os dados, você pode processá-los para atender aos requisitos da empresa. Por exemplo, você pode armazenar os dados em um banco de dados, enviar os dados para outro aplicativo, enviar os dados para outro serviço, mesclar os dados em um design de formulário, exibir os dados em um navegador da Web e assim por diante.
Os dados de formulário são enviados ao serviço Forms como dados XML ou PDF, que é uma opção definida no Designer. Um formulário enviado como XML permite extrair valores de dados de campo individuais. Ou seja, você pode extrair o valor de cada campo de formulário inserido pelo usuário no formulário. Um formulário enviado como dados de PDF é um dado binário, não um dado XML. Você pode salvar o formulário como um arquivo PDF ou enviá-lo para outro serviço. Se quiser extrair dados de um formulário enviado como XML e, em seguida, usar os dados do formulário para criar um documento PDF, chame outra operação do AEM Forms. (Consulte Criação de documentos PDF com dados XML enviados)
O diagrama a seguir mostra os dados que estão sendo enviados para um Servlet Java chamado HandleData
de um formulário interativo exibido em um navegador da web.
A tabela a seguir explica as etapas do diagrama.
HandleData
Servlet Java como dados XML.HandleData
O Java Servlet contém a lógica do aplicativo para recuperar os dados.Manuseio de dados XML enviados handling-submitted-xml-data
Quando os dados do formulário forem enviados como XML, você poderá recuperar dados XML que representam os dados enviados. Todos os campos de formulário aparecem como nós em um esquema XML. Os valores do nó correspondem aos valores que o usuário preencheu. Considere um formulário de empréstimo em que cada campo no formulário aparece como um nó nos dados XML. O valor de cada nó corresponde ao valor que um usuário preenche. Suponha que um usuário preencha o formulário de empréstimo com os dados mostrados no formulário a seguir.
A ilustração a seguir mostra dados XML correspondentes que são recuperados usando a API do cliente de serviço do Forms.
Os campos no formulário de empréstimo. Esses valores podem ser recuperados usando classes Java XML.
Tratamento de dados de PDF enviados handling-submitted-pdf-data
Considere um aplicativo web que invoca o serviço Forms. Depois que o serviço Forms renderiza um formulário PDF interativo para um navegador web cliente, o usuário preenche o formulário e o envia de volta como dados PDF. Quando o serviço Forms recebe os dados de PDF, pode enviar os dados de PDF para outro serviço ou salvá-los como um arquivo PDF. O diagrama a seguir mostra o fluxo lógico do aplicativo.
A tabela a seguir descreve as etapas deste diagrama.
Manuseio de dados UTF-16 de URL enviado handling-submitted-url-utf-16-data
Se os dados de formulário forem enviados como dados URL UTF-16, o computador cliente exigirá o Adobe Reader ou Acrobat 8.1 ou posterior. Além disso, se o design do formulário contiver um botão de envio com dados codificados em URL (HTTP Post) e a opção de codificação de dados for UTF-16, o design do formulário deverá ser modificado em um editor de texto como o Notepad. Você pode definir a opção de codificação como UTF-16LE
ou UTF-16BE
para o botão enviar. O Designer não fornece essa funcionalidade.
Resumo das etapas summary-of-steps
Para controlar forms enviados, execute as seguintes tarefas:
- Incluir arquivos de projeto.
- Crie um objeto da API do cliente do Forms.
- Recuperar dados do formulário.
- Determine se o envio do formulário contém anexos de arquivo.
- Processe os dados enviados.
Incluir arquivos de projeto
Inclua os arquivos necessários no projeto de desenvolvimento. Se você estiver criando uma aplicação cliente usando Java, inclua os arquivos JAR necessários. Se você estiver usando serviços da Web, certifique-se de incluir os arquivos proxy.
Criar um objeto da API do cliente do Forms
Antes de executar programaticamente uma operação da API do cliente de serviço do Forms, você deve criar um cliente de serviço do Forms. Se estiver usando a API Java, crie uma FormsServiceClient
objeto. Se estiver usando a API do serviço Web Forms, crie uma FormsService
objeto.
Recuperar dados do formulário
Para recuperar dados de formulário enviados, chame o FormsServiceClient
do objeto processFormSubmission
método. Ao chamar esse método, você precisa especificar o tipo de conteúdo do formulário enviado. Quando os dados são enviados de um navegador da Web cliente para o serviço Forms, eles podem ser enviados como dados XML ou PDF. Para recuperar os dados inseridos nos campos de formulário, os dados podem ser enviados como dados XML.
Você também pode recuperar campos de formulário enviados como dados de PDF definindo as seguintes opções de tempo de execução:
- Passe o seguinte valor para o
processFormSubmission
como o parâmetro de tipo de conteúdo:CONTENT_TYPE=application/pdf
. - Defina o
RenderOptionsSpec
do objetoPDFToXDP
valor paratrue
- Defina o
RenderOptionsSpec
do objetoExportDataFormat
valor paraXMLData
Especifique o tipo de conteúdo do formulário enviado ao chamar o processFormSubmission
método. A lista a seguir especifica os valores de tipo de conteúdo aplicáveis:
- text/xml: representa o tipo de conteúdo a ser usado quando um formulário PDF envia dados de formulário como XML.
- application/x-www-form-urlencoded: representa o tipo de conteúdo a ser usado quando um formulário HTML envia dados como XML.
- application/pdf: representa o tipo de conteúdo a ser usado quando um formulário de PDF envia dados como PDF.
application/pdf
. O Manipulação de PDF forms enviado como XML usando o início rápido da API Java demonstra como lidar com dados XML enviados enviados a partir de um formulário PDF. O tipo de conteúdo especificado neste início rápido é text/xml
. Da mesma forma, o Manipulando formulários de HTML enviados como XML usando o início rápido da API Java demonstra como manipular dados XML enviados que são enviados de um formulário de HTML. O tipo de conteúdo especificado neste início rápido é application/x-www-form-urlencoded.Você recupera dados de formulário publicados no serviço Forms e determina o estado de processamento. Ou seja, quando os dados são enviados para o serviço Forms, isso não significa necessariamente que o serviço Forms terminou de processar os dados e eles estão prontos para serem processados. Por exemplo, os dados podem ser enviados para o serviço Forms para que um cálculo possa ser executado. Quando o cálculo é concluído, o formulário é renderizado para o usuário com os resultados do cálculo exibidos. Antes de processar os dados enviados, é recomendável determinar se o serviço Forms terminou de processar os dados.
O serviço Forms retorna os seguintes valores para indicar se terminou de processar os dados:
- 0 (Enviar): Os dados enviados estão prontos para serem processados.
- 1 (Calcular): O serviço Forms executou uma operação de cálculo nos dados e os resultados devem ser renderizados para o usuário.
- 2 (Validar): Os dados de formulário validados pelo serviço do Forms e os resultados devem ser renderizados para o usuário.
- 3 (Próximo): A página atual foi alterada com resultados que devem ser gravados no aplicativo cliente.
- 4 (Anterior): A página atual foi alterada com resultados que devem ser gravados no aplicativo cliente.
Determine se o envio do formulário contém anexos de arquivo
O Forms enviado para o serviço Forms pode conter anexos de arquivo. Por exemplo, usando o painel de anexos integrado do Acrobat, um usuário pode selecionar anexos de arquivo para enviar junto com o formulário. Além disso, um usuário também pode selecionar anexos de arquivo usando uma barra de ferramentas HTML que é renderizada com um arquivo HTML.
Depois de determinar se um formulário contém anexos de arquivo, você pode processar os dados. Por exemplo, você pode salvar o anexo de arquivo no sistema de arquivos local.
Processar os dados enviados
Dependendo do tipo de conteúdo dos dados enviados, você pode extrair valores de campo de formulário individuais dos dados XML enviados ou salvar os dados de PDF enviados como um arquivo de PDF (ou enviá-los para outro serviço). Para extrair campos de formulário individuais, converta dados XML enviados em uma fonte de dados XML e recupere valores da fonte de dados XML usando org.w3c.dom
classes.
Consulte também
Inclusão de arquivos da biblioteca Java do AEM Forms
Definindo propriedades de conexão
Início rápido da API de serviço do Forms
Passar documentos para o serviço da Forms
Criação de aplicações Web que renderizam o Forms
Lidar com formulários enviados usando a API Java handle-submitted-forms-using-the-java-api
Manipule um formulário enviado usando a API do Forms (Java):
-
Incluir arquivos de projeto
Inclua arquivos JAR do cliente, como adobe-forms-client.jar, no caminho de classe do projeto Java.
-
Criar um objeto da API do cliente do Forms
- Criar um
ServiceClientFactory
objeto que contém propriedades de conexão. - Criar um
FormsServiceClient
usando seu construtor e transmitindo oServiceClientFactory
objeto.
- Criar um
-
Recuperar dados do formulário
- Para recuperar dados de formulário publicados em um Servlet Java, crie um
com.adobe.idp.Document
usando seu construtor e chamando ojavax.servlet.http.HttpServletResponse
do objetogetInputStream
no construtor. - Criar um
RenderOptionsSpec
usando seu construtor. Defina o valor do local chamando oRenderOptionsSpec
do objetosetLocale
e transmitindo um valor de string que especifica o valor do local.
note note NOTE Você pode instruir o serviço Forms para criar dados XDP ou XML a partir de conteúdo PDF enviado, chamando o RenderOptionsSpec
do objetosetPDF2XDP
método e transmissãotrue
e também chamandosetXMLData
e transmitindotrue
. Você pode invocar a variávelFormsResult
do objetogetOutputXML
para recuperar os dados XML que correspondem aos dados XDP/XML. (OFormsResult
objeto é retornado peloprocessFormSubmission
, que é explicado na próxima subetapa.)-
Chame o
FormsServiceClient
do objetoprocessFormSubmission
e passe os seguintes valores:- A variável
com.adobe.idp.Document
objeto que contém os dados de formulário. - Um valor de string que especifica variáveis de ambiente, incluindo todos os cabeçalhos HTTP relevantes. Especifique o tipo de conteúdo a ser manipulado. Para manipular dados XML, especifique o seguinte valor de string para esse parâmetro:
CONTENT_TYPE=text/xml
. Para lidar com dados de PDF, especifique o seguinte valor de string para esse parâmetro:CONTENT_TYPE=application/pdf
. - Um valor de string que especifica a
HTTP_USER_AGENT
valor do cabeçalho, por exemplo, .Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)
. Esse valor de parâmetro é opcional. - A
RenderOptionsSpec
objeto que armazena opções de tempo de execução.
A variável
processFormSubmission
o método retorna umFormsResult
objeto que contém os resultados do envio do formulário. - A variável
-
Determine se o serviço Forms terminou de processar os dados do formulário invocando o
FormsResult
do objetogetAction
método. Se esse método retornar o valor0
, os dados estão prontos para serem processados.
- Para recuperar dados de formulário publicados em um Servlet Java, crie um
-
Determine se o envio do formulário contém anexos de arquivo
- Chame o
FormsResult
do objetogetAttachments
método. Este método retorna um valor dejava.util.List
objeto que contém arquivos enviados com o formulário. - Repita através do
java.util.List
para determinar se há anexos de arquivo. Se houver anexos de arquivo, cada elemento será umcom.adobe.idp.Document
instância. Você pode salvar os anexos de arquivo chamando ocom.adobe.idp.Document
do objetocopyToFile
e passar umjava.io.File
objeto.
note note NOTE Esta etapa só será aplicável se o formulário for enviado como PDF. - Chame o
-
Processar os dados enviados
-
Se o tipo de conteúdo de dados for
application/vnd.adobe.xdp+xml
outext/xml
, crie uma lógica de aplicativo para recuperar valores de dados XML.- Criar um
com.adobe.idp.Document
ao invocar oFormsResult
do objetogetOutputContent
método. - Criar um
java.io.InputStream
ao invocar ojava.io.DataInputStream
construtor e transmitindo ocom.adobe.idp.Document
objeto. - Criar um
org.w3c.dom.DocumentBuilderFactory
chamando o objeto estáticoorg.w3c.dom.DocumentBuilderFactory
do objetonewInstance
método. - Criar um
org.w3c.dom.DocumentBuilder
ao invocar oorg.w3c.dom.DocumentBuilderFactory
do objetonewDocumentBuilder
método. - Criar um
org.w3c.dom.Document
ao invocar oorg.w3c.dom.DocumentBuilder
do objetoparse
e transmitindo ojava.io.InputStream
objeto. - Recupere o valor de cada nó no documento XML. Uma maneira de realizar essa tarefa é criar um método personalizado que aceite dois parâmetros: o
org.w3c.dom.Document
e o nome do nó cujo valor você deseja recuperar. Esse método retorna um valor de string que representa o valor do nó. No exemplo de código que segue esse processo, esse método personalizado é chamado degetNodeText
. O corpo desse método é mostrado.
- Criar um
-
Se o tipo de conteúdo de dados for
application/pdf
, crie uma lógica de aplicativo para salvar os dados de PDF enviados como um arquivo PDF.- Criar um
com.adobe.idp.Document
ao invocar oFormsResult
do objetogetOutputContent
método. - Criar um
java.io.File
usando seu construtor público. Certifique-se de especificar PDF como a extensão do nome do arquivo. - Preencha o arquivo PDF chamando o
com.adobe.idp.Document
do objetocopyToFile
e transmitindo ojava.io.File
objeto.
- Criar um
-
Consulte também
Início rápido (modo SOAP): tratamento de PDF forms enviado como XML usando a API Java
Início rápido (modo SOAP): controle de formulários HTML enviados como XML usando a API Java
Início rápido (modo SOAP): lidar com PDF forms enviado como PDF usando a API Java
Inclusão de arquivos da biblioteca Java do AEM Forms
Definindo propriedades de conexão
Lidar com dados de PDF enviados usando a API do serviço Web handle-submitted-pdf-data-using-the-web-service-api
Manipule um formulário enviado usando a API do Forms (serviço da Web):
-
Incluir arquivos de projeto
- Crie classes de proxy Java que consomem o serviço WSDL do Forms.
- Inclua as classes de proxy Java no caminho da classe.
-
Criar um objeto da API do cliente do Forms
Criar um
FormsService
objeto e definir valores de autenticação. -
Recuperar dados do formulário
-
Para recuperar dados de formulário publicados em um Servlet Java, crie um
BLOB
usando seu construtor. -
Criar um
java.io.InputStream
ao invocar ojavax.servlet.http.HttpServletResponse
do objetogetInputStream
método. -
Criar um
java.io.ByteArrayOutputStream
usando seu construtor e transmitindo o comprimento do objetojava.io.InputStream
objeto. -
Copie o conteúdo de
java.io.InputStream
objeto najava.io.ByteArrayOutputStream
objeto. -
Crie uma matriz de bytes chamando o
java.io.ByteArrayOutputStream
do objetotoByteArray
método. -
Preencha o
BLOB
ao invocar seusetBinaryData
e transmitindo a matriz de bytes como um argumento. -
Criar um
RenderOptionsSpec
usando seu construtor. Defina o valor do local chamando oRenderOptionsSpec
do objetosetLocale
e transmitindo um valor de string que especifica o valor do local. -
Chame o
FormsService
do objetoprocessFormSubmission
e passe os seguintes valores:- A variável
BLOB
objeto que contém os dados de formulário. - Um valor de string que especifica variáveis de ambiente, incluindo todos os cabeçalhos HTTP relevantes. Especifique o tipo de conteúdo a ser manipulado. Para manipular dados XML, especifique o seguinte valor de string para esse parâmetro:
CONTENT_TYPE=text/xml
. Para lidar com dados de PDF, especifique o seguinte valor de string para esse parâmetro:CONTENT_TYPE=application/pdf
. - Um valor de string que especifica a
HTTP_USER_AGENT
valor do cabeçalho; por exemplo,Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)
. - A
RenderOptionsSpec
objeto que armazena opções de tempo de execução. - Um vazio
BLOBHolder
objeto preenchido pelo método. - Um vazio
javax.xml.rpc.holders.StringHolder
objeto preenchido pelo método. - Um vazio
BLOBHolder
objeto preenchido pelo método. - Um vazio
BLOBHolder
objeto preenchido pelo método. - Um vazio
javax.xml.rpc.holders.ShortHolder
objeto preenchido pelo método. - Um vazio
MyArrayOf_xsd_anyTypeHolder
objeto preenchido pelo método. Esse parâmetro é usado para armazenar anexos de arquivo enviados junto com o formulário. - Um vazio
FormsResultHolder
objeto que é preenchido pelo método com o formulário enviado.
A variável
processFormSubmission
O método preenche oFormsResultHolder
com os resultados do envio do formulário. - A variável
-
Determine se o serviço Forms terminou de processar os dados do formulário invocando o
FormsResult
do objetogetAction
método. Se esse método retornar o valor0
, os dados do formulário estão prontos para serem processados. Você pode obter umFormsResult
obtendo o valor doFormsResultHolder
do objetovalue
membro de dados.
-
-
Determine se o envio do formulário contém anexos de arquivo
Obtenha o valor do
MyArrayOf_xsd_anyTypeHolder
do objetovalue
membro de dados (oMyArrayOf_xsd_anyTypeHolder
objeto foi passado para oprocessFormSubmission
método). Este membro de dados retorna uma matriz deObjects
. Cada elemento dentro doObject
matriz é umObject
que corresponde aos arquivos enviados junto com o formulário. Você pode obter cada elemento dentro da matriz e convertê-lo em umBLOB
objeto. -
Processar os dados enviados
-
Se o tipo de conteúdo de dados for
application/vnd.adobe.xdp+xml
outext/xml
, crie uma lógica de aplicativo para recuperar valores de dados XML.- Criar um
BLOB
ao invocar oFormsResult
do objetogetOutputContent
método. - Crie uma matriz de bytes chamando o
BLOB
do objetogetBinaryData
método. - Criar um
java.io.InputStream
ao invocar ojava.io.ByteArrayInputStream
e transmitindo a matriz de bytes. - Criar um
org.w3c.dom.DocumentBuilderFactory
chamando o objeto estáticoorg.w3c.dom.DocumentBuilderFactory
do objetonewInstance
método. - Criar um
org.w3c.dom.DocumentBuilder
ao invocar oorg.w3c.dom.DocumentBuilderFactory
do objetonewDocumentBuilder
método. - Criar um
org.w3c.dom.Document
ao invocar oorg.w3c.dom.DocumentBuilder
do objetoparse
e transmitindo ojava.io.InputStream
objeto. - Recupere o valor de cada nó no documento XML. Uma maneira de realizar essa tarefa é criar um método personalizado que aceite dois parâmetros: o
org.w3c.dom.Document
e o nome do nó cujo valor você deseja recuperar. Esse método retorna um valor de string que representa o valor do nó. No exemplo de código que segue esse processo, esse método personalizado é chamado degetNodeText
. O corpo desse método é mostrado.
- Criar um
-
Se o tipo de conteúdo de dados for
application/pdf
, crie uma lógica de aplicativo para salvar os dados de PDF enviados como um arquivo PDF.- Criar um
BLOB
ao invocar oFormsResult
do objetogetOutputContent
método. - Crie uma matriz de bytes chamando o
BLOB
do objetogetBinaryData
método. - Criar um
java.io.File
usando seu construtor público. Certifique-se de especificar PDF como a extensão do nome do arquivo. - Criar um
java.io.FileOutputStream
usando seu construtor e transmitindo ojava.io.File
objeto. - Preencha o arquivo PDF chamando o
java.io.FileOutputStream
do objetowrite
e transmitindo a matriz de bytes.
- Criar um
-
Consulte também
Chamada de AEM Forms usando codificação Base64