Manuseio do Forms enviado

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, é possível recuperar os dados inseridos pelo usuário em um formulário interativo. Depois de recuperar os dados, você pode processá-los para atender às suas necessidades comerciais. 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, unir os dados em um design de formulário, exibir os dados em um navegador da Web e assim por diante.

Os dados do 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 que o usuário inseriu no formulário. Um formulário enviado como dados PDF são dados binários, não dados XML. É possível salvar o formulário como um arquivo PDF ou enviá-lo para outro serviço. Se você 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 Java Servlet chamado HandleData de um formulário interativo exibido em um navegador da Web.

hs_hs_handlesubmit

A tabela a seguir explica as etapas no diagrama.

Etapa

Descrição

1

Um usuário preenche um formulário interativo e clica no botão Enviar do formulário.

2

Os dados são enviados para o HandleData Java Servlet como dados XML.

3

O Java Servlet HandleData contém a lógica do aplicativo para recuperar os dados.

Tratamento de dados XML enviados

Quando os dados do formulário são enviados como XML, é possível recuperar dados XML que representam os dados enviados. Todos os campos de formulário são exibidos como nós em um schema XML. Os valores de nó correspondem aos valores preenchidos pelo usuário. Considere um formulário de empréstimo no qual cada campo no formulário aparece como um nó dentro dos 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.

hs_hs_loanformdata

A ilustração a seguir mostra os dados XML correspondentes recuperados usando a API do cliente de serviço da Forms.

hs_hs_loandata

Os campos no formulário de empréstimo. Esses valores podem ser recuperados
usando classes Java XML.

OBSERVAÇÃO

O design de formulário deve ser configurado corretamente no Designer para que os dados sejam enviados como dados XML. Para configurar corretamente o design de formulário para enviar dados XML, verifique se o botão Enviar localizado no design de formulário está definido para enviar dados XML. Para obter informações sobre como configurar o botão Enviar para enviar dados XML, consulte AEM Forms Designer.

Tratamento de dados PDF enviados

Considere um aplicativo da Web que chama o serviço Forms. Depois que o serviço Forms renderiza um formulário PDF interativo para um navegador da Web cliente, o usuário preenche o formulário e o envia como dados PDF. Quando o serviço Forms recebe os dados PDF, ele pode enviar os dados PDF para outro serviço ou salvá-los como um arquivo PDF. O diagrama a seguir mostra o fluxo lógico do aplicativo.

hs_hs_savingforms

A tabela a seguir descreve as etapas neste diagrama.

Etapa

Descrição

3

Uma página da Web contém um link que acessa um Servlet Java que chama o serviço Forms.

2

O serviço Forms renderiza um formulário PDF interativo para o navegador da Web do cliente.

3

O usuário preenche um formulário interativo e clica em um botão Enviar. O formulário é enviado de volta ao serviço Forms como dados PDF. Essa opção está definida no Designer.

4

O serviço Forms salva os dados PDF como um arquivo PDF.

Tratamento de dados UTF-16 do URL enviado

Se os dados do formulário forem enviados como URL UTF-16, o computador cliente exigirá Adobe Reader ou Acrobat 8.1 ou posterior. Além disso, se o design de formulário contiver um botão Enviar com dados codificados por URL (HTTP Post) e a opção de codificação de dados for UTF-16, o design de formulário deverá ser modificado em um editor de texto, como o Bloco de notas. 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.

OBSERVAÇÃO

Para obter mais informações sobre o serviço Forms, consulte Referência de serviços para AEM Forms.

Resumo das etapas

Para manipular formulários enviados, execute as seguintes tarefas:

  1. Incluir arquivos de projeto.
  2. Crie um objeto de API do Forms Client.
  3. Recuperar dados do formulário.
  4. Determine se o envio do formulário contém anexos de arquivo.
  5. Processar os dados enviados.

Incluir arquivos de projeto

Inclua os arquivos necessários no projeto de desenvolvimento. Se você estiver criando um aplicativo 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 de API do Forms Client

Antes de executar programaticamente uma operação de API do cliente de serviço da Forms, você deve criar um cliente de serviço da Forms. Se você estiver usando a API Java, crie um objeto FormsServiceClient. Se você estiver usando a API de serviço da Web da Forms, crie um objeto FormsService.

Recuperar dados do formulário

Para recuperar dados de formulário enviados, chame o método FormsServiceClient do objeto processFormSubmission. Ao invocar esse método, é necessário 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 do formulário, eles podem ser enviados como dados XML.

