Compilación de Documentos PDF con marcadores

Puede montar un documento PDF que contenga marcadores. Por ejemplo, supongamos que tiene un documento PDF que no contiene marcadores y que desea modificarlo proporcionando marcadores. Con el servicio Compilador, puede pasarle un documento PDF que no contenga marcadores y recuperar un documento PDF que contenga marcadores.

Los marcadores contienen las siguientes propiedades:

  • Título que aparece como texto en la pantalla.
  • Acción que especifica lo que sucede cuando un usuario hace clic en el marcador. La acción típica de un marcador es moverse a otra ubicación en el documento actual o abrir otro documento PDF, aunque se pueden especificar otras acciones.

A los efectos de este análisis, supongamos que se utiliza el siguiente documento DDX.

 <?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>

Dentro de este documento DDX, observe que al atributo de origen se le asigna el valor Loan.pdf. Este documento DDX especifica que se pasa un solo documento PDF al servicio de ensamblador. Al montar un documento PDF con marcadores, debe especificar un documento XML de marcadores que describa los marcadores en el documento de resultados. Para especificar un documento XML de marcador, asegúrese de que el elemento Bookmarks está especificado en el documento DDX.

En este documento DDX de ejemplo, el elemento Bookmarks especifica doc2 como valor. Este valor indica que el mapa de entrada pasado al servicio Ensamblador contiene una clave denominada doc2. El valor de la clave doc2 es un valor com.adobe.idp.Document que representa el documento XML del marcador. (Consulte "Lenguaje de marcadores" en Servicio de ensamblador y Referencia DDX.)

En este tema se utiliza el siguiente lenguaje de marcadores XML para crear un documento PDF que contenga 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>

Dentro de este documento XML de marcador, observe el elemento Acción que define la acción que se realiza cuando un usuario hace clic en el marcador. En el elemento Acción está el elemento Iniciar que inicia aplicaciones, como NotePad y abre archivos, como archivos PDF. Para abrir un archivo PDF, debe utilizar el elemento Archivo que especifica el archivo que se va a abrir. Por ejemplo, en el archivo XML de marcador especificado en esta sección, el nombre del archivo que se abre es LoanDetails.pdf.

NOTA

Para obtener más información sobre las acciones admitidas, consulte " Action elemento" en Servicio de ensamblador y Referencia DDX.

Dado el documento DDX especificado en esta sección y el archivo XML de marcador como entrada, el servicio Ensamblador ensambla un documento PDF que contiene los siguientes marcadores.

aw_aw_bmark

Cuando un usuario hace clic en el marcador Abrir los detalles del préstamo, se abre LoanDetails.pdf. Del mismo modo, cuando el usuario hace clic en el marcador Iniciar NotePad, se inicia NotePad.

NOTA

Antes de leer esta sección, se recomienda familiarizarse con el ensamblado de documentos PDF mediante el servicio Ensamblador. En esta sección no se analizan los conceptos, como la creación de un objeto de colección que contiene documentos de entrada o el aprendizaje de cómo extraer los resultados del objeto de colección devuelto. (Consulte Compilación programada de Documentos PDF).

NOTA

Para obtener más información sobre el servicio de ensamblador, consulte Referencia de servicios para AEM Forms.

NOTA

Para obtener más información sobre un documento DDX, consulte Servicio de ensamblador y Referencia DDX.

Resumen de los pasos

Para montar un documento PDF que contenga marcadores, realice las siguientes tareas:

  1. Incluir archivos de proyecto.
  2. Cree un cliente de ensamblador de PDF.
  3. Haga referencia a un documento DDX existente.
  4. Haga referencia a un documento PDF al que se han agregado marcadores.
  5. Haga referencia al documento XML del marcador.
  6. Añada el documento PDF y el documento XML de marcador en una colección Map.
  7. Configure las opciones de tiempo de ejecución.
  8. Monte el documento PDF.
  9. Guarde el documento PDF que contiene marcadores.

Incluir archivos de proyecto

Incluya los archivos necesarios en el proyecto de desarrollo. Si va a crear una aplicación cliente mediante Java, incluya los archivos JAR necesarios. Si utiliza servicios Web, asegúrese de incluir los archivos proxy.

Se deben agregar los siguientes archivos JAR a la ruta de clases del proyecto:

  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-assembler-client.jar
  • adobe-utilities.jar (requerido si AEM Forms se implementa en JBoss)
  • jbossall-client.jar (requerido si AEM Forms se implementa en JBoss)

si AEM Forms se implementa en un servidor de aplicaciones J2EE compatible que no sea JBoss, debe reemplazar los archivos adobe-utilities.jar y jbossall-client.jar por archivos JAR específicos del servidor de aplicaciones J2EE en el que se implementa AEM Forms. Para obtener información sobre la ubicación de todos los archivos JAR de AEM Forms, consulte Inclusión de archivos de biblioteca Java de AEM Forms.

