Montagem de documentos do PDF com marcadores assembling-pdf-documents-with-bookmarks
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.
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.
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.
Resumo das etapas summary-of-steps
Para montar um documento PDF que contenha marcadores, execute as seguintes tarefas:
- Inclua arquivos de projeto.
- Crie um cliente Assembler PDF.
- Faça referência a um documento DDX existente.
- Faça referência a um documento PDF ao qual os marcadores são adicionados.
- Faça referência ao documento XML do marcador.
- Adicione o documento PDF e o documento XML do marcador a uma coleção de Mapa.
- Defina as opções de tempo de execução.
- Monte o documento PDF.
- 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.)
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
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):
-
Inclua arquivos de projeto.
Inclua arquivos JAR do cliente, como adobe-assembler-client.jar, no caminho de classe do seu projeto Java.
-
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 oServiceClientFactory
objeto.
- Crie um
-
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 ojava.io.FileInputStream
objeto.
- Crie um
-
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 ojava.io.FileInputStream
objeto que contém o documento PDF.
- Crie um
-
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 ojava.io.FileInputStream
objeto que contém o documento PDF.
- Crie um
-
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 objetoput
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 objetoput
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.
-
-
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çãoAssemblerOptionSpec
do objetosetFailOnError
método e passfalse
.
- Crie um
-
Monte o documento PDF.
Chame o
AssemblerServiceClient
do objetoinvokeDDX
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 umcom.adobe.livecycle.assembler.client.AssemblerResult
objeto que contém os resultados da tarefa e quaisquer exceções que ocorreram. - A
-
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 objetogetDocuments
método . Isso retorna umajava.util.Map
objeto. - Iterar por meio do
java.util.Map
até encontrar o resultantecom.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 objetocopyToFile
para extrair o documento PDF.
- Chame o
Consulte também
Início rápido (modo SOAP): Montagem de documentos do PDF com marcadores usando a API do Java
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):
-
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. -
Crie um cliente Assembler PDF.
-
Crie um
AssemblerServiceClient
usando seu construtor padrão. -
Crie um
AssemblerServiceClient.Endpoint.Address
usando oSystem.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ávellc_version
atributo. Esse atributo é usado ao criar uma referência de serviço. -
Crie um
System.ServiceModel.BasicHttpBinding
obtendo o valor da variávelAssemblerServiceClient.Endpoint.Binding
campo. Converta o valor de retorno paraBasicHttpBinding
. -
Defina as
System.ServiceModel.BasicHttpBinding
do objetoMessageEncoding
campo paraWSMessageEncoding.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 campoBasicHttpBindingSecurity.Transport.ClientCredentialType
. - Atribuir o valor constante
BasicHttpSecurityMode.TransportCredentialOnly
ao campoBasicHttpBindingSecurity.Security.Mode
.
- Atribuir o nome de usuário dos formulários AEM ao campo
-
-
Faça referência a um documento DDX existente.
- Crie um
BLOB
usando seu construtor. OBLOB
é 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ávelSystem.IO.FileStream
do objetoLength
propriedade. - Preencha a matriz de bytes com dados de fluxo chamando a variável
System.IO.FileStream
do objetoRead
e transmitindo a matriz de bytes, a posição inicial e o comprimento do fluxo a ser lido. - Preencha o
BLOB
ao atribuir seuMTOM
com o conteúdo da matriz de bytes.
- Crie um
-
Faça referência a um documento PDF ao qual os marcadores são adicionados.
- Crie um
BLOB
usando seu construtor. OBLOB
é 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ávelSystem.IO.FileStream
do objetoLength
propriedade. - Preencha a matriz de bytes com dados de fluxo chamando a variável
System.IO.FileStream
do objetoRead
e transmitindo a matriz de bytes, a posição inicial e o comprimento do fluxo a ser lido. - Preencha o
BLOB
ao atribuir seuMTOM
com o conteúdo da matriz de bytes.
- Crie um
-
Faça referência ao documento XML do marcador.
- Crie um
BLOB
usando seu construtor. OBLOB
é 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ávelSystem.IO.FileStream
do objetoLength
propriedade. - Preencha a matriz de bytes com dados de fluxo chamando a variável
System.IO.FileStream
do objetoRead
e transmitindo a matriz de bytes, a posição inicial e o comprimento do fluxo a ser lido. - Preencha o
BLOB
ao atribuir seuMTOM
com o conteúdo da matriz de bytes.
- Crie um
-
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 objetokey
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 oMyMapOf_xsd_string_To_xsd_anyType_Item
do objetovalue
campo. - Adicione o
MyMapOf_xsd_string_To_xsd_anyType_Item
paraMyMapOf_xsd_string_To_xsd_anyType
objeto. Chame oMyMapOf_xsd_string_To_xsd_anyType
do objetoAdd
e passe oMyMapOf_xsd_string_To_xsd_anyType
objeto. (Execute esta tarefa para cada documento PDF de entrada e o documento XML do marcador.)
- Crie um
-
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, atribuafalse
paraAssemblerOptionSpec
do objetofailOnError
membro de dados.
- Crie um
-
Monte o documento PDF.
Chame o
AssemblerServiceClient
do objetoinvokeDDX
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étodoAssemblerResult
objeto que contém os resultados da tarefa e quaisquer exceções que possam ter ocorrido. - A
-
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 objetodocuments
, que é umMap
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 matrizvalue
paraBLOB
. - Extraia os dados binários que representam o documento PDF acessando seu
BLOB
do objetoMTOM
campo. Isso retorna uma matriz de bytes que você pode gravar em um arquivo PDF.
- Acesse o
Consulte também
Chamar o AEM Forms usando MTOM