Criação de aplicações Web que renderizam o Forms creating-web-applications-thatrenders-forms

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

Criação de aplicações Web que renderizam o Forms creating-web-applications-that-renders-forms

Você pode criar uma aplicação baseada na web que use servlets Java para chamar o serviço Forms e renderizar formulários. Uma vantagem de usar um servlet Java™ é que você pode gravar o valor de retorno do processo em um navegador da Web cliente. Ou seja, um servlet Java pode ser usado como o link entre o serviço Forms que retorna um formulário e um navegador cliente da Web.

NOTE
Esta seção descreve como criar uma aplicação baseada na Web que usa um servlet Java que chama o serviço do Forms e renderiza formulários com base em fragmentos. (Consulte Renderização de Forms com base em fragmentos.)

Usando um servlet Java, você pode escrever um formulário em um navegador Web cliente para que um cliente possa visualizar e inserir dados no formulário. Depois de preencher o formulário com dados, o usuário da Web clica em um botão de envio localizado no formulário para enviar informações de volta para o servlet Java, onde os dados podem ser recuperados e processados. Por exemplo, os dados podem ser enviados para outro processo.

Esta seção discute como criar um aplicativo baseado na Web que permita ao usuário selecionar dados de formulário baseados nos EUA ou dados de formulário baseados no Canadá, conforme mostrado na ilustração a seguir.

cw_cw_fragmentwebclient

O formulário renderizado é um formulário baseado em fragmentos. Ou seja, se o usuário selecionar dados americanos, o formulário retornado usará fragmentos com base em dados americanos. Por exemplo, o rodapé do formulário contém um endereço americano, como mostrado na ilustração a seguir.

cw_cw_fragementformfooter

Da mesma forma, se o usuário selecionar dados canadenses, o formulário retornado conterá um endereço canadense, como mostrado na ilustração a seguir.

cw_cw_fragementformfootercnd

NOTE
Para obter informações sobre como criar designs de formulário com base em fragmentos, consulte Forms Designer.

Arquivos de exemplo

Esta seção usa arquivos de exemplo que podem estar no seguinte local:

<diretório de instalação do Forms Designer>/Samples/Forms/Purchase Order/Form Fragments

onde <diretório de instalação> é o caminho de instalação. Para fins do aplicativo cliente, o arquivo Dynamic.xdp da Ordem de Compra foi copiado deste local de instalação e implantado em um aplicativo do Forms chamado Applications/FormsApplication. O arquivo Dynamic.xdp da ordem de compra é colocado em uma pasta chamada FormsFolder. Da mesma forma, os fragmentos são colocados em uma pasta chamada Fragmentos, como mostrado na ilustração a seguir.

cw_cw_fragmentsrepository

Para acessar o design do formulário Dynamic.xdp da Ordem de Compra, especifique Applications/FormsApplication/1.0/FormsFolder/Purchase Order Dynamic.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.

Os arquivos de dados XML usados pelo aplicativo Web foram movidos da pasta Data para C:\Adobe (o sistema de arquivos que pertence ao servidor de aplicativos J2EE que hospeda o AEM Forms). Os nomes de arquivo são Ordem de Compra Canada.xml e Ordem de Compra US.xml.

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

Resumo das etapas summary-of-steps

Para criar aplicativos baseados na Web que renderizem formulários com base em fragmentos, execute as seguintes etapas:

  1. Crie um projeto da Web.
  2. Crie uma lógica de aplicação Java que represente o servlet Java.
  3. Crie a página da Web para o aplicativo Web.
  4. Empacotar a aplicação Web em um arquivo WAR.
  5. Implante o arquivo WAR no servidor de aplicativos J2EE.
  6. Teste seu aplicativo web.
NOTE
Algumas dessas etapas dependem da aplicação J2EE na qual o AEM Forms é implantado. Por exemplo, o método usado para disponibilizar um arquivo WAR depende do servidor de aplicativos J2EE que você está usando. Esta seção pressupõe que o AEM Forms esteja implantado no JBoss®.

Criação de um projeto web creating-a-web-project

A primeira etapa para criar uma aplicação Web que contenha um servlet Java que possa chamar o serviço Forms é criar um projeto Web. O Java IDE no qual este documento se baseia é o Eclipse 3.3. Usando o Eclipse IDE, crie um projeto da Web e adicione os arquivos JAR necessários ao seu projeto. Finalmente, adicione uma página de HTML chamada index.html e um servlet Java ao seu projeto.

A lista a seguir especifica os arquivos JAR que devem ser adicionados ao projeto da Web:

  • adobe-forms-client.jar
  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-utilities.jar

Para obter o local desses arquivos JAR, consulte Incluindo arquivos da biblioteca Java do AEM Forms.