Também é possível recuperar campos de formulário de um formulário enviado como dados PDF definindo as seguintes opções de tempo de execução:

  • Passe o seguinte valor para o método processFormSubmission como parâmetro de tipo de conteúdo: CONTENT_TYPE=application/pdf.
  • Defina o valor RenderOptionsSpec do objeto PDFToXDP como true
  • Defina o valor RenderOptionsSpec do objeto ExportDataFormat como XMLData

Especifique o tipo de conteúdo do formulário enviado ao chamar o método processFormSubmission. 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 PDF envia dados como PDF.
OBSERVAÇÃO

Você observará que existem três start rápidos correspondentes associados à seção Manuseio do Forms enviado. Os PDF forms Handling enviados como PDF usando o start rápido da API Java demonstram como lidar com dados enviados em PDF. O tipo de conteúdo especificado neste start rápido é application/pdf. Os PDF forms Handling enviados como XML usando o start rápido da API Java demonstram como lidar com dados XML enviados de um formulário PDF. O tipo de conteúdo especificado neste start rápido é text/xml. Da mesma forma, os formulários HTML de manuseio enviados como XML usando o start rápido da API Java demonstram como lidar com dados XML enviados enviados de um formulário HTML. O tipo de conteúdo especificado neste start rápido é application/x-www-form-urlencoded.

Você recupera dados de formulário publicados no serviço Forms e determina seu estado de processamento. Ou seja, quando os dados são submetidos ao serviço Forms, não significa necessariamente que o serviço Forms terminou de processar os dados e que eles estão prontos para serem processados. Por exemplo, os dados podem ser enviados ao serviço Forms para que um cálculo possa ser executado. Quando o cálculo é concluído, o formulário é renderizado de volta ao 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 ele 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 de volta ao usuário.
  • 2 (Validar): Os dados de formulário validados pelo serviço Forms e os resultados devem ser renderizados de volta ao 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 os resultados que devem ser gravados no aplicativo cliente.
OBSERVAÇÃO

Os cálculos e validações devem ser renderizados de volta ao usuário. (Consulte Calculando Dados de Formulário.)

Determine se o envio do formulário contém anexos de arquivo

A Forms enviada ao serviço Forms pode conter anexos de arquivo. Por exemplo, usando o painel de anexo integrado da 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, é possível processar os dados. Por exemplo, você pode salvar o anexo de arquivo no sistema de arquivos local.

OBSERVAÇÃO

O formulário deve ser enviado como dados PDF para recuperar anexos de arquivo. Se o formulário for submetido como dados XML, os anexos do arquivo não serão enviados.

Processar os dados enviados

Dependendo do tipo de conteúdo dos dados enviados, é possível extrair valores de campo de formulário individuais dos dados XML enviados ou salvar os dados PDF enviados como um arquivo 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 os valores da fonte de dados XML usando classes org.w3c.dom.

Consulte também:

Incluindo arquivos da biblioteca Java AEM Forms

Configuração das propriedades de conexão

Start rápidos da API de serviço da Forms

Transmissão de Documentos ao serviço Forms

Criação de Aplicações web que renderizam o Forms

Processar formulários enviados usando a API Java