Crear un cliente de ensamblador de PDF

Antes de realizar una operación de ensamblador mediante programación, debe crear un cliente de servicio de ensamblador.

Hacer referencia a un documento DDX existente

Se debe hacer referencia a un documento DDX para montar un documento PDF. Este documento DDX debe contener el elemento Bookmarks, que indica al servicio Ensamblador que cree un PDF que contenga marcadores. (Consulte el documento DDX que se muestra anteriormente en esta sección para ver un ejemplo).

Hacer referencia a un documento PDF al que se han agregado marcadores

Haga referencia a un documento PDF al que se han agregado marcadores. No importa si el documento PDF al que se hace referencia ya contiene marcadores. Si el elemento Bookmarks es un elemento secundario del elemento de origen PDF, los marcadores reemplazarán a los que ya existen en el origen PDF. Sin embargo, si desea mantener los marcadores existentes, asegúrese de que Bookmarks sea un elemento secundario del elemento de origen PDF. Por ejemplo, consideremos el siguiente ejemplo:

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

Hacer referencia al documento XML del marcador

Para compilar un PDF que contenga nuevos marcadores, debe hacer referencia a un documento XML de marcador. El documento XML de marcador se pasa al servicio Ensamblador dentro del objeto de colección Map. (Consulte el documento XML de marcador que se muestra anteriormente en esta sección para ver un ejemplo).

NOTA

Consulte "Lenguaje de marcadores" en Servicio de ensamblador y Referencia DDX.

Añadir el documento PDF y el documento XML de marcador en una colección Map

Debe agregar el documento PDF al que se agregan los marcadores y el documento XML de marcador a la colección Map. Por lo tanto, el objeto de colección Map contiene dos elementos: un documento PDF y el documento de marcador XML.

Definición de opciones de tiempo de ejecución

Puede definir opciones en tiempo de ejecución que controlen el comportamiento del servicio de ensamblador mientras realiza un trabajo. Por ejemplo, puede definir una opción que indique al servicio Ensamblador que continúe procesando un trabajo si se produce un error. Para obtener información sobre las opciones de tiempo de ejecución que puede establecer, consulte la referencia de clase AssemblerOptionSpec en Referencia de API de AEM Forms.

Compilación del documento PDF

Para montar un documento PDF que contenga nuevos marcadores, utilice la operación invokeDDX del servicio Ensamblador. El motivo por el que debe utilizar la operación invokeDDX en lugar de otras operaciones de servicio de Ensamblador como invokeOneDocument es porque el servicio Ensamblador requiere un documento XML de marcador que se pasa dentro del objeto de recopilación Map. Este objeto es un parámetro de la operación invokeDDX.

Guardar el documento PDF que contiene marcadores

Debe extraer los resultados del objeto de mapa devuelto y guardar el documento PDF correspondiente. (Consulte "Extraer los resultados" en Compilación programada de Documentos PDF).

Consulte también

Inclusión de archivos de biblioteca Java de AEM Forms

Configuración de las propiedades de conexión

Compilación programada de Documentos PDF

Compilación de documentos PDF con marcadores mediante la API de Java

