Criação dinâmica de documentos DDX dynamically-creating-ddx-documents
Exemplos e exemplos neste documento são somente para AEM Forms no ambiente JEE.
Você pode criar dinamicamente um documento DDX que pode ser usado para executar uma operação do Assembler. A criação dinâmica de um documento DDX permite usar valores nele obtidos durante o tempo de execução. Para criar dinamicamente um documento DDX, use classes que pertençam à linguagem de programação que você está usando. Por exemplo, se você estiver desenvolvendo seu aplicativo cliente usando Java, use classes que pertencem ao pacote org.w3c.dom.*
. Da mesma forma, se você estiver usando o Microsoft .NET, use classes que pertençam ao namespace System.Xml
.
Antes de passar o documento DDX para o serviço do Assembler, converta o XML de uma instância org.w3c.dom.Document
em uma instância com.adobe.idp.Document
. Se você estiver usando serviços da Web, converta o XML do tipo de dados usado para criar o XML (por exemplo, XmlDocument
) em uma instância BLOB
.
Nesta discussão, suponha que o documento DDX a seguir seja criado dinamicamente.
<?xml version="1.0" encoding="UTF-8"?>
<DDX xmlns="https://ns.adobe.com/DDX/1.0/">
<PDFsFromBookmarks prefix="stmt">
<PDF source="AssemblerResultPDF.pdf"/>
</PDFsFromBookmarks>
</DDX>
Este documento DDX desmonta um documento PDF. É recomendável que você esteja familiarizado com a desmontagem de documentos do PDF.
Resumo das etapas summary-of-steps
Para desmontar um documento PDF usando um documento DDX criado dinamicamente, execute as seguintes tarefas:
- Incluir arquivos de projeto.
- Crie um cliente PDF Assembler.
- Crie o documento DDX.
- Converta o documento DDX.
- Definir opções de tempo de execução.
- Desmonte o documento PDF.
- Salve os documentos de PDF desmontados.
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.
Os seguintes arquivos JAR devem ser adicionados ao caminho de classe do projeto:
- adobe-livecycle-client.jar
- adobe-usermanager-client.jar
- adobe-assembler-client.jar
- adobe-utilities.jar (necessário se o AEM Forms for implantado no JBoss)
- jbossall-client.jar (necessário se o AEM Forms for implantado no JBoss)
Criar um cliente PDF Assembler
Antes de executar programaticamente uma operação do Assembler, crie um cliente de serviço do Assembler.
Criar o documento DDX
Crie um documento DDX usando a linguagem de programação que você está usando. Para criar um documento DDX que desmonte um documento PDF, verifique se ele contém o elemento PDFsFromBookmarks
. Converta o tipo de dados usado para criar o documento DDX em uma instância com.adobe.idp.Document
se estiver usando a API Java. Se você estiver usando serviços Web, converta o tipo de dados em uma instância BLOB
.
Converter o documento DDX
Um documento DDX criado usando classes org.w3c.dom
deve ser convertido em um objeto com.adobe.idp.Document
. Para executar essa tarefa ao usar a API Java, use classes de transformação Java XML. Se você estiver usando serviços Web, converta o documento DDX em um objeto BLOB
.
Referenciar um documento PDF para desmontar
Para desmontar um documento PDF, consulte um arquivo PDF que representa o documento PDF a ser desmontado. Quando passado para o serviço Assembler, um documento PDF separado é retornado para cada marcador de nível 1 no documento.
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 um job. Por exemplo, você pode definir uma opção que instrui o serviço Assembler a continuar processando um job se um erro for encontrado. Para definir opções de tempo de execução, use um objeto AssemblerOptionSpec
.
Desmontar o documento PDF
Desmonte o documento PDF invocando a operação invokeDDX
. Transmita o documento DDX criado dinamicamente. O serviço Assembler retorna documentos PDF desmontados dentro de um objeto de coleção.
Salvar os documentos de PDF desmontados
Todos os documentos de PDF desmontados são retornados dentro de um objeto de coleção. Repita o processo através do objeto de coleção e salve cada documento de PDF como um arquivo de PDF.
Consulte também
Criar dinamicamente um documento DDX usando a API do Java
Criar dinamicamente um documento DDX usando a API do serviço Web
Inclusão de arquivos da biblioteca Java do AEM Forms
Criar dinamicamente um documento DDX usando a API do Java dynamically-create-a-ddx-document-using-the-java-api
Crie dinamicamente um documento DDX e desmonte um documento PDF usando a API de serviço do Assembler (Java):
-
Incluir arquivos de projeto.
Inclua arquivos JAR do cliente, como adobe-assembler-client.jar, no caminho de classe do projeto Java.
-
Crie um cliente PDF Assembler.
- Crie um objeto
ServiceClientFactory
que contenha propriedades de conexão. - Crie um objeto
AssemblerServiceClient
usando seu construtor e transmitindo o objetoServiceClientFactory
.
- Crie um objeto
-
Crie o documento DDX.
-
Crie um objeto Java
DocumentBuilderFactory
chamando o métodonewInstance
da classeDocumentBuilderFactory
. -
Crie um objeto Java
DocumentBuilder
chamando o métodonewDocumentBuilder
do objetoDocumentBuilderFactory
. -
Chame o método
newDocument
do objetoDocumentBuilder
para instanciar um objetoorg.w3c.dom.Document
. -
Crie o elemento raiz do documento DDX invocando o método
createElement
do objetoorg.w3c.dom.Document
. Este método cria um objetoElement
que representa o elemento raiz. Passe um valor de cadeia de caracteres que representa o nome do elemento para o métodocreateElement
. Converter o valor de retorno emElement
. Em seguida, defina um valor para o elemento filho chamando seu métodosetAttribute
. Finalmente, anexe o elemento ao elemento de cabeçalho chamando o métodoappendChild
do elemento de cabeçalho e passe o objeto de elemento filho como argumento. As linhas de código a seguir mostram essa lógica de aplicação:Element root = (Element)document.createElement("DDX"); root.setAttribute("xmlns","https://ns.adobe.com/DDX/1.0/"); document.appendChild(root);
-
Crie o elemento
PDFsFromBookmarks
chamando o métodocreateElement
do objetoDocument
. Passe um valor de cadeia de caracteres que representa o nome do elemento para o métodocreateElement
. Converter o valor de retorno emElement
. Defina um valor para o elementoPDFsFromBookmarks
chamando seu métodosetAttribute
. Anexe o elementoPDFsFromBookmarks
ao elementoDDX
, chamando o métodoappendChild
do elemento DDX. Passe o objeto de elementoPDFsFromBookmarks
como argumento. As linhas de código a seguir mostram essa lógica de aplicação:Element PDFsFromBookmarks = (Element)document.createElement("PDFsFromBookmarks"); PDFsFromBookmarks.setAttribute("prefix","stmt"); root.appendChild(PDFsFromBookmarks);
-
Crie um elemento
PDF
chamando o métodocreateElement
do objetoDocument
. Transmita um valor de string que represente o nome do elemento. Converter o valor de retorno emElement
. Defina um valor para o elementoPDF
chamando seu métodosetAttribute
. Anexe o elementoPDF
ao elementoPDFsFromBookmarks
, chamando o métodoappendChild
do elementoPDFsFromBookmarks
. Passe o objeto de elementoPDF
como argumento. As linhas de código a seguir mostram essa lógica de aplicação:Element PDF = (Element)document.createElement("PDF"); PDF.setAttribute("source","AssemblerResultPDF.pdf"); PDFsFromBookmarks.appendChild(PDF);
-
-
Converta o documento DDX.
- Crie um objeto
javax.xml.transform.Transformer
invocando o métodonewInstance
estático do objetojavax.xml.transform.Transformer
. - Crie um objeto
Transformer
invocando o métodonewTransformer
do objetoTransformerFactory
. - Crie um objeto
ByteArrayOutputStream
usando seu construtor. - Crie um objeto
javax.xml.transform.dom.DOMSource
usando seu construtor. Transmita o objetoorg.w3c.dom.Document
que representa o documento DDX. - Crie um objeto
javax.xml.transform.dom.DOMSource
usando seu construtor e transmitindo o objetoByteArrayOutputStream
. - Preencha o objeto Java
ByteArrayOutputStream
invocando o métodotransform
do objetojavax.xml.transform.Transformer
. Passar os objetosjavax.xml.transform.dom.DOMSource
ejavax.xml.transform.stream.StreamResult
. - Crie uma matriz de bytes e aloque o tamanho do objeto
ByteArrayOutputStream
à matriz de bytes. - Preencha a matriz de bytes invocando o método
toByteArray
do objetoByteArrayOutputStream
. - Crie um objeto
com.adobe.idp.Document
usando seu construtor e transmitindo a matriz de bytes.
- Crie um objeto
-
Referencie um documento do PDF para desmontar.
-
Crie um objeto
java.util.Map
usado para armazenar documentos de PDF de entrada usando um construtorHashMap
. -
Crie um objeto
java.io.FileInputStream
usando seu construtor e transmitindo o local do documento PDF a ser desmontado. -
Crie um objeto
com.adobe.idp.Document
. Passe o objetojava.io.FileInputStream
que contém o documento PDF a ser desmontado. -
Adicione uma entrada ao objeto
java.util.Map
invocando seu métodoput
e transmitindo os seguintes argumentos:- Um valor de string que representa o nome da chave. Este valor deve corresponder ao valor do elemento de origem PDF especificado no documento DDX. (No documento DDX criado dinamicamente, o valor é
AssemblerResultPDF.pdf
.) - Um objeto
com.adobe.idp.Document
que contém o documento PDF a ser desmontado.
- Um valor de string que representa o nome da chave. Este valor deve corresponder ao valor do elemento de origem PDF especificado no documento DDX. (No documento DDX criado dinamicamente, o valor é
-
-
Definir opções de tempo de execução.
- Crie um objeto
AssemblerOptionSpec
que armazene opções de tempo de execução usando seu construtor. - Defina as opções de tempo de execução para atender aos requisitos da sua empresa invocando um método que pertença ao objeto
AssemblerOptionSpec
. Por exemplo, para instruir o serviço Assembler a continuar processando um trabalho quando ocorrer um erro, chame o métodosetFailOnError
do objetoAssemblerOptionSpec
e passefalse
.
- Crie um objeto
-
Desmonte o documento PDF.
Invoque o método
invokeDDX
do objetoAssemblerServiceClient
e passe os seguintes valores:- Um objeto
com.adobe.idp.Document
que representa o documento DDX criado dinamicamente - Um objeto
java.util.Map
que contém o documento PDF a ser desmontado - Um objeto
com.adobe.livecycle.assembler.client.AssemblerOptionSpec
que especifica as opções de tempo de execução, incluindo a fonte padrão e o nível de log do trabalho
O método
invokeDDX
retorna um objetocom.adobe.livecycle.assembler.client.AssemblerResult
que contém os documentos PDF desmontados e as exceções que ocorreram. - Um objeto
-
Salve os documentos de PDF desmontados.
Para obter os documentos de PDF desmontados, execute as seguintes ações:
- Invoque o método
getDocuments
do objetoAssemblerResult
. Este método retorna um objetojava.util.Map
. - Repita o objeto
java.util.Map
até encontrar o objetocom.adobe.idp.Document
resultante. - Invoque o método
copyToFile
do objetocom.adobe.idp.Document
para extrair o documento PDF.
- Invoque o método
Consulte também
Início rápido (modo SOAP): criando dinamicamente um documento DDX usando a API Java
Criar dinamicamente um documento DDX usando a API do serviço Web dynamically-create-a-ddx-document-using-the-web-service-api
Crie dinamicamente um documento DDX e desmonte um documento PDF usando a API de serviço do Assembler (serviço Web):
-
Incluir arquivos de projeto.
Crie um projeto Microsoft .NET que use MTOM. Certifique-se de usar a seguinte definição WSDL ao definir uma referência de serviço:
http://localhost:8080/soap/services/AssemblerService?WSDL&lc_version=9.0.1
.note note NOTE Substitua localhost
pelo endereço IP do servidor que hospeda o AEM Forms. -
Crie um cliente PDF Assembler.
-
Crie um objeto
AssemblerServiceClient
usando seu construtor padrão. -
Crie um objeto
AssemblerServiceClient.Endpoint.Address
usando o construtorSystem.ServiceModel.EndpointAddress
. Transmita um valor de string que especifique o WSDL para o serviço AEM Forms (por exemplo,http://localhost:8080/soap/services/AssemblerService?blob=mtom
). Você não precisa usar o atributolc_version
. Esse atributo é usado quando você cria uma referência de serviço. -
Crie um objeto
System.ServiceModel.BasicHttpBinding
obtendo o valor do campoAssemblerServiceClient.Endpoint.Binding
. Converter o valor de retorno emBasicHttpBinding
. -
Defina o campo
MessageEncoding
do objetoSystem.ServiceModel.BasicHttpBinding
comoWSMessageEncoding.Mtom
. Esse valor garante que a MTOM seja usada. -
Ative a autenticação HTTP básica executando as seguintes tarefas:
- Atribua o nome de usuário dos formulários AEM ao campo
AssemblerServiceClient.ClientCredentials.UserName.UserName
. - Atribua o valor de senha correspondente ao campo
AssemblerServiceClient.ClientCredentials.UserName.Password
. - Atribua o valor constante
HttpClientCredentialType.Basic
ao campoBasicHttpBindingSecurity.Transport.ClientCredentialType
. - Atribua o valor constante
BasicHttpSecurityMode.TransportCredentialOnly
ao campoBasicHttpBindingSecurity.Security.Mode
.
- Atribua o nome de usuário dos formulários AEM ao campo
-
-
Crie o documento DDX.
-
Crie um objeto
System.Xml.XmlElement
usando seu construtor. -
Crie o elemento raiz do documento DDX invocando o método
CreateElement
do objetoXmlElement
. Este método cria um objetoElement
que representa o elemento raiz. Passe um valor de cadeia de caracteres que representa o nome do elemento para o métodoCreateElement
. Defina um valor para o elemento DDX chamando seu métodoSetAttribute
. Finalmente, anexe o elemento ao documento DDX chamando o métodoAppendChild
do objetoXmlElement
. Passe o objeto DDX como argumento. As linhas de código a seguir mostram essa lógica de aplicação:System.Xml.XmlElement root = ddx.CreateElement("DDX"); root.SetAttribute("xmlns", "https://ns.adobe.com/DDX/1.0/"); ddx.AppendChild(root);
-
Crie o elemento
PDFsFromBookmarks
do documento DDX chamando o métodoCreateElement
do objetoXmlElement
. Passe um valor de cadeia de caracteres que representa o nome do elemento para o métodoCreateElement
. Em seguida, defina um valor para o elemento chamando seu métodoSetAttribute
. Anexe o elementoPDFsFromBookmarks
ao elemento raiz, chamando o métodoAppendChild
do elementoDDX
. Passe o objeto de elementoPDFsFromBookmarks
como argumento. As linhas de código a seguir mostram essa lógica de aplicação:XmlElement PDFsFromBookmarks = ddx.CreateElement("PDFsFromBookmarks"); PDFsFromBookmarks.SetAttribute("prefix", "stmt"); root.AppendChild(PDFsFromBookmarks);
-
Crie o elemento
PDF
do documento DDX chamando o métodoCreateElement
do objetoXmlElement
. Passe um valor de cadeia de caracteres que representa o nome do elemento para o métodoCreateElement
. Em seguida, defina um valor para o elemento filho chamando seu métodoSetAttribute
. Anexe o elementoPDF
ao elementoPDFsFromBookmarks
, chamando o métodoAppendChild
do elementoPDFsFromBookmarks
. Passe o objeto de elementoPDF
como argumento. As linhas de código a seguir mostram essa lógica de aplicação:XmlElement PDF = ddx.CreateElement("PDF"); PDF.SetAttribute("source", "AssemblerResultPDF.pdf"); PDFsFromBookmarks.AppendChild(PDF);
-
-
Converta o documento DDX.
-
Crie um objeto
System.IO.MemoryStream
usando seu construtor. -
Preencha o objeto
MemoryStream
com o documento DDX usando o objetoXmlElement
que representa o documento DDX. Invoque o métodoSave
do objetoXmlElement
e passe o objetoMemoryStream
. -
Crie uma matriz de bytes e preencha-a com dados no objeto
MemoryStream
. O código a seguir mostra essa lógica de aplicação:int bufLen = Convert.ToInt32(stream.Length); byte[] byteArray = new byte[bufLen]; stream.Position = 0; int count = stream.Read(byteArray, 0, bufLen);
-
Crie um objeto
BLOB
. Atribua a matriz de bytes ao campoMTOM
do objetoBLOB
.
-
-
Referencie um documento do PDF para desmontar.
- Crie um objeto
BLOB
usando seu construtor. O objetoBLOB
é usado para armazenar o documento de PDF de entrada. Este objetoBLOB
é passado parainvokeOneDocument
como argumento. - Crie um objeto
System.IO.FileStream
invocando seu construtor. Transmita um valor de string que represente o local do arquivo do PDF de entrada e o modo no qual o arquivo será aberto. - Crie uma matriz de bytes que armazene o conteúdo do objeto
System.IO.FileStream
. Você pode determinar o tamanho da matriz de bytes obtendo a propriedadeLength
do objetoSystem.IO.FileStream
. - Preencha a matriz de bytes com dados de fluxo invocando o método
Read
do objetoSystem.IO.FileStream
e transmitindo a matriz de bytes, a posição inicial e o comprimento do fluxo para leitura. - Preencha o objeto
BLOB
atribuindo à propriedadeMTOM
o conteúdo da matriz de bytes.
- Crie um objeto
-
Definir opções de tempo de execução.
- Crie um objeto
AssemblerOptionSpec
que armazene opções de tempo de execução usando seu construtor. - Defina opções de tempo de execução para atender aos requisitos comerciais atribuindo um valor a um membro de dados que pertença ao objeto
AssemblerOptionSpec
. Por exemplo, para instruir o serviço Assembler a continuar processando um trabalho quando ocorrer um erro, atribuafalse
ao membro de dadosfailOnError
do objetoAssemblerOptionSpec
.
- Crie um objeto
-
Desmonte o documento PDF.
Invoque o método
invokeDDX
do objetoAssemblerServiceClient
e passe os seguintes valores:- Um objeto
BLOB
que representa o documento DDX criado dinamicamente - A matriz
mapItem
que contém o documento PDF de entrada - Um objeto
AssemblerOptionSpec
que especifica as opções de tempo de execução
O método
invokeDDX
retorna um objetoAssemblerResult
que contém os resultados do trabalho e as exceções que ocorreram. - Um objeto
-
Salve os documentos de PDF desmontados.
Para obter os documentos PDF recém-criados, execute as seguintes ações:
- Acesse o campo
documents
do objetoAssemblerResult
, que é um objetoMap
que contém os documentos PDF desmontados. - Repita através do objeto
Map
para obter cada documento resultante. Em seguida, converta osvalue
do membro da matriz emBLOB
. - Extraia os dados binários que representam o documento PDF acessando a propriedade
MTOM
do objetoBLOB
. Isso retorna uma matriz de bytes que você pode gravar em um arquivo PDF.
- Acesse o campo
Consulte também
Chamar o AEM Forms usando MTOM
Chamar o AEM Forms usando SwaRef