DocumentaçãoAEM 6.4Guia do Forms

Montagem de documentos do PDF com marcadores assembling-pdf-documents-with-bookmarks

Last update: Thu May 04 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Criado para:

  • Desenvolvedor
CAUTION
AEM 6.4 chegou ao fim do suporte estendido e esta documentação não é mais atualizada. Para obter mais detalhes, consulte nossa períodos de assistência técnica. Encontre as versões compatíveis here.

Você pode montar um documento PDF que contenha marcadores. Por exemplo, suponha que você tem um documento PDF que não contém marcadores e deseja modificá-lo fornecendo marcadores. Usando o serviço Assembler, você pode transmitir a ele um documento PDF que não contém marcadores e obter um documento PDF que contém marcadores.

Os marcadores contêm as seguintes propriedades:

  • Um título que aparece como texto na tela.
  • Uma ação que especifica o que acontece quando um usuário clica no marcador. A ação típica de um marcador é mover para outro local no documento atual ou abrir outro documento do PDF, embora outras ações possam ser especificadas.

Para a finalidade desta discussão, suponha que o seguinte documento DDX seja usado.

 <?xml version="1.0" encoding="UTF-8"?>
 <DDX xmlns="https://ns.adobe.com/DDX/1.0/">
       <PDF result="FinalDoc.pdf">
          <PDF source="Loan.pdf">
             <Bookmarks source="doc2" />
          </PDF>
       </PDF>
 </DDX>

Nesse documento DDX, observe que o atributo de origem recebe o valor Loan.pdf. Este documento DDX especifica que um único documento PDF é passado para o serviço Assembler. Ao montar um documento PDF com marcadores, você deve especificar um documento XML de marcador que descreve os marcadores no documento de resultado. Para especificar um documento XML de marcador, verifique se Bookmarks é especificado no documento DDX.

Neste exemplo de documento DDX, a variável Bookmarks element specified doc2 como o valor. Esse valor indica que o mapa de entrada passado para o serviço Assembler contém uma chave chamada doc2. O valor da variável doc2 é uma chave com.adobe.idp.Document que representa o documento XML do marcador. (Consulte "Idioma dos marcadores" na seção Serviço de Assembler e Referência DDX.)

Este tópico usa a seguinte linguagem de marcadores XML para montar um documento PDF contendo marcadores.

 <?xml version="1.0" encoding="UTF-8"?>
 <Bookmarks xmlns="https://ns.adobe.com/pdf/bookmarks" version="1.0">
       <Bookmark>
          <Action>
             <Launch NewWindow="true">
                <File Name="C:\Adobe\LoanDetails.pdf" />
             </Launch>
          </Action>
         <Title>Open the Loan document</Title>
       </Bookmark>
 <Bookmark>
          <Action>
             <Launch>
                <Win Name="C:\WINDOWS\notepad.exe" />
             </Launch>
          </Action>
     <Title>Launch NotePad</Title>
       </Bookmark>
 </Bookmarks>

Nesse documento XML de marcador, observe o elemento Ação que define a ação executada quando um usuário clica no marcador. No elemento Ação está o elemento do Launch que inicia aplicativos, como o NotePad e abre arquivos, como arquivos PDF. Para abrir um arquivo PDF, você deve usar o elemento File que especifica o arquivo a ser aberto. Por exemplo, no arquivo XML do marcador especificado nesta seção, o nome do arquivo aberto é LoanDetails.pdf.

NOTE
Para obter detalhes completos sobre as ações compatíveis, consulte " Action elemento" na Serviço de Assembler e Referência DDX.

Dado o documento DDX especificado nesta seção e o arquivo XML de marcador como entrada, o serviço Assembler monta um documento PDF que contém os seguintes marcadores.

aw_aw_bmark

Quando um usuário clica no Abrir os Detalhes do Empréstimo favorito, o arquivo LoanDetails.pdf é aberto. Da mesma forma, quando o usuário clica no Iniciar o NotePad marcador, o NotePad foi iniciado.