Monte un documento PDF con marcadores mediante la API de servicio de ensamblador (Java):

  1. Incluir archivos de proyecto.

    Incluya archivos JAR de cliente, como adobe-assembler-client.jar, en la ruta de clases del proyecto Java.

  2. Cree un cliente de ensamblador de PDF.

    • Cree un objeto ServiceClientFactory que contenga propiedades de conexión. (Consulte Configuración de propiedades de conexión.)
    • Cree un objeto AssemblerServiceClient utilizando su constructor y pasando el objeto ServiceClientFactory.
  3. Haga referencia a un documento DDX existente.

    • Cree un objeto java.io.FileInputStream que represente el documento DDX utilizando su constructor y pasando un valor de cadena que especifique la ubicación del archivo DDX.
    • Cree un objeto com.adobe.idp.Document utilizando su constructor y pasando el objeto java.io.FileInputStream.
  4. Haga referencia a un documento PDF al que se han agregado marcadores.

    • Cree un objeto java.io.FileInputStream utilizando su constructor y pasando la ubicación del documento PDF.
    • Cree un objeto com.adobe.idp.Document utilizando su constructor y pase el objeto java.io.FileInputStream que contiene el documento PDF.
  5. Haga referencia al documento XML del marcador.

    • Cree un objeto java.io.FileInputStream utilizando su constructor y pasando la ubicación del archivo XML que representa el documento XML de marcador.
    • Cree un objeto com.adobe.idp.Document y pase el objeto java.io.FileInputStream que contiene el documento PDF.
  6. Añada el documento PDF y el documento XML de marcador en una colección Map.

    • Cree un objeto java.util.Map que se utilice para almacenar el documento PDF de entrada y el documento XML de marcador.

    • Añada el documento PDF de entrada invocando el método java.util.Map del objeto put y pasando los siguientes argumentos:

      • Un valor de cadena que representa el nombre de la clave. Este valor debe coincidir con el valor del elemento de origen PDF especificado en el documento DDX.
      • Un objeto com.adobe.idp.Document que contiene el documento PDF de entrada.
    • Añada el documento XML de marcador invocando el método java.util.Map del objeto put y pasando los siguientes argumentos:

      • Un valor de cadena que representa el nombre de la clave. Este valor debe coincidir con el valor del elemento de origen Marcadores especificado en el documento DDX.
      • Un objeto com.adobe.idp.Document que contiene el documento XML de marcador.
  7. Configure las opciones de tiempo de ejecución.

    • Cree un objeto AssemblerOptionSpec que almacene las opciones de tiempo de ejecución mediante su constructor.
    • Configure las opciones de tiempo de ejecución para satisfacer los requisitos comerciales invocando un método que pertenece al objeto AssemblerOptionSpec. Por ejemplo, para indicar al servicio Ensamblador que continúe procesando un trabajo cuando se produzca un error, invoque el método AssemblerOptionSpec del objeto setFailOnError y pase false.
  8. Monte el documento PDF.

    Invoque el método AssemblerServiceClient del objeto invokeDDX y pase los siguientes valores obligatorios:

    • Un objeto com.adobe.idp.Document que representa el documento DDX que se va a utilizar
    • Un objeto java.util.Map que contiene el documento PDF de entrada y el documento XML de marcador.
    • Un objeto com.adobe.livecycle.assembler.client.AssemblerOptionSpec que especifica las opciones en tiempo de ejecución, incluido el nivel predeterminado de fuente y registro de trabajos

    El método invokeDDX devuelve un objeto com.adobe.livecycle.assembler.client.AssemblerResult que contiene los resultados del trabajo y las excepciones que se hayan producido.

  9. Guarde el documento PDF que contiene marcadores.

    Para obtener el documento PDF recién creado, realice las siguientes acciones:

    • Invocar el método AssemblerResult del objeto getDocuments. Esto devuelve un objeto java.util.Map.
    • Repita el objeto java.util.Map hasta que encuentre el objeto com.adobe.idp.Document resultante. (Puede utilizar el elemento de resultado PDF especificado en el documento DDX para obtener el documento).
    • Invoque el método com.adobe.idp.Document del objeto copyToFile para extraer el documento PDF.

Consulte también

Inicio rápido (modo SOAP): Compilación de documentos PDF con marcadores mediante la API de Java

Inclusión de archivos de biblioteca Java de AEM Forms

Configuración de las propiedades de conexión

Compilación de documentos PDF con marcadores mediante la API de servicio Web