Tratar um formulário enviado usando a API da Forms (Java):

  1. Incluir arquivos de projeto

    Inclua arquivos JAR do cliente, como adobe-forms-client.jar, no caminho de classe do seu projeto Java.

  2. Criar um objeto de API do Forms Client

    • Crie um objeto ServiceClientFactory que contenha propriedades de conexão.
    • Crie um objeto FormsServiceClient usando seu construtor e transmitindo o objeto ServiceClientFactory.
  3. Recuperar dados do formulário

    • Para recuperar dados de formulário publicados em um Java Servlet, crie um objeto com.adobe.idp.Document usando seu construtor e chamando o método javax.servlet.http.HttpServletResponse do objeto getInputStream de dentro do construtor.
    • Crie um objeto RenderOptionsSpec usando seu construtor. Defina o valor da localidade chamando o método RenderOptionsSpec do objeto setLocale e transmitindo um valor de string que especifica o valor da localidade.
    OBSERVAÇÃO

    Você pode instruir o serviço Forms a criar dados XDP ou XML a partir de conteúdo PDF enviado, invocando o método RenderOptionsSpec do objeto setPDF2XDP e transmitindo true e também chamando setXMLData e transmitindo true. Em seguida, você pode chamar o método FormsResult do objeto getOutputXML para recuperar os dados XML que correspondem aos dados XDP/XML. (O objeto FormsResult é retornado pelo método processFormSubmission, que é explicado na próxima subetapa.)

    • Chame o método FormsServiceClient do objeto processFormSubmission e passe os seguintes valores:

      • O objeto com.adobe.idp.Document que contém os dados do 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 tratado. Para manipular dados XML, especifique o seguinte valor de string para esse parâmetro: CONTENT_TYPE=text/xml. Para manipular dados PDF, especifique o seguinte valor de string para esse parâmetro: CONTENT_TYPE=application/pdf.
      • Um valor de string que especifica o valor do cabeçalho HTTP_USER_AGENT, 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.
      • Um objeto RenderOptionsSpec que armazena opções de tempo de execução.

      O método processFormSubmission retorna um objeto FormsResult contendo os resultados do envio do formulário.

    • Determine se o serviço Forms terminou de processar os dados do formulário chamando o método FormsResult getAction do objeto. Se esse método retornar o valor 0, os dados estarão prontos para serem processados.

  4. Determine se o envio do formulário contém anexos de arquivo

    • Chame o método FormsResult do objeto getAttachments. Esse método retorna um objeto java.util.List que contém arquivos que foram enviados com o formulário.
    • Interaja pelo objeto java.util.List para determinar se há anexos de arquivo. Se houver anexos de arquivo, cada elemento será uma instância com.adobe.idp.Document. Você pode salvar os anexos de arquivo chamando o método com.adobe.idp.Document do objeto copyToFile e transmitindo um objeto java.io.File.
    OBSERVAÇÃO

    Essa etapa só se aplica se o formulário for enviado como PDF.

  5. Processar os dados enviados

    • Se o tipo de conteúdo de dados for application/vnd.adobe.xdp+xml ou text/xml, crie a lógica do aplicativo para recuperar valores de dados XML.

      • Crie um objeto com.adobe.idp.Document invocando o método FormsResult do objeto getOutputContent.
      • Crie um objeto java.io.InputStream chamando o construtor java.io.DataInputStream e transmitindo o objeto com.adobe.idp.Document.
      • Crie um objeto org.w3c.dom.DocumentBuilderFactory chamando o método org.w3c.dom.DocumentBuilderFactory estático do objeto newInstance.
      • Crie um objeto org.w3c.dom.DocumentBuilder chamando o método org.w3c.dom.DocumentBuilderFactory do objeto newDocumentBuilder.
      • Crie um objeto org.w3c.dom.Document invocando o método org.w3c.dom.DocumentBuilder do objeto parse e transmitindo o objeto java.io.InputStream.
      • Recupere o valor de cada nó dentro do documento XML. Uma maneira de realizar essa tarefa é criar um método personalizado que aceite dois parâmetros: o objeto org.w3c.dom.Document e o nome do nó cujo valor você deseja recuperar. Este método retorna um valor de string representando o valor do nó. No exemplo de código que segue esse processo, esse método personalizado é chamado getNodeText. O corpo deste método é mostrado.
    • Se o tipo de conteúdo de dados for application/pdf, crie a lógica do aplicativo para salvar os dados PDF enviados como um arquivo PDF.

      • Crie um objeto com.adobe.idp.Document invocando o método FormsResult do objeto getOutputContent.
      • Crie um objeto 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 método com.adobe.idp.Document do objeto copyToFile e transmitindo o objeto java.io.File.

Consulte também:

Start rápido (modo SOAP): Tratamento de PDF forms enviados como XML usando a API Java

Start rápido (modo SOAP): Tratamento de formulários HTML enviados como XML usando a API Java

Start rápido (modo SOAP): Manuseio de PDF forms enviados como PDF usando a API Java

Incluindo arquivos da biblioteca Java AEM Forms

Configuração das propriedades de conexão

Tratar dados PDF enviados usando a API de serviço da Web