NOTE
Antes de ler esta seção, é recomendável que você esteja familiarizado com a montagem de documentos do PDF usando o serviço Assembler. Esta seção não discute conceitos, como criar um objeto de coleção que contenha documentos de entrada ou aprender a extrair os resultados do objeto de coleção retornado. (Consulte Montagem programática de documentos do PDF.)
NOTE
Para obter mais informações sobre o serviço Assembler, consulte Referência de serviços para o AEM Forms.
NOTE
Para obter mais informações sobre um documento DDX, consulte Serviço de Assembler e Referência DDX.

Resumo das etapas summary-of-steps

Para montar um documento PDF que contenha marcadores, execute as seguintes tarefas:

  1. Inclua arquivos de projeto.
  2. Crie um cliente Assembler PDF.
  3. Faça referência a um documento DDX existente.
  4. Faça referência a um documento PDF ao qual os marcadores são adicionados.
  5. Faça referência ao documento XML do marcador.
  6. Adicione o documento PDF e o documento XML do marcador a uma coleção de Mapa.
  7. Defina as opções de tempo de execução.
  8. Monte o documento PDF.
  9. Salve o documento PDF que contém marcadores.

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.

Os seguintes arquivos JAR devem ser adicionados ao caminho de classe do seu projeto:

  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-assembler-client.jar
  • adobe-utilities.jar (necessário se o AEM Forms estiver implantado no JBoss)
  • jbossall-client.jar (obrigatório se o AEM Forms for implantado no JBoss)

se o AEM Forms for implantado em um servidor de aplicativos J2EE compatível diferente do JBoss, você deverá substituir os arquivos adobe-utilities.jar e jbossall-client.jar por arquivos JAR específicos do servidor de aplicativos J2EE no qual o AEM Forms é implantado. Para obter informações sobre a localização de todos os arquivos AEM Forms JAR, consulte Inclusão de arquivos da biblioteca Java do AEM Forms.

Criar um cliente do Assembler do PDF

Antes de poder executar programaticamente uma operação Assembler, é necessário criar um cliente de serviço Assembler.

Referência a um documento DDX existente

Um documento DDX deve ser referenciado para montar um documento PDF. Este documento DDX deve conter a variável Bookmarks , que instrui o serviço Assembler a montar um PDF que contenha marcadores. (Consulte o documento DDX mostrado anteriormente nesta seção para obter um exemplo.)

Referência a um documento PDF ao qual os marcadores são adicionados

Faça referência a um documento PDF ao qual os marcadores são adicionados. Não importa se o documento PDF referenciado já contém marcadores. Se a variável Bookmarks é um filho do elemento PDF source, então os Marcadores substituirão aqueles que já existem na fonte PDF. No entanto, se desejar manter os marcadores existentes, verifique se Bookmarks é um irmão do elemento PDF source. Por exemplo, considere o seguinte exemplo:

 <PDF result="foo">
      <PDF source="inDoc"/>
      <Bookmarks source="doc2"/>
 </PDF>

Referência ao documento XML do marcador

Para montar um PDF que contenha novos marcadores, você deve fazer referência a um documento XML de marcador. O documento XML do marcador é passado para o serviço Assembler no objeto de coleção Map. (Consulte o documento XML do marcador mostrado anteriormente nesta seção para obter um exemplo.)

NOTE
Consulte "Idioma dos marcadores" na seção Serviço de Assembler e Referência DDX.

Adicionar o documento PDF e o documento XML do marcador a uma coleção de Mapa

Você deve adicionar o documento PDF ao qual os marcadores são adicionados e o documento XML do marcador à coleção de Mapa. Portanto, o objeto de coleção Map contém dois elementos: um documento PDF e o documento XML do marcador.

Definir opções de tempo de execução

Você pode definir opções de tempo de execução que controlam o comportamento do serviço Assembler enquanto ele executa uma tarefa. Por exemplo, você pode definir uma opção que instrua o serviço Assembler a continuar processando um trabalho se um erro for encontrado. Para obter informações sobre as opções de tempo de execução que podem ser definidas, consulte o AssemblerOptionSpec referência de classe em Referência da API do AEM Forms.

Montar o documento PDF