Monte un documento PDF con marcadores mediante la API de servicio de ensamblador (servicio Web):

  1. Incluir archivos de proyecto.

    Cree un proyecto de Microsoft .NET que utilice MTOM. Asegúrese de utilizar la siguiente definición WSDL: http://localhost:8080/soap/services/AssemblerService?WSDL&lc_version=9.0.1.

    NOTA

    Reemplace localhost por la dirección IP del servidor que aloja AEM Forms.

  2. Cree un cliente de ensamblador de PDF.

    • Cree un objeto AssemblerServiceClient utilizando su constructor predeterminado.

    • Cree un objeto AssemblerServiceClient.Endpoint.Address mediante el constructor System.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 es necesario usar el atributo lc_version. Este atributo se utiliza al crear una referencia de servicio.

    • Cree un objeto System.ServiceModel.BasicHttpBinding obteniendo el valor del campo AssemblerServiceClient.Endpoint.Binding. Convierta el valor devuelto a BasicHttpBinding.

    • Establezca el campo System.ServiceModel.BasicHttpBinding del objeto MessageEncoding en WSMessageEncoding.Mtom. Este valor garantiza que se utilice MTOM.

    • Habilite la autenticación HTTP básica realizando las siguientes tareas:

      • Asigne el nombre de usuario de los formularios AEM 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 campo BasicHttpBindingSecurity.Transport.ClientCredentialType.
      • Asigne el valor constante BasicHttpSecurityMode.TransportCredentialOnly al campo BasicHttpBindingSecurity.Security.Mode.
  3. Haga referencia a un documento DDX existente.

    • Cree un objeto BLOB utilizando su constructor. El objeto BLOB se utiliza para almacenar el documento DDX.
    • Cree un objeto System.IO.FileStream invocando su constructor y pasando un valor de cadena que represente la ubicación del archivo del documento DDX y el modo en que se abre 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 propiedad System.IO.FileStream del objeto Length.
    • Rellene la matriz de bytes con datos de flujo invocando el método System.IO.FileStream del objeto Read y pasando la matriz de bytes, la posición inicial y la longitud de flujo que se va a leer.
    • Rellene el objeto BLOB asignando su campo MTOM con el contenido de la matriz de bytes.
  4. Haga referencia a un documento PDF al que se han agregado marcadores.

    • Cree un objeto BLOB utilizando su constructor. El objeto BLOB se utiliza para almacenar el PDF de entrada.
    • Cree un objeto System.IO.FileStream invocando su constructor y pasando un valor de cadena que represente la ubicación del archivo del documento PDF de entrada y el modo en que se abre 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 propiedad System.IO.FileStream del objeto Length.
    • Rellene la matriz de bytes con datos de flujo invocando el método System.IO.FileStream del objeto Read y pasando la matriz de bytes, la posición inicial y la longitud de flujo que se va a leer.
    • Rellene el objeto BLOB asignando su campo MTOM con el contenido de la matriz de bytes.
  5. Haga referencia al documento XML del marcador.

    • Cree un objeto BLOB utilizando su constructor. El objeto BLOB se utiliza para almacenar el documento XML del marcador.
    • Cree un objeto System.IO.FileStream invocando su constructor y pasando un valor de cadena que represente la ubicación del archivo del documento PDF de entrada y el modo en que se abre 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 propiedad System.IO.FileStream del objeto Length.
    • Rellene la matriz de bytes con datos de flujo invocando el método System.IO.FileStream del objeto Read y pasando la matriz de bytes, la posición inicial y la longitud de flujo que se va a leer.
    • Rellene el objeto BLOB asignando su campo MTOM con el contenido de la matriz de bytes.
  6. Añada el documento PDF y el documento XML de marcador en una colección Map.

    • Cree un objeto MyMapOf_xsd_string_To_xsd_anyType. Este objeto de colección se utiliza para almacenar los documentos PDF de entrada y el documento XML de marcador.
    • Para cada documento PDF de entrada y el documento XML de marcador, cree un objeto MyMapOf_xsd_string_To_xsd_anyType_Item.
    • Asigne un valor de cadena que represente el nombre clave al campo MyMapOf_xsd_string_To_xsd_anyType_Item del objeto key. Este valor debe coincidir con el valor del elemento de origen PDF especificado en el documento DDX.
    • Asigne el objeto BLOB que almacena el documento PDF al campo MyMapOf_xsd_string_To_xsd_anyType_Item del objeto value.
    • Añada el objeto MyMapOf_xsd_string_To_xsd_anyType_Item al objeto MyMapOf_xsd_string_To_xsd_anyType. Invoque el método MyMapOf_xsd_string_To_xsd_anyType del objeto Add y pase el objeto MyMapOf_xsd_string_To_xsd_anyType. (Realice esta tarea para cada documento PDF de entrada y el documento XML de marcador).
  7. Configure las opciones de tiempo de ejecución.

    • Cree un objeto AssemblerOptionSpec que almacene las opciones de tiempo de ejecución mediante su constructor.
    • Configure las opciones de tiempo de ejecución para satisfacer los requisitos comerciales asignando un valor a un miembro de datos que pertenece al objeto AssemblerOptionSpec. Por ejemplo, para indicar al servicio Ensamblador que continúe procesando un trabajo cuando se produzca un error, asigne false al miembro de datos AssemblerOptionSpec del objeto failOnError.
  8. Monte el documento PDF.

    Invoque el método AssemblerServiceClient del objeto invokeDDX y pase los siguientes valores:

    • Un objeto BLOB que representa el documento DDX
    • La matriz MyMapOf_xsd_string_To_xsd_anyType que contiene los documentos de entrada
    • Un objeto AssemblerOptionSpec que especifica opciones de tiempo de ejecución

    El método invokeDDX devuelve un objeto AssemblerResult que contiene los resultados del trabajo y las excepciones que puedan haberse producido.

  9. Guarde el documento PDF que contiene marcadores.

    Para obtener el documento PDF recién creado, realice las siguientes acciones:

    • Acceda al campo AssemblerResult del objeto documents, que es un objeto Map que contiene los documentos PDF resultantes.
    • Repita el objeto Map hasta que encuentre la clave que coincida con el nombre del documento resultante. A continuación, convierta el value miembro del arreglo de discos en un BLOB.
    • Extraiga los datos binarios que representan el documento PDF accediendo al campo BLOB del objeto MTOM. Esto devuelve una matriz de bytes que puede escribir en un archivo PDF.

Consulte también

Invocación de AEM Forms mediante MTOM

En esta página