Creación dinámica de documentos DDX dynamically-creating-ddx-documents
Las muestras y los ejemplos de este documento solo son para AEM Forms en un entorno JEE.
Puede crear dinámicamente un documento DDX que se pueda utilizar para realizar una operación de Assembler. La creación dinámica de un documento DDX permite utilizar valores en el documento DDX que se obtienen durante el tiempo de ejecución. Para crear dinámicamente un documento DDX, utilice clases que pertenezcan al lenguaje de programación que esté utilizando. Por ejemplo, si está desarrollando la aplicación cliente mediante Java, utilice clases que pertenezcan al paquete org.w3c.dom.*
. Del mismo modo, si utiliza Microsoft .NET, utilice clases que pertenezcan al espacio de nombres System.Xml
.
Antes de pasar el documento DDX al servicio Assembler, convierta el XML de una instancia de org.w3c.dom.Document
a una instancia de com.adobe.idp.Document
. Si utiliza servicios web, convierta el XML del tipo de datos utilizado para crear el XML (por ejemplo, XmlDocument
) a una instancia de BLOB
.
Para esta discusión, suponga que el siguiente documento DDX se crea dinámicamente.
<?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 un documento de PDF. Se recomienda que esté familiarizado con el desmontaje de documentos del PDF.
Resumen de los pasos summary-of-steps
Para desmontar un documento de PDF mediante un documento DDX creado dinámicamente, realice las siguientes tareas:
- Incluir archivos de proyecto.
- Cree un cliente de PDF Assembler.
- Cree el documento DDX.
- Convierta el documento DDX.
- Establecer opciones en tiempo de ejecución.
- Desmontar el documento del PDF.
- Guarde los documentos del PDF desmontados.
Incluir archivos de proyecto
Incluya los archivos necesarios en el proyecto de desarrollo. Si está creando una aplicación cliente con Java, incluya los archivos JAR necesarios. Si utiliza servicios web, asegúrese de incluir los archivos proxy.
Los siguientes archivos JAR deben agregarse a la ruta de clase del proyecto:
- adobe-livecycle-client.jar
- adobe-usermanager-client.jar
- adobe-assembler-client.jar
- adobe-utilities.jar (requerido si AEM Forms está implementado en JBoss)
- jbossall-client.jar (requerido si AEM Forms está implementado en JBoss)
Crear un cliente de ensamblador de PDF
Para poder realizar mediante programación una operación de Assembler, cree un cliente de servicio Assembler.
Crear el documento DDX
Cree un documento DDX utilizando el lenguaje de programación que está utilizando. Para crear un documento DDX que desensamble un documento de PDF, asegúrese de que contenga el elemento PDFsFromBookmarks
. Convierta el tipo de datos utilizado para crear el documento DDX a una instancia de com.adobe.idp.Document
si utiliza la API de Java. Si utiliza servicios web, convierta el tipo de datos a una instancia de BLOB
.
Convertir el documento DDX
Un documento DDX creado con org.w3c.dom
clases debe convertirse en un objeto com.adobe.idp.Document
. Para realizar esta tarea al utilizar la API de Java, utilice las clases de transformación XML de Java. Si utiliza servicios web, convierta el documento DDX en un objeto BLOB
.
Hacer referencia a un documento de PDF para desmontar
Para desmontar un documento de PDF, haga referencia a un fichero de PDF que represente el documento de PDF que se va a desmontar. Cuando se pasa al servicio Assembler, se devuelve un documento de PDF independiente para cada marcador de nivel 1 del documento.
Establecer opciones en tiempo de ejecución
Puede establecer opciones en tiempo de ejecución que controlen el comportamiento del servicio Assembler mientras realiza un trabajo. Por ejemplo, puede establecer una opción que indique al servicio Assembler que continúe procesando un trabajo si se produce un error. Para establecer las opciones en tiempo de ejecución, se usa un objeto AssemblerOptionSpec
.
Desmontar el documento del PDF
Quite el documento del PDF invocando la operación invokeDDX
. Pase el documento DDX creado dinámicamente. El servicio Assembler devuelve documentos de PDF desensamblados dentro de un objeto de colección.
Guardar los documentos de PDF desensamblados
Todos los documentos de PDF desensamblados se devuelven dentro de un objeto de colección. Recorra en iteración el objeto de colección y guarde cada documento de PDF como un archivo de PDF.
Consulte también
Crear dinámicamente un documento DDX mediante la API de Java
Crear dinámicamente un documento DDX mediante la API de servicio web
Incluir archivos de biblioteca Java de AEM Forms
Crear dinámicamente un documento DDX mediante la API de Java dynamically-create-a-ddx-document-using-the-java-api
Cree de forma dinámica un documento DDX y desmonte un documento de PDF mediante la API del servicio Assembler (Java):
-
Incluir archivos de proyecto.
Incluya archivos JAR de cliente, como adobe-assembler-client.jar, en la ruta de clase del proyecto Java.
-
Cree un cliente de PDF Assembler.
- Cree un objeto
ServiceClientFactory
que contenga propiedades de conexión. - Cree un objeto
AssemblerServiceClient
utilizando su constructor y pasando el objetoServiceClientFactory
.
- Cree un objeto
-
Cree el documento DDX.
-
Cree un objeto Java
DocumentBuilderFactory
llamando al métodonewInstance
de la claseDocumentBuilderFactory
. -
Cree un objeto Java
DocumentBuilder
llamando al métodonewDocumentBuilder
del objetoDocumentBuilderFactory
. -
Llame al método
newDocument
del objetoDocumentBuilder
para crear una instancia de un objetoorg.w3c.dom.Document
. -
Cree el elemento raíz del documento DDX invocando el método
createElement
del objetoorg.w3c.dom.Document
. Este método crea un objetoElement
que representa el elemento raíz. Pase un valor de cadena que represente el nombre del elemento al métodocreateElement
. Convertir el valor devuelto enElement
. A continuación, establezca un valor para el elemento secundario llamando a su métodosetAttribute
. Finalmente, agregue el elemento al elemento header llamando al métodoappendChild
del elemento header y pase el objeto del elemento secundario como argumento. Las siguientes líneas de código muestran esta lógica de aplicación:Element root = (Element)document.createElement("DDX"); root.setAttribute("xmlns","https://ns.adobe.com/DDX/1.0/"); document.appendChild(root);
-
Cree el elemento
PDFsFromBookmarks
llamando al métodocreateElement
del objetoDocument
. Pase un valor de cadena que represente el nombre del elemento al métodocreateElement
. Convertir el valor devuelto enElement
. Establezca un valor para el elementoPDFsFromBookmarks
llamando a su métodosetAttribute
. Anexe el elementoPDFsFromBookmarks
al elementoDDX
llamando al métodoappendChild
del elemento DDX. Pase el objeto de elementoPDFsFromBookmarks
como argumento. Las siguientes líneas de código muestran esta lógica de aplicación:Element PDFsFromBookmarks = (Element)document.createElement("PDFsFromBookmarks"); PDFsFromBookmarks.setAttribute("prefix","stmt"); root.appendChild(PDFsFromBookmarks);
-
Cree un elemento
PDF
llamando al métodocreateElement
del objetoDocument
. Pase un valor de cadena que represente el nombre del elemento. Convertir el valor devuelto enElement
. Establezca un valor para el elementoPDF
llamando a su métodosetAttribute
. Anexe el elementoPDF
al elementoPDFsFromBookmarks
llamando al métodoappendChild
del elementoPDFsFromBookmarks
. Pase el objeto de elementoPDF
como argumento. Las siguientes líneas de código muestran esta lógica de aplicación:Element PDF = (Element)document.createElement("PDF"); PDF.setAttribute("source","AssemblerResultPDF.pdf"); PDFsFromBookmarks.appendChild(PDF);
-
-
Convierta el documento DDX.
- Cree un objeto
javax.xml.transform.Transformer
invocando el métodonewInstance
estático del objetojavax.xml.transform.Transformer
. - Cree un objeto
Transformer
invocando el métodonewTransformer
del objetoTransformerFactory
. - Crear un objeto
ByteArrayOutputStream
mediante su constructor. - Crear un objeto
javax.xml.transform.dom.DOMSource
mediante su constructor. Pase el objetoorg.w3c.dom.Document
que representa el documento DDX. - Cree un objeto
javax.xml.transform.dom.DOMSource
utilizando su constructor y pasando el objetoByteArrayOutputStream
. - Rellene el objeto Java
ByteArrayOutputStream
invocando el métodotransform
del objetojavax.xml.transform.Transformer
. Pase los objetosjavax.xml.transform.dom.DOMSource
yjavax.xml.transform.stream.StreamResult
. - Cree una matriz de bytes y asigne el tamaño del objeto
ByteArrayOutputStream
a la matriz de bytes. - Rellene la matriz de bytes invocando el método
toByteArray
del objetoByteArrayOutputStream
. - Cree un objeto
com.adobe.idp.Document
utilizando su constructor y pasando la matriz de bytes.
- Cree un objeto
-
Hacer referencia a un documento de PDF para desmontar.
-
Cree un objeto
java.util.Map
que se use para almacenar documentos del PDF de entrada usando un constructorHashMap
. -
Cree un objeto
java.io.FileInputStream
utilizando su constructor y pasando la ubicación del documento de PDF que desea desmontar. -
Crear un objeto
com.adobe.idp.Document
. Pase el objetojava.io.FileInputStream
que contiene el documento de PDF que se va a desmontar. -
Agregue una entrada al objeto
java.util.Map
invocando su métodoput
y pasando los siguientes argumentos:- Valor de cadena que representa el nombre de clave. Este valor debe coincidir con el valor del elemento de origen PDF especificado en el documento DDX. (En el documento DDX creado dinámicamente, el valor es
AssemblerResultPDF.pdf
). - Objeto
com.adobe.idp.Document
que contiene el documento de PDF que se va a desmontar.
- Valor de cadena que representa el nombre de clave. Este valor debe coincidir con el valor del elemento de origen PDF especificado en el documento DDX. (En el documento DDX creado dinámicamente, el valor es
-
-
Establecer opciones en tiempo de ejecución.
- Cree un objeto
AssemblerOptionSpec
que almacene opciones en tiempo de ejecución mediante su constructor. - Establezca opciones en tiempo de ejecución para satisfacer sus necesidades empresariales invocando un método que pertenezca al objeto
AssemblerOptionSpec
. Por ejemplo, para indicar al servicio Assembler que continúe procesando un trabajo cuando se produzca un error, invoque el métodosetFailOnError
del objetoAssemblerOptionSpec
y pasefalse
.
- Cree un objeto
-
Desmontar el documento del PDF.
Invoque el método
invokeDDX
del objetoAssemblerServiceClient
y pase los siguientes valores:- Un objeto
com.adobe.idp.Document
que representa el documento DDX creado dinámicamente - Objeto
java.util.Map
que contiene el documento de PDF que se va a desmontar - Un objeto
com.adobe.livecycle.assembler.client.AssemblerOptionSpec
que especifica las opciones en tiempo de ejecución, incluidas la fuente predeterminada y el nivel de registro del trabajo
El método
invokeDDX
devuelve un objetocom.adobe.livecycle.assembler.client.AssemblerResult
que contiene los documentos de PDF desensamblados y las excepciones que se han producido. - Un objeto
-
Guarde los documentos del PDF desmontados.
Para obtener los documentos de PDF desmontados, realice las siguientes acciones:
- Invoque el método
getDocuments
del objetoAssemblerResult
. Este método devuelve un objetojava.util.Map
. - Recorra en iteración el objeto
java.util.Map
hasta encontrar el objetocom.adobe.idp.Document
resultante. - Invoque el método
copyToFile
del objetocom.adobe.idp.Document
para extraer el documento del PDF.
- Invoque el método
Consulte también
SOAP Inicio rápido (modo de): Creación dinámica de un documento DDX mediante la API de Java
Crear dinámicamente un documento DDX mediante la API de servicio web dynamically-create-a-ddx-document-using-the-web-service-api
Cree de forma dinámica un documento DDX y desmonte un documento de PDF mediante la API del servicio Assembler (servicio web):
-
Incluir archivos de proyecto.
Cree un proyecto de Microsoft .NET que utilice MTOM. Asegúrese de utilizar la siguiente definición de WSDL al establecer una referencia de servicio:
http://localhost:8080/soap/services/AssemblerService?WSDL&lc_version=9.0.1
.note note NOTE Reemplace localhost
por la dirección IP del servidor que hospeda AEM Forms. -
Cree un cliente de PDF Assembler.
-
Cree un objeto
AssemblerServiceClient
utilizando su constructor predeterminado. -
Cree un objeto
AssemblerServiceClient.Endpoint.Address
mediante el constructorSystem.ServiceModel.EndpointAddress
. Pase un valor de cadena que especifique el WSDL al servicio AEM Forms (por ejemplo,http://localhost:8080/soap/services/AssemblerService?blob=mtom
). No necesita usar el atributolc_version
. Este atributo se utiliza al crear una referencia de servicio. -
Cree un objeto
System.ServiceModel.BasicHttpBinding
obteniendo el valor del campoAssemblerServiceClient.Endpoint.Binding
. Convertir el valor devuelto enBasicHttpBinding
. -
Establezca el campo
MessageEncoding
del objetoSystem.ServiceModel.BasicHttpBinding
enWSMessageEncoding.Mtom
. Este valor garantiza que se utiliza MTOM. -
Habilite la autenticación HTTP básica realizando las siguientes tareas:
- AEM Asigne el nombre de usuario de los formularios de la al campo
AssemblerServiceClient.ClientCredentials.UserName.UserName
. - Asigne el valor de contraseña correspondiente al campo
AssemblerServiceClient.ClientCredentials.UserName.Password
. - Asigne el valor constante
HttpClientCredentialType.Basic
al campoBasicHttpBindingSecurity.Transport.ClientCredentialType
. - Asigne el valor constante
BasicHttpSecurityMode.TransportCredentialOnly
al campoBasicHttpBindingSecurity.Security.Mode
.
- AEM Asigne el nombre de usuario de los formularios de la al campo
-
-
Cree el documento DDX.
-
Crear un objeto
System.Xml.XmlElement
mediante su constructor. -
Cree el elemento raíz del documento DDX invocando el método
CreateElement
del objetoXmlElement
. Este método crea un objetoElement
que representa el elemento raíz. Pase un valor de cadena que represente el nombre del elemento al métodoCreateElement
. Establezca un valor para el elemento DDX llamando a su métodoSetAttribute
. Finalmente, anexe el elemento al documento DDX llamando al métodoAppendChild
del objetoXmlElement
. Pase el objeto DDX como argumento. Las siguientes líneas de código muestran esta lógica de aplicación:System.Xml.XmlElement root = ddx.CreateElement("DDX"); root.SetAttribute("xmlns", "https://ns.adobe.com/DDX/1.0/"); ddx.AppendChild(root);
-
Cree el elemento
PDFsFromBookmarks
del documento DDX llamando al métodoCreateElement
del objetoXmlElement
. Pase un valor de cadena que represente el nombre del elemento al métodoCreateElement
. A continuación, establezca un valor para el elemento llamando a su métodoSetAttribute
. Anexe el elementoPDFsFromBookmarks
al elemento raíz llamando al métodoAppendChild
del elementoDDX
. Pase el objeto de elementoPDFsFromBookmarks
como argumento. Las siguientes líneas de código muestran esta lógica de aplicación:XmlElement PDFsFromBookmarks = ddx.CreateElement("PDFsFromBookmarks"); PDFsFromBookmarks.SetAttribute("prefix", "stmt"); root.AppendChild(PDFsFromBookmarks);
-
Cree el elemento
PDF
del documento DDX llamando al métodoCreateElement
del objetoXmlElement
. Pase un valor de cadena que represente el nombre del elemento al métodoCreateElement
. A continuación, establezca un valor para el elemento secundario llamando a su métodoSetAttribute
. Anexe el elementoPDF
al elementoPDFsFromBookmarks
llamando al métodoAppendChild
del elementoPDFsFromBookmarks
. Pase el objeto de elementoPDF
como argumento. Las siguientes líneas de código muestran esta lógica de aplicación:XmlElement PDF = ddx.CreateElement("PDF"); PDF.SetAttribute("source", "AssemblerResultPDF.pdf"); PDFsFromBookmarks.AppendChild(PDF);
-
-
Convierta el documento DDX.
-
Crear un objeto
System.IO.MemoryStream
mediante su constructor. -
Rellene el objeto
MemoryStream
con el documento DDX mediante el objetoXmlElement
que representa el documento DDX. Invoque el métodoSave
del objetoXmlElement
y pase el objetoMemoryStream
. -
Cree una matriz de bytes y rellénela con datos en el objeto
MemoryStream
. El siguiente código muestra esta lógica de aplicación:int bufLen = Convert.ToInt32(stream.Length); byte[] byteArray = new byte[bufLen]; stream.Position = 0; int count = stream.Read(byteArray, 0, bufLen);
-
Crear un objeto
BLOB
. Asigne la matriz de bytes al campoMTOM
del objetoBLOB
.
-
-
Hacer referencia a un documento de PDF para desmontar.
- Crear un objeto
BLOB
mediante su constructor. El objetoBLOB
se usa para almacenar el documento del PDF de entrada. Este objetoBLOB
se pasó ainvokeOneDocument
como argumento. - Cree un objeto
System.IO.FileStream
invocando su constructor. Pase un valor de cadena que represente la ubicación del archivo del documento del PDF de entrada y el modo en que se abrirá el archivo. - Cree una matriz de bytes que almacene el contenido del objeto
System.IO.FileStream
. Puede determinar el tamaño de la matriz de bytes obteniendo la propiedadLength
del objetoSystem.IO.FileStream
. - Rellene la matriz de bytes con datos de secuencia invocando el método
Read
del objetoSystem.IO.FileStream
y pasando la matriz de bytes, la posición inicial y la longitud de secuencia para que se lea. - Rellene el objeto
BLOB
asignando su propiedadMTOM
al contenido de la matriz de bytes.
- Crear un objeto
-
Establecer opciones en tiempo de ejecución.
- Cree un objeto
AssemblerOptionSpec
que almacene opciones en tiempo de ejecución mediante su constructor. - Establezca las opciones en tiempo de ejecución para satisfacer sus necesidades comerciales asignando un valor a un miembro de datos que pertenezca al objeto
AssemblerOptionSpec
. Por ejemplo, para indicar al servicio Assembler que continúe procesando un trabajo cuando se produzca un error, asignefalse
al miembro de datosfailOnError
del objetoAssemblerOptionSpec
.
- Cree un objeto
-
Desmontar el documento del PDF.
Invoque el método
invokeDDX
del objetoAssemblerServiceClient
y pase los siguientes valores:- Un objeto
BLOB
que representa el documento DDX creado dinámicamente - Matriz
mapItem
que contiene el documento del PDF de entrada - Un objeto
AssemblerOptionSpec
que especifica opciones en tiempo de ejecución
El método
invokeDDX
devuelve un objetoAssemblerResult
que contiene los resultados del trabajo y las excepciones que se han producido. - Un objeto
-
Guarde los documentos del PDF desmontados.
Para obtener los documentos del PDF recién creados, realice las siguientes acciones:
- Obtenga acceso al campo
documents
del objetoAssemblerResult
, que es un objetoMap
que contiene los documentos de PDF desensamblados. - Recorra en iteración el objeto
Map
para obtener cada documento resultante. A continuación, convierta elvalue
de ese miembro de la matriz en unBLOB
. - Extraiga los datos binarios que representan el documento de PDF al tener acceso a la propiedad
MTOM
de su objetoBLOB
. Devuelve una matriz de bytes que puede escribir en un archivo PDF.
- Obtenga acceso al campo
Consulte también
Invocar AEM Forms mediante MTOM
Invocar AEM Forms mediante SwaRef