DocumentaçãoAEM 6.5Guia do usuário

Renderização de PDF forms interativos rendering-interactive-pdf-forms

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Aplica-se a:
  • Experience Manager 6.5
  • Tópicos:

Criado para:

  • Desenvolvedor

Exemplos e exemplos neste documento são somente para AEM Forms no ambiente JEE.

O serviço Forms renderiza PDF forms interativos em dispositivos clientes, geralmente navegadores da Web, para coletar informações dos usuários. Depois que um formulário interativo é renderizado, um usuário pode inserir dados em campos de formulário e clicar em um botão de envio localizado no formulário para enviar informações de volta para o serviço Forms. O Adobe Reader ou o Acrobat devem estar instalados no computador que hospeda o navegador da Web do cliente para que um formulário PDF interativo fique visível.

NOTE
Antes de renderizar um formulário usando o serviço Forms, crie um design de formulário. Normalmente, um design de formulário é criado no Designer e salvo como um arquivo XDP. Para obter informações sobre como criar um design de formulário, consulte Forms Designer.

Exemplo de aplicativo de empréstimo

Um exemplo de aplicativo de empréstimo é apresentado para demonstrar como o serviço Forms usa formulários interativos para coletar informações dos usuários. Esse aplicativo permite que um usuário preencha um formulário com os dados necessários para garantir um empréstimo e, em seguida, envie dados para o serviço do Forms. O diagrama a seguir mostra o fluxo lógico do aplicativo de empréstimo.

ri_ri_finsrv_loanapp_v1

A tabela a seguir descreve as etapas deste diagrama.

Etapa
Descrição
1
O Servlet Java GetLoanForm é chamado de uma página de HTML.
2
O Servlet Java GetLoanForm usa a API do cliente do serviço Forms para renderizar o formulário de empréstimo para o navegador Web do cliente. (Consulte Renderizar um formulário PDF interativo usando a API Java.)
3
Depois que o usuário preenche o formulário de empréstimo e clica no botão enviar, os dados são enviados para o Servlet Java HandleData. (Consulte "Formulário de empréstimo".)
4
O Servlet Java HandleData usa a API do cliente de serviço Forms para processar o envio e recuperar dados de formulário. Os dados são armazenados em um banco de dados empresarial. (Consulte Manipulação de Forms Enviada.)
5
Um formulário de confirmação é renderizado no navegador da Web. Dados como o nome e sobrenome do usuário são mesclados com o formulário antes de serem renderizados. (Consulte Preenchimento prévio de Forms com Layouts Fluxáveis.)

Formulário de empréstimo

Este formulário de empréstimo interativo é renderizado pelo Servlet Java GetLoanForm do aplicativo de empréstimo de amostra.

ri_ri_loanform

Formulário de confirmação

Este formulário é renderizado pelo Servlet Java HandleData do aplicativo de empréstimo de exemplo.

ri_ri_confirm

O Servlet Java HandleData preenche este formulário com o nome e sobrenome do usuário e a quantidade. Depois que o formulário é pré-preenchido, ele é enviado para o navegador da Web do cliente. (Consulte Preenchimento prévio de Forms com Layouts Fluxáveis)

Servlets Java

O exemplo de aplicativo de empréstimo é um exemplo de um aplicativo de serviço do Forms que existe como um Servlet Java. Um Java Servlet é um programa Java em execução em um servidor de aplicativos J2EE, como o WebSphere, e contém o código da API do cliente do serviço Forms.

O código a seguir mostra a sintaxe de um Servlet Java chamado 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, você não colocaria o código da API do cliente de serviço do Forms dentro de um método doGet ou doPost do Java Servlet. É uma prática de programação melhor colocar esse código em uma classe separada, instanciar a classe de dentro do método doPost (ou método doGet) e chamar os métodos apropriados. No entanto, para abreviar o código, os exemplos de código nesta seção são mantidos no mínimo e os exemplos de código são colocados no método doPost.

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

Resumo das etapas

Para renderizar um formulário PDF interativo, execute as seguintes tarefas:

  1. Incluir arquivos de projeto.
  2. Crie um objeto da API do cliente do Forms.
  3. Especifique valores de URI.
  4. Anexe arquivos ao formulário (Opcional).
  5. Renderize um formulário PDF interativo.
  6. Grave o fluxo de dados do formulário no navegador da Web do cliente.

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 objeto da API do cliente do Forms. Se você estiver usando a API Java, crie um objeto FormsServiceClient. Se você estiver usando a API de serviço Web Forms, crie um objeto FormsService.