Para criar um projeto Web:

  1. Inicie o Eclipse e clique em Arquivo > Novo projeto.
  2. Na caixa de diálogo Novo Projeto, selecione Web > Projeto Dinâmico da Web.
  3. Digite FragmentsWebApplication como o nome do seu projeto e clique em Concluir.

Para adicionar os arquivos JAR necessários ao projeto:

  1. Na janela Project Explorer, clique com o botão direito do mouse no projeto FragmentsWebApplication e selecione Propriedades.
  2. Clique em Caminho de compilação do Java e clique na guia Bibliotecas.
  3. Clique no botão Adicionar JARs externos e navegue até os arquivos JAR para incluir.

Para adicionar um servlet Java ao projeto:

  1. Na janela Project Explorer, clique com o botão direito do mouse no projeto FragmentsWebApplication e selecione Novo > Outros.
  2. Expanda a pasta Web, selecione Servlet e clique em Avançar.
  3. Na caixa de diálogo Criar Servlet, digite RenderFormFragment para o nome do servlet e clique em Concluir.

Para adicionar uma página de HTML ao seu projeto:

  1. Na janela Project Explorer, clique com o botão direito do mouse no projeto FragmentsWebApplication e selecione Novo > Outros.
  2. Expanda a pasta Web, selecione HTML e clique em Avançar.
  3. Na caixa de diálogo Novo HTML, digite index.html para o nome do arquivo e clique em Concluir.
NOTE
Para obter informações sobre como criar a página de HTML que chama o servlet Java RenderFormFragment, consulte Criando a página da Web.

Criando lógica da aplicação Java para o servlet creating-java-application-logic-for-the-servlet