Para montar um documento PDF que contenha novos marcadores, use o invokeDDX operação. O motivo pelo qual você deve usar a variável invokeDDX operação em vez de outras operações de serviço do Assembler, como invokeOneDocument é porque o serviço Assembler requer um documento XML de marcador passado dentro do objeto de coleção Map. Esse objeto é um parâmetro da variável invokeDDX operação.

Salve o documento PDF que contém marcadores

Você deve extrair os resultados do objeto de mapa retornado e salvar o documento PDF correspondente. (Consulte "Extrair os resultados" em Montagem programática de documentos do PDF.)

Consulte também

Inclusão de arquivos da biblioteca Java do AEM Forms

Configuração das propriedades de conexão

Montagem programática de documentos do PDF

Monte documentos do PDF com marcadores usando a API Java assemble-pdf-documents-with-bookmarks-using-the-java-api

Monte um documento do PDF com marcadores usando a API do Serviço do Assembler (Java):

  1. Inclua arquivos de projeto.

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

  2. Crie um cliente Assembler PDF.

    • Crie um ServiceClientFactory objeto que contém propriedades de conexão. (Consulte Configuração das propriedades de conexão.)
    • Crie um AssemblerServiceClient usando seu construtor e passando o ServiceClientFactory objeto.

  3. Faça referência a um documento DDX existente.

    • Crie um java.io.FileInputStream objeto que representa o documento DDX usando seu construtor e passando um valor de string que especifica o local do arquivo DX.
    • Crie um com.adobe.idp.Document usando seu construtor e passando o java.io.FileInputStream objeto.

  4. Faça referência a um documento PDF ao qual os marcadores são adicionados.

    • Crie um java.io.FileInputStream usando seu construtor e passando o local do documento PDF.
    • Crie um com.adobe.idp.Document usando seu construtor e transmitindo o java.io.FileInputStream objeto que contém o documento PDF.

  5. Faça referência ao documento XML do marcador.

    • Crie um java.io.FileInputStream usando seu construtor e transmitindo o local do arquivo XML que representa o documento XML do marcador.
    • Crie um com.adobe.idp.Document e transmita o java.io.FileInputStream objeto que contém o documento PDF.

  6. Adicione o documento PDF e o documento XML do marcador a uma coleção de Mapa.

    • Crie um java.util.Map objeto usado para armazenar o documento PDF de entrada e o documento XML do marcador.

    • Adicione o documento PDF de entrada chamando o java.util.Map do objeto put e transmitindo os seguintes argumentos:

      • Um valor de string que representa o nome da chave. Esse valor deve corresponder ao valor do elemento PDF source especificado no documento DDX.
      • A com.adobe.idp.Document objeto que contém o documento PDF de entrada.

    • Adicione o documento XML do marcador, chamando o java.util.Map do objeto put e transmitindo os seguintes argumentos:

      • Um valor de string que representa o nome da chave. Esse valor deve corresponder ao valor do elemento de origem Marcadores especificado no documento DX.
      • A com.adobe.idp.Document objeto que contém o documento XML do marcador.

  7. Defina as opções de tempo de execução.

    • Crie um AssemblerOptionSpec que armazena opções de tempo de execução usando seu construtor.
    • Defina as opções de tempo de execução para atender aos seus requisitos de negócios, chamando um método que pertence ao AssemblerOptionSpec objeto. Por exemplo, para instruir o serviço Assembler a continuar o processamento de uma tarefa quando ocorrer um erro, chame a função AssemblerOptionSpec do objeto setFailOnError método e pass false.

  8. Monte o documento PDF.

    Chame o AssemblerServiceClient do objeto invokeDDX e passe os seguintes valores obrigatórios:

    • A com.adobe.idp.Document objeto que representa o documento DDX a ser usado
    • A java.util.Map objeto que contém o documento PDF de entrada e o documento XML do marcador.
    • A com.adobe.livecycle.assembler.client.AssemblerOptionSpec objeto que especifica as opções de tempo de execução, incluindo fonte padrão e nível de log de tarefas

    O invokeDDX método retorna um com.adobe.livecycle.assembler.client.AssemblerResult objeto que contém os resultados da tarefa e quaisquer exceções que ocorreram.

  9. Salve o documento PDF que contém marcadores.

    Para obter o documento PDF recém-criado, execute as seguintes ações:

    • Chame o AssemblerResult do objeto getDocuments método . Isso retorna uma java.util.Map objeto.
    • Iterar por meio do java.util.Map até encontrar o resultante com.adobe.idp.Document objeto. (Você pode usar o elemento PDF result especificado no documento DDX para obter o documento.)
    • Chame o com.adobe.idp.Document do objeto copyToFile para extrair o documento PDF.