Especificar valores de URI

Você pode especificar valores de URI exigidos pelo serviço Forms para renderizar um formulário. Um design de formulário salvo como parte de um aplicativo do Forms pode ser referenciado usando o valor de URI da raiz de conteúdo repository:///. Por exemplo, considere o seguinte design de formulário chamado Loan.xdp localizado em um aplicativo do Forms chamado FormsApplication:

ri_ri_formrepository

Para acessar este design de formulário, especifique Applications/FormsApplication/1.0/FormsFolder/Loan.xdp como o nome do formulário (o primeiro parâmetro passado para o método renderPDFForm) e repository:/// como o valor de URI da raiz do conteúdo.

NOTE
Para obter informações sobre como criar um aplicativo do Forms usando o Workbench, consulte Ajuda do Workbench.

O caminho para um recurso em um aplicativo do Forms é:

Applications/Application-name/Application-version/Folder.../Filename

Os seguintes valores mostram alguns exemplos 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

Ao renderizar um formulário interativo, você pode definir valores de URI, como a URL de destino na qual os dados do formulário são publicados. O URL de destino pode ser definido de uma das seguintes maneiras:

  • No botão Enviar ao projetar o design do formulário no Designer
  • Ao usar a API do cliente de serviço do Forms

Se o URL de destino for definido no design do formulário, não o substitua pela API do cliente de serviço do Forms. Ou seja, definir o URL de destino usando a API do Forms redefine o URL especificado no design do formulário para o especificado usando a API. Se desejar enviar o formulário PDF para a URL de destino especificada no design do formulário, defina programaticamente a URL de destino como uma cadeia de caracteres vazia.

Se você tiver um formulário que contenha um botão Enviar e um botão Calcular (com um script correspondente executado no servidor), será possível definir programaticamente a URL para onde o formulário é enviado para executar o script. Use o botão enviar no design do formulário para especificar a URL na qual os dados do formulário são publicados. (Consulte Calcular Dados De Formulário.)

NOTE
Em vez de especificar um valor de URL para fazer referência a um arquivo XDP, você também pode passar uma instância com.adobe.idp.Document para o serviço Forms. A instância com.adobe.idp.Document contém um design de formulário. (Consulte Passando documentos para o serviço Forms.)

Anexar arquivos ao formulário

Você pode anexar arquivos a um formulário. Quando você renderiza um formulário PDF com anexos de arquivo, os usuários podem recuperar os anexos de arquivo no Acrobat usando o painel de anexos de arquivo. Você pode anexar diferentes tipos de arquivo a um formulário, como um arquivo de texto, ou a um arquivo binário, como um arquivo JPG/.

NOTE
Anexar anexos de arquivo a um formulário é opcional.

Renderizar um formulário de PDF interativo

Para renderizar um formulário, use um design de formulário criado no Designer e salvo como um arquivo XDP ou PDF. Além disso, é possível renderizar um formulário criado com o Acrobat e salvo como um arquivo PDF. Para renderizar um formulário PDF interativo, chame o método renderPDFForm ou o método renderPDFForm2 do objeto FormsServiceClient.

O renderPDFForm usa um objeto URLSpec. A raiz de conteúdo para o arquivo XDP é passada para o serviço Forms usando o método setContentRootURI do objeto URLSpec. O nome de design do Formulário ( formQuery) é passado como um valor de parâmetro separado. Os dois valores são concatenados para obter a referência absoluta para o design do formulário.

O método renderPDFForm2 aceita uma instância com.adobe.idp.Document que contém o documento XDP ou PDF a ser renderizado.

NOTE
A opção de tempo de execução de PDF marcado não pode ser definida se o documento de entrada for um documento PDF. Se o arquivo de entrada for um arquivo XDP, a opção PDF com tags poderá ser definida.

Renderize um formulário PDF interativo usando a API Java render-an-interactive-pdf-form-using-the-java-api