Tratar um formulário enviado usando a API Forms (serviço da Web):

  1. Incluir arquivos de projeto

    • Crie classes proxy Java que consomem o serviço Forms WSDL.
    • Inclua as classes proxy Java no caminho da classe.
  2. Criar um objeto de API do Forms Client

    Crie um objeto FormsService e defina os valores de autenticação.

  3. Recuperar dados do formulário

    • Para recuperar dados de formulário publicados em um Java Servlet, crie um objeto BLOB usando seu construtor.

    • Crie um objeto java.io.InputStream invocando o método javax.servlet.http.HttpServletResponse do objeto getInputStream.

    • Crie um objeto java.io.ByteArrayOutputStream usando seu construtor e transmitindo o comprimento do objeto java.io.InputStream.

    • Copie o conteúdo do objeto java.io.InputStream no objeto java.io.ByteArrayOutputStream.

    • Crie uma matriz de bytes chamando o método java.io.ByteArrayOutputStream do objeto toByteArray.

    • Preencha o objeto BLOB invocando seu método setBinaryData e transmitindo a matriz de bytes como um argumento.

    • Crie um objeto RenderOptionsSpec usando seu construtor. Defina o valor da localidade chamando o método RenderOptionsSpec do objeto setLocale e transmitindo um valor de string que especifica o valor da localidade.

    • Chame o método FormsService do objeto processFormSubmission e passe os seguintes valores:

      • O objeto BLOB que contém os dados do 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 tratado. Para manipular dados XML, especifique o seguinte valor de string para esse parâmetro: CONTENT_TYPE=text/xml. Para manipular dados PDF, especifique o seguinte valor de string para esse parâmetro: CONTENT_TYPE=application/pdf.
      • Um valor de string que especifica o valor do cabeçalho HTTP_USER_AGENT; por exemplo, Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322).
      • Um objeto RenderOptionsSpec que armazena opções de tempo de execução.
      • Um objeto vazio BLOBHolder que é preenchido pelo método.
      • Um objeto vazio javax.xml.rpc.holders.StringHolder que é preenchido pelo método.
      • Um objeto vazio BLOBHolder que é preenchido pelo método.
      • Um objeto vazio BLOBHolder que é preenchido pelo método.
      • Um objeto vazio javax.xml.rpc.holders.ShortHolder que é preenchido pelo método.
      • Um objeto vazio MyArrayOf_xsd_anyTypeHolder que é preenchido pelo método. Esse parâmetro é usado para armazenar anexos de arquivo enviados junto com o formulário.
      • Um objeto vazio FormsResultHolder que é preenchido pelo método com o formulário enviado.

      O método processFormSubmission preenche o parâmetro FormsResultHolder com os resultados do envio do formulário.

    • Determine se o serviço Forms terminou de processar os dados do formulário chamando o método FormsResult getAction do objeto. Se esse método retornar o valor 0, os dados do formulário estarão prontos para serem processados. Você pode obter um objeto FormsResult obtendo o valor do membro de dados FormsResultHolder do objeto value.

  4. Determine se o envio do formulário contém anexos de arquivo

    Obtenha o valor do membro de dados MyArrayOf_xsd_anyTypeHolder do objeto value (o objeto MyArrayOf_xsd_anyTypeHolder foi transmitido ao método processFormSubmission). Esse membro de dados retorna uma matriz de Objects. Cada elemento na matriz Object é um Objectque corresponde aos arquivos que foram enviados junto com o formulário. Você pode obter cada elemento dentro da matriz e convertê-lo em um objeto BLOB.

  5. Processar os dados enviados

    • Se o tipo de conteúdo de dados for application/vnd.adobe.xdp+xml ou text/xml, crie a lógica do aplicativo para recuperar valores de dados XML.

      • Crie um objeto BLOB invocando o método FormsResult do objeto getOutputContent.
      • Crie uma matriz de bytes chamando o método BLOB do objeto getBinaryData.
      • Crie um objeto java.io.InputStream chamando o construtor java.io.ByteArrayInputStream e transmitindo a matriz de bytes.
      • Crie um objeto org.w3c.dom.DocumentBuilderFactory chamando o método org.w3c.dom.DocumentBuilderFactory estático do objeto newInstance.
      • Crie um objeto org.w3c.dom.DocumentBuilder chamando o método org.w3c.dom.DocumentBuilderFactory do objeto newDocumentBuilder.
      • Crie um objeto org.w3c.dom.Document invocando o método org.w3c.dom.DocumentBuilder do objeto parse e transmitindo o objeto java.io.InputStream.
      • Recupere o valor de cada nó dentro do documento XML. Uma maneira de realizar essa tarefa é criar um método personalizado que aceite dois parâmetros: o objeto org.w3c.dom.Document e o nome do nó cujo valor você deseja recuperar. Este método retorna um valor de string representando o valor do nó. No exemplo de código que segue esse processo, esse método personalizado é chamado getNodeText. O corpo deste método é mostrado.
    • Se o tipo de conteúdo de dados for application/pdf, crie a lógica do aplicativo para salvar os dados PDF enviados como um arquivo PDF.

      • Crie um objeto BLOB invocando o método FormsResult do objeto getOutputContent.
      • Crie uma matriz de bytes chamando o método BLOB do objeto getBinaryData.
      • Crie um objeto java.io.File usando seu construtor público. Certifique-se de especificar PDF como a extensão do nome do arquivo.
      • Crie um objeto java.io.FileOutputStream usando seu construtor e transmitindo o objeto java.io.File.
      • Preencha o arquivo PDF chamando o método java.io.FileOutputStream do objeto write e transmitindo a matriz de bytes.

Consulte também:

Invocar o AEM Forms usando a codificação Base64

Nesta página

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free