Consulte também

Início rápido (modo SOAP): Montagem de documentos do PDF com marcadores usando a API do Java

Inclusão de arquivos da biblioteca Java do AEM Forms

Configuração das propriedades de conexão

Monte documentos do PDF com marcadores usando a API do serviço da Web assemble-pdf-documents-with-bookmarks-using-the-web-service-api

Monte um documento do PDF com marcadores usando a API do Serviço do Assembler (serviço da Web):

  1. Inclua arquivos de projeto.

    Crie um projeto Microsoft .NET que use MTOM. Certifique-se de usar a seguinte definição de WSDL: http://localhost:8080/soap/services/AssemblerService?WSDL&lc_version=9.0.1.

    note note
    NOTE
    Substituir localhost com o endereço IP do servidor que hospeda a AEM Forms.

  2. Crie um cliente Assembler PDF.

    • Crie um AssemblerServiceClient usando seu construtor padrão.

    • Crie um AssemblerServiceClient.Endpoint.Address usando o System.ServiceModel.EndpointAddress construtor. Passe um valor de string que especifica o WSDL para o serviço do AEM Forms (por exemplo, http://localhost:8080/soap/services/AssemblerService?blob=mtom). Não é necessário usar a variável lc_version atributo. Esse atributo é usado ao criar uma referência de serviço.

    • Crie um System.ServiceModel.BasicHttpBinding obtendo o valor da variável AssemblerServiceClient.Endpoint.Binding campo. Converta o valor de retorno para BasicHttpBinding.

    • Defina as System.ServiceModel.BasicHttpBinding do objeto MessageEncoding campo para WSMessageEncoding.Mtom. Esse valor garante que o MTOM seja usado.

    • Ative a autenticação HTTP básica executando as seguintes tarefas:

      • Atribuir o nome de usuário dos formulários AEM ao campo AssemblerServiceClient.ClientCredentials.UserName.UserName.
      • Atribua o valor correspondente da senha ao campo AssemblerServiceClient.ClientCredentials.UserName.Password.
      • Atribuir o valor constante HttpClientCredentialType.Basic ao campo BasicHttpBindingSecurity.Transport.ClientCredentialType.
      • Atribuir o valor constante BasicHttpSecurityMode.TransportCredentialOnly ao campo BasicHttpBindingSecurity.Security.Mode.

  3. Faça referência a um documento DDX existente.

    • Crie um BLOB usando seu construtor. O BLOB é usado para armazenar o documento DDX.
    • Crie um System.IO.FileStream chamando seu construtor e passando um valor de string que representa o local do arquivo do documento DX e o modo no qual o arquivo deve ser aberto.
    • Crie uma matriz de bytes que armazene o conteúdo da variável System.IO.FileStream objeto. Você pode determinar o tamanho da matriz de bytes obtendo a variável System.IO.FileStream do objeto Length propriedade.
    • Preencha a matriz de bytes com dados de fluxo chamando a variável System.IO.FileStream do objeto Read e transmitindo a matriz de bytes, a posição inicial e o comprimento do fluxo a ser lido.
    • Preencha o BLOB ao atribuir seu MTOM com o conteúdo da matriz de bytes.

  4. Faça referência a um documento PDF ao qual os marcadores são adicionados.

    • Crie um BLOB usando seu construtor. O BLOB é usado para armazenar o PDF de entrada.
    • Crie um System.IO.FileStream chamando seu construtor e passando um valor de string que representa o local do arquivo do documento de PDF de entrada e o modo no qual o arquivo deve ser aberto.
    • Crie uma matriz de bytes que armazene o conteúdo da variável System.IO.FileStream objeto. Você pode determinar o tamanho da matriz de bytes obtendo a variável System.IO.FileStream do objeto Length propriedade.
    • Preencha a matriz de bytes com dados de fluxo chamando a variável System.IO.FileStream do objeto Read e transmitindo a matriz de bytes, a posição inicial e o comprimento do fluxo a ser lido.
    • Preencha o BLOB ao atribuir seu MTOM com o conteúdo da matriz de bytes.

  5. Faça referência ao documento XML do marcador.

    • Crie um BLOB usando seu construtor. O BLOB é usado para armazenar o documento XML do marcador.
    • Crie um System.IO.FileStream chamando seu construtor e passando um valor de string que representa o local do arquivo do documento de PDF de entrada e o modo no qual o arquivo deve ser aberto.
    • Crie uma matriz de bytes que armazene o conteúdo da variável System.IO.FileStream objeto. Você pode determinar o tamanho da matriz de bytes obtendo a variável System.IO.FileStream do objeto Length propriedade.
    • Preencha a matriz de bytes com dados de fluxo chamando a variável System.IO.FileStream do objeto Read e transmitindo a matriz de bytes, a posição inicial e o comprimento do fluxo a ser lido.
    • Preencha o BLOB ao atribuir seu MTOM com o conteúdo da matriz de bytes.

  6. Adicione o documento PDF e o documento XML do marcador a uma coleção de Mapa.

    • Crie um MyMapOf_xsd_string_To_xsd_anyType objeto. Este objeto de coleção é usado para armazenar os documentos PDF de entrada e o documento XML do marcador.
    • Para cada documento de PDF de entrada e documento XML de marcador , crie um MyMapOf_xsd_string_To_xsd_anyType_Item objeto.
    • Atribua um valor de string que represente o nome da chave à variável MyMapOf_xsd_string_To_xsd_anyType_Item do objeto key campo. Esse valor deve corresponder ao valor do elemento PDF source especificado no documento DDX.
    • Atribua o BLOB objeto que armazena o documento PDF para o MyMapOf_xsd_string_To_xsd_anyType_Item do objeto value campo.
    • Adicione o MyMapOf_xsd_string_To_xsd_anyType_Item para MyMapOf_xsd_string_To_xsd_anyType objeto. Chame o MyMapOf_xsd_string_To_xsd_anyType do objeto Add e passe o MyMapOf_xsd_string_To_xsd_anyType objeto. (Execute esta tarefa para cada documento PDF de entrada e o documento XML do marcador.)

  7. Defina as opções de tempo de execução.

    • Crie um AssemblerOptionSpec que armazena opções de tempo de execução usando seu construtor.
    • Defina as opções de tempo de execução para atender aos requisitos da empresa, atribuindo um valor a um membro de dados pertencente à AssemblerOptionSpec objeto. Por exemplo, para instruir o serviço Assembler a continuar o processamento de uma tarefa quando ocorrer um erro, atribua false para AssemblerOptionSpec do objeto failOnError membro de dados.

  8. Monte o documento PDF.

    Chame o AssemblerServiceClient do objeto invokeDDX e transmita os seguintes valores:

    • A BLOB objeto que representa o documento DDX
    • O MyMapOf_xsd_string_To_xsd_anyType matriz que contém os documentos de entrada
    • Um AssemblerOptionSpec objeto que especifica as opções de tempo de execução

    O invokeDDX retorna um método AssemblerResult objeto que contém os resultados da tarefa e quaisquer exceções que possam ter ocorrido.

  9. Salve o documento PDF que contém marcadores.

    Para obter o documento PDF recém-criado, execute as seguintes ações:

    • Acesse o AssemblerResult do objeto documents , que é um Map objeto que contém os documentos PDF de resultado.
    • Iterar por meio do Map até encontrar a chave que corresponde ao nome do documento resultante. Em seguida, converta esse membro da matriz value para BLOB.
    • Extraia os dados binários que representam o documento PDF acessando seu BLOB do objeto MTOM campo. Isso retorna uma matriz de bytes que você pode gravar em um arquivo PDF.

Consulte também

Chamar o AEM Forms usando MTOM

recommendation-more-help
a6ebf046-2b8b-4543-bd46-42a0d77792da