Renderize um formulário PDF interativo usando a API do Forms (Java):

  1. Incluir arquivos de projeto

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

  2. Criar um objeto da API do cliente do Forms

    • Crie um objeto ServiceClientFactory que contenha propriedades de conexão.
    • Crie um objeto FormsServiceClient usando seu construtor e transmitindo o objeto ServiceClientFactory.

  3. Especificar valores de URI

    • Crie um objeto URLSpec que armazene valores de URI usando seu construtor.
    • Invoque o método setApplicationWebRoot do objeto URLSpec e passe um valor de cadeia de caracteres que represente a raiz da Web do aplicativo.
    • Invoque o método setContentRootURI do objeto URLSpec e passe um valor de cadeia de caracteres que especifique o valor de URI da raiz de conteúdo. Verifique se o design do formulário está no URI da raiz do conteúdo. Caso contrário, o serviço Forms acionará uma exceção. Para referenciar o repositório, especifique repository:///.
    • Invoque o método setTargetURL do objeto URLSpec e passe um valor de cadeia de caracteres que especifique o valor da URL de destino para onde os dados de formulário são postados. Se você definir o URL de destino no design do formulário, será possível passar uma cadeia de caracteres vazia. Você também pode especificar a URL para onde um formulário é enviado para realizar cálculos.

  4. Anexar arquivos ao formulário

    • Crie um objeto java.util.HashMap para armazenar anexos de arquivo usando seu construtor.

    • Invoque o método put do objeto java.util.HashMap para cada arquivo a ser anexado ao formulário renderizado. Transmita os seguintes valores para este método:

      • Um valor de string que especifica o nome do anexo de arquivo, incluindo a extensão do nome do arquivo.

    • Um objeto com.adobe.idp.Document que contém o anexo de arquivo.

    note note
    NOTE
    Repita essa etapa para cada arquivo a ser anexado ao formulário. Esta etapa é opcional e você pode passar null se não quiser enviar anexos de arquivo.

  5. Renderizar um formulário PDF interativo

    Invoque o método renderPDFForm do objeto FormsServiceClient e passe os seguintes valores:

    • Um valor de cadeia de caracteres que especifica o nome de design do formulário, incluindo a extensão de nome de arquivo. Se você referenciar um design de formulário que faça parte de um aplicativo do Forms, certifique-se de especificar o caminho completo, como Applications/FormsApplication/1.0/FormsFolder/Loan.xdp.
    • Um objeto com.adobe.idp.Document que contém dados para mesclar com o formulário. Se não quiser mesclar dados, passe um objeto com.adobe.idp.Document vazio.
    • Um objeto PDFFormRenderSpec que armazena opções de tempo de execução. Este é um parâmetro opcional e você pode especificar null se não quiser especificar opções de tempo de execução.
    • Um objeto URLSpec que contém valores de URI exigidos pelo serviço Forms.
    • Um objeto java.util.HashMap que armazena anexos de arquivo. Este é um parâmetro opcional e você pode especificar null se não quiser anexar arquivos ao formulário.

    O método renderPDFForm retorna um objeto FormsResult que contém um fluxo de dados de formulário que deve ser gravado no navegador Web cliente.

  6. Gravar o fluxo de dados do formulário no navegador Web cliente

    • Crie um objeto com.adobe.idp.Document invocando o método getOutputContent do objeto FormsResult.
    • Obtenha o tipo de conteúdo do objeto com.adobe.idp.Document invocando seu método getContentType.
    • Defina o tipo de conteúdo do objeto javax.servlet.http.HttpServletResponse invocando seu método setContentType e transmitindo o tipo de conteúdo do objeto com.adobe.idp.Document.
    • Crie um objeto javax.servlet.ServletOutputStream usado para gravar o fluxo de dados de formulário no navegador da Web cliente, chamando o método getOutputStream do objeto javax.servlet.http.HttpServletResponse.
    • Crie um objeto java.io.InputStream invocando o método getInputStream do objeto com.adobe.idp.Document.
    • Crie uma matriz de bytes e preencha-a com o fluxo de dados de formulário, chamando o método read do objeto InputStream e transmitindo a matriz de bytes como argumento.
    • Invoque o método write do objeto javax.servlet.ServletOutputStream para enviar o fluxo de dados de formulário para o navegador Web cliente. Passar a matriz de bytes para o método write.

Renderize um formulário PDF interativo usando a API do serviço Web render-an-interactive-pdf-form-using-the-web-service-api