Você cria a lógica da aplicação Java que chama o serviço Forms de dentro do servlet Java. O código a seguir mostra a sintaxe do Servlet Java RenderFormFragment:

     public class RenderFormFragment extends HttpServlet implements Servlet {
         public void doGet(HttpServletRequest req, HttpServletResponse resp
         throws ServletException, IOException {
         doPost(req,resp);

         }
         public void doPost(HttpServletRequest req, HttpServletResponse resp
         throws ServletException, IOException {
             //Add code here to invoke the Forms service
             }

Normalmente, você não colocaria o código do cliente em um método doGet ou doPost de servlet Java. Uma prática de programação recomendada é 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.

Para renderizar um formulário com base em fragmentos usando a API de serviço do Forms, execute as seguintes tarefas:

  1. Inclua arquivos JAR do cliente, como adobe-forms-client.jar, no caminho de classe do projeto Java. Para obter informações sobre o local desses arquivos, consulte Incluindo arquivos da biblioteca Java do AEM Forms.

  2. Recupere o valor do botão de opção enviado do formulário HTML e especifique se os dados americanos ou canadenses devem ser usados. Se o American for enviado, crie um com.adobe.idp.Document que armazene dados na Ordem de Compra US.xml. Da mesma forma, se for canadense, crie um com.adobe.idp.Document que armazene dados no arquivo Purchase Order Canada.xml.

  3. Crie um objeto ServiceClientFactory que contenha propriedades de conexão. (Consulte Definindo propriedades de conexão.)

  4. Crie um objeto FormsServiceClient usando seu construtor e transmitindo o objeto ServiceClientFactory.

  5. Crie um objeto URLSpec que armazene valores de URI usando seu construtor.

  6. Invoque o método setApplicationWebRoot do objeto URLSpec e passe um valor de cadeia de caracteres que represente a raiz da Web do aplicativo.

  7. Invoque o método setContentRootURI do objeto URLSpec e passe um valor de cadeia de caracteres que especifique o valor de URI da raiz do conteúdo. Verifique se o design do formulário e os fragmentos estão no URI da raiz de conteúdo. Caso contrário, o serviço Forms acionará uma exceção. Para referenciar o repositório do AEM Forms, especifique repository://.

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

  9. Chame 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.
    • Um objeto com.adobe.idp.Document que contém dados para mesclar com o formulário (criado na etapa 2).
    • Um objeto PDFFormRenderSpec que armazena opções de tempo de execução. Para obter mais informações, consulte Referência da API do AEM Forms.
    • Um objeto URLSpec que contém valores de URI exigidos pelo serviço Forms para renderizar um formulário com base em fragmentos.
    • 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.

  10. Crie um objeto com.adobe.idp.Document invocando o método getOutputContent do objeto FormsResult.

  11. Obtenha o tipo de conteúdo do objeto com.adobe.idp.Document invocando seu método getContentType.

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

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

  14. Crie um objeto java.io.InputStream invocando o método getInputStream do objeto com.adobe.idp.Document.

  15. Crie uma matriz de bytes para preenchê-la com o fluxo de dados de formulário, chamando o método read do objeto InputStream e transmitindo a matriz de bytes como argumento.

  16. Invoque o método write do objeto javax.servlet.ServletOutputStream para enviar o fluxo de dados de formulário para o navegador da Web cliente. Passar a matriz de bytes para o método write.

O código de exemplo a seguir representa o servlet Java que chama o serviço Forms e renderiza um formulário com base em fragmentos.

 /*
     * This Java Quick Start uses the following JAR files
     * 1. adobe-forms-client.jar
     * 2. adobe-livecycle-client.jar
     * 3. adobe-usermanager-client.jar
     *
     * (Because Forms quick starts are implemented as Java servlets, it is
     * not necessary to include J2EE specific JAR files - the Java project
     * that contains this quick start is exported as a WAR file which
     * is deployed to the J2EE application server)
     *
     * These JAR files are in the following path:
     * <install directory>/sdk/client-libs
     *
     * For complete details about the location of these JAR files,
     * see "Including AEM Forms library files" in Programming with AEM forms
     */
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.IOException;
 import java.io.PrintWriter;

 import javax.servlet.Servlet;
 import javax.servlet.ServletException;
 import javax.servlet.ServletOutputStream;
 import javax.servlet.http.HttpServlet;
 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import com.adobe.livecycle.formsservice.client.*;
 import java.util.*;
 import java.io.InputStream;
 import java.net.URL;

 import com.adobe.idp.Document;
 import com.adobe.idp.dsc.clientsdk.ServiceClientFactory;
 import com.adobe.idp.dsc.clientsdk.ServiceClientFactoryProperties;

 public class RenderFormFragment extends HttpServlet implements Servlet {

     public void doGet(HttpServletRequest req, HttpServletResponse resp)
         throws ServletException, IOException {
             doPost(req,resp);

     }
     public void doPost(HttpServletRequest req, HttpServletResponse resp)
     throws ServletException, IOException {



         try{
             //Set connection properties required to invoke AEM Forms
             Properties connectionProps = new Properties();
             connectionProps.setProperty(ServiceClientFactoryProperties.DSC_DEFAULT_SOAP_ENDPOINT, "https://'[server]:[port]'");
             connectionProps.setProperty(ServiceClientFactoryProperties.DSC_TRANSPORT_PROTOCOL,ServiceClientFactoryProperties.DSC_SOAP_PROTOCOL);
             connectionProps.setProperty(ServiceClientFactoryProperties.DSC_SERVER_TYPE, "JBoss");
             connectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_USERNAME, "administrator");
             connectionProps.setProperty(ServiceClientFactoryProperties.DSC_CREDENTIAL_PASSWORD, "password");

             //Get the value of selected radio button
             String radioValue = req.getParameter("radio");

             //Create an Document object to store form data
             Document oInputData = null;

             //The value of the radio button determines the form data to use
             //which determines which fragments used in the form
             if (radioValue.compareTo("AMERICAN") == 0)            {
                 FileInputStream myData = new FileInputStream("C:\\Adobe\Purchase Order US.xml");
                 oInputData = new Document(myData);
             }
             else if (radioValue.compareTo("CANADIAN") == 0)            {
                 FileInputStream myData = new FileInputStream("C:\\Adobe\Purchase Order Canada.xml");
                 oInputData = new Document(myData);
             }

             //Create a ServiceClientFactory object
             ServiceClientFactory myFactory = ServiceClientFactory.createInstance(connectionProps);

             //Create a FormsServiceClient object
             FormsServiceClient formsClient = new FormsServiceClient(myFactory);

             //Set the parameter values for the renderPDFForm method
             String formName = "Applications/FormsApplication/1.0/FormsFolder/Purchase Order Dynamic.xdp";

             //Cache the PDF form
             PDFFormRenderSpec pdfFormRenderSpec = new PDFFormRenderSpec();
             pdfFormRenderSpec.setCacheEnabled(new Boolean(true));

             //Specify URI values that are required to render a form
             //design based on fragments
             URLSpec uriValues = new URLSpec();
             uriValues.setApplicationWebRoot("https://'[server]:[port]'/RenderFormFragment");
             uriValues.setContentRootURI("repository:///");
             uriValues.setTargetURL("https://'[server]:[port]'/FormsServiceClientApp/HandleData");

             //Invoke the renderPDFForm method and write the
             //results to a client web browser
             FormsResult formOut = formsClient.renderPDFForm(
                         formName,               //formQuery
                         oInputData,             //inDataDoc
                         pdfFormRenderSpec,      //PDFFormRenderSpec
                         uriValues,                //urlSpec
                         null                    //attachments
                         );

             //Create a Document object that stores form data
             Document myData = formOut.getOutputContent();

             //Get the content type of the response and
             //set the HttpServletResponse object’s content type
             String contentType = myData.getContentType();
             resp.setContentType(contentType);

             //Create a ServletOutputStream object
             ServletOutputStream oOutput = resp.getOutputStream();

             //Create an InputStream object
             InputStream inputStream = myData.getInputStream();

             //Write the data stream to the web browser
             byte[] data = new byte[4096];
             int bytesRead = 0;
             while ((bytesRead = inputStream.read(data)) > 0)
             {
                 oOutput.write(data, 0, bytesRead);
             }

         }catch (Exception e) {
              System.out.println("The following exception occurred: "+e.getMessage());
       }
     }
 }

Criação da página da Web creating-the-web-page

A página da Web index.html fornece um ponto de entrada para o servlet Java e chama o serviço Forms. Esta página da Web é um formulário HTML básico que contém dois botões de opção e um botão de envio. O nome dos botões de opção é radio. Quando o usuário clica no botão enviar, os dados do formulário são postados no servlet Java RenderFormFragment.

O servlet Java captura os dados publicados na página HTML usando o seguinte código Java:

             Document oInputData = null;

             //Get the value of selected radio button
             String radioValue = req.getParameter("radio");

             //The value of the radio button determines the form data to use
             //which determines which fragments used in the form
             if (radioValue.compareTo("AMERICAN") == 0)            {
                 FileInputStream myData = new FileInputStream("C:\\Adobe\Purchase Order US.xml");
                 oInputData = new Document(myData);
             }
             else if (radioValue.compareTo("CANADIAN") == 0)            {
                 FileInputStream myData = new FileInputStream("C:\\Adobe\Purchase Order Canada.xml");
                 oInputData = new Document(myData);
             }

O código de HTML a seguir está no arquivo index.html criado durante a configuração do ambiente de desenvolvimento. (Consulte Criando um projeto da Web.)

 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="https://www.w3.org/1999/xhtml">
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <title>Untitled Document</title>
 </head>

 <body>
 <form name="myform" action="https://'[server]:[port]'/FragmentsWebApplication/RenderFormFragment" method="post">
      <table>
      <tr>
        <th>Forms Fragment Web Client</th>
      </tr>
      <tr>
        <td>
          <label>
          <input type="radio" name="radio" id="radio_Data" value="CANADIAN" />
          Canadian data<br />
          </label>
          <p>
            <label>
            <input type="radio" name="radio" id="radio_Data" value="AMERICAN" checked/>
            American data</label>
          </p>
        </td>
      </tr>
      <tr>
      <td>
        <label>
          <input type="submit" name="button_Submit" id="button_Submit" value="Submit" />
            </label>
            </td>
         </tr>
        </table>
      </form>
 </body>
 </html>

Empacotamento do aplicativo web packaging-the-web-application

Para implantar o servlet Java que chama o serviço Forms, empacote sua aplicação web em um arquivo WAR. Certifique-se de que os arquivos JAR externos dos quais a lógica de negócios do componente depende, como adobe-livecycle-client.jar e adobe-forms-client.jar, também estejam incluídos no arquivo WAR.

Para empacotar um aplicativo Web em um arquivo WAR:

  1. Na janela Project Explorer, clique com o botão direito do mouse no projeto FragmentsWebApplication e selecione Exportar > arquivo WAR.
  2. Na caixa de texto Módulo Web, digite FragmentsWebApplication para o nome do projeto Java.
  3. Na caixa de texto Destino, digite FragmentsWebApplication.warpara o nome do arquivo, especifique o local do arquivo WAR e clique em Concluir.

Implantando o arquivo WAR no servidor de aplicativos J2EE deploying-the-war-file-to-the-j2ee-application-server

Você pode implantar o arquivo WAR no servidor da aplicação J2EE no qual o AEM Forms é implantado. Depois que o arquivo WAR for implantado, você poderá acessar a página da Web do HTML usando um navegador da Web.

Para implantar o arquivo WAR no servidor de aplicativos J2EE:

  • Copie o arquivo WAR do caminho de exportação para [Forms Install]\Adobe\Adobe Experience Manager Forms\jboss\server\all\deploy.

Teste do aplicativo web testing-your-web-application

Depois de implantar a aplicação Web, você pode testá-la usando um navegador da Web. Supondo que você esteja usando o mesmo computador que hospeda o AEM Forms, é possível especificar a seguinte URL:

  • http://localhost:8080/FragmentsWebApplication/index.html

    Selecione um botão de opção e clique no botão Enviar. Um Formulário baseado em fragmentos será exibido no navegador da Web. Se ocorrerem problemas, consulte o arquivo de log do servidor de aplicativos J2EE.

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