Renderize um formulário PDF interativo usando a API (serviço da Web) do Forms:

  1. 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.

  2. Criar um objeto da API do cliente do Forms

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

  3. Especificar valores de URI

    • Crie um objeto URLSpec que armazene valores de URI usando seu construtor.
    • Invoque o método setApplicationWebRoot do objeto URLSpec e passe um valor de cadeia de caracteres que represente a raiz da Web do aplicativo.
    • Invoque o método setContentRootURI do objeto URLSpec e passe um valor de cadeia de caracteres que especifique o valor de URI da raiz de conteúdo. Verifique se o design do formulário está no URI da raiz do conteúdo. Caso contrário, o serviço Forms acionará uma exceção. Para referenciar o repositório, especifique repository:///.
    • Invoque o método setTargetURL do objeto URLSpec e passe um valor de cadeia de caracteres que especifique o valor da URL de destino para onde os dados de formulário são postados. Se você definir o URL de destino no design do formulário, será possível passar uma cadeia de caracteres vazia. Você também pode especificar a URL para onde um formulário é enviado para realizar cálculos.

  4. Anexar arquivos ao formulário

    • Crie um objeto java.util.HashMap para armazenar anexos de arquivo usando seu construtor.

    • Invoque o método put do objeto java.util.HashMap para cada arquivo a ser anexado ao formulário renderizado. Transmita os seguintes valores para este método:

      • Um valor de string que especifica o nome do anexo de arquivo, incluindo a extensão do nome do arquivo

    • Um objeto BLOB que contém o anexo de arquivo

    note note
    NOTE
    Repita essa etapa para cada arquivo a ser anexado ao formulário.

  5. Renderizar um formulário PDF interativo

    Invoque o método renderPDFForm do objeto FormsService e passe os seguintes valores:

    • Um valor de cadeia de caracteres que especifica o nome de design do formulário, incluindo a extensão de nome de arquivo. Se você referenciar um design de formulário que faça parte de um aplicativo do Forms, certifique-se de especificar o caminho completo, como Applications/FormsApplication/1.0/FormsFolder/Loan.xdp.
    • Um objeto BLOB que contém dados para mesclar com o formulário. Se não quiser mesclar dados, passe null.
    • Um objeto PDFFormRenderSpec que armazena opções de tempo de execução. Este é um parâmetro opcional e você pode especificar null se não quiser especificar opções de tempo de execução.
    • Um objeto URLSpec que contém valores de URI exigidos pelo serviço Forms.
    • Um objeto java.util.HashMap que armazena anexos de arquivo. Este é um parâmetro opcional e você pode especificar null se não quiser anexar arquivos ao formulário.
    • Um objeto com.adobe.idp.services.holders.BLOBHolder vazio preenchido pelo método. Isso é usado para armazenar o formulário de PDF renderizado.
    • Um objeto javax.xml.rpc.holders.LongHolder vazio preenchido pelo método. (Esse argumento armazenará o número de páginas no formulário.)
    • Um objeto javax.xml.rpc.holders.StringHolder vazio preenchido pelo método. (Esse argumento armazenará o valor do local.)
    • Um objeto com.adobe.idp.services.holders.FormsResultHolder vazio que conterá os resultados desta operação.

    O método renderPDFForm preenche o objeto com.adobe.idp.services.holders.FormsResultHolder que é passado como o último valor de argumento com um fluxo de dados de formulário que deve ser gravado no navegador Web cliente.

  6. Gravar o fluxo de dados do formulário no navegador Web cliente

    • Crie um objeto FormResult obtendo o valor do membro de dados value do objeto com.adobe.idp.services.holders.FormsResultHolder.
    • Crie um objeto BLOB que contenha dados de formulário invocando o método getOutputContent do objeto FormsResult.
    • Obtenha o tipo de conteúdo do objeto BLOB invocando seu método getContentType.
    • Defina o tipo de conteúdo do objeto javax.servlet.http.HttpServletResponse invocando seu método setContentType e transmitindo o tipo de conteúdo do objeto BLOB.
    • Crie um objeto javax.servlet.ServletOutputStream usado para gravar o fluxo de dados de formulário no navegador da Web cliente, chamando o método getOutputStream do objeto javax.servlet.http.HttpServletResponse.
    • Crie uma matriz de bytes e preencha-a chamando o método getBinaryData do objeto BLOB. Esta tarefa atribui o conteúdo do objeto FormsResult à matriz de bytes.
    • Invoque o método write do objeto javax.servlet.http.HttpServletResponse para enviar o fluxo de dados de formulário para o navegador Web cliente. Passar a matriz de bytes para o método write.

Gravar o fluxo de dados de formulário no navegador Web cliente

Quando o serviço Forms renderiza um formulário, ele retorna um fluxo de dados de formulário que você deve gravar no navegador da Web do cliente. Quando gravado no navegador da Web do cliente, o formulário fica visível para o usuário.

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2