Validación de Documentos DDX

Puede validar mediante programación un documento DDX que utilice el servicio Ensamblador. Es decir, con la API de servicio de ensamblador, puede determinar si un documento DDX es válido o no. Por ejemplo, si ha actualizado una versión anterior de AEM Forms y desea asegurarse de que el documento DDX es válido, puede validarlo con la API de servicio de ensamblador.

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 validar un documento DDX, realice las siguientes tareas:

  1. Incluir archivos de proyecto.
  2. Cree un cliente de ensamblador.
  3. Haga referencia a un documento DDX existente.
  4. Configure las opciones de tiempo de ejecución para validar el documento DDX.
  5. Realice la validación.
  6. Guarde los resultados de validación en un archivo de registro.

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.

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

Para validar un documento DDX, debe hacer referencia a un documento DDX existente.

Configure las opciones de tiempo de ejecución para validar el documento DDX

Al validar un documento DDX, debe definir opciones específicas de tiempo de ejecución que indiquen al servicio de ensamblador que valide el documento DDX en lugar de ejecutarlo. Además, puede aumentar la cantidad de información que el servicio del ensamblador escribe en el archivo de registro.

Realizar la validación

Después de crear el cliente de servicio de ensamblador, hacer referencia al documento DDX y definir las opciones de tiempo de ejecución, puede invocar la operación invokeDDX para validar el documento DDX. Al validar el documento DDX, puede pasar null como parámetro de mapa (este parámetro generalmente almacena documentos PDF que el ensamblador necesita para realizar las operaciones especificadas en el documento DDX).

Si falla la validación, se genera una excepción y el archivo de registro contiene detalles que explican por qué el documento DDX no es válido. Se puede obtener de la instancia OperationException. Una vez pasado el análisis XML básico y la comprobación de esquemas, se realiza la validación con respecto a la especificación DDX. Todos los errores que se encuentran en el documento DDX se especifican en el registro.

Guardar los resultados de validación en un archivo de registro

El servicio Ensamblador devuelve los resultados de validación que puede escribir en un archivo de registro XML. La cantidad de detalles que el servicio del ensamblador escribe en el archivo de registro depende de la opción de tiempo de ejecución que configure.

Consulte también

Validación de un documento DDX mediante la API de Java

Validación de un documento DDX mediante la API de servicio web

Inclusión de archivos de biblioteca Java de AEM Forms

Configuración de las propiedades de conexión

Compilación programada de Documentos PDF

Validar un documento DDX con la API de Java

Valide un documento DDX 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.
    • 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. Configure las opciones de tiempo de ejecución para validar el documento DDX.

    • Cree un objeto AssemblerOptionSpec que almacene las opciones de tiempo de ejecución mediante su constructor.
    • Establezca la opción de tiempo de ejecución que indica al servicio Ensamblador que valide el documento DDX invocando el método setValidateOnly del objeto AssemblerOptionSpec y pasando true.
    • Configure la cantidad de información que el servicio Ensamblador escribe en el archivo de registro invocando el método AssemblerOptionSpec del objeto getLogLevel y pasando un valor de cadena que cumpla sus requisitos. Al validar un documento DDX, desea que se escriba más información en el archivo de registro que le ayudará en el proceso de validación. Como resultado, puede pasar el valor FINE o FINER.
  5. Realice la validación.

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

    • Un objeto com.adobe.idp.Document que representa el documento DDX.
    • El valor null del objeto java.io.Map que generalmente almacena documentos PDF.
    • Un objeto com.adobe.livecycle.assembler.client.AssemblerOptionSpec que especifica las opciones de tiempo de ejecución.

    El método invokeDDX devuelve un objeto AssemblerResult que contiene información que especifica si el documento DDX es válido.

  6. Guarde los resultados de validación en un archivo de registro.

    • Cree un objeto java.io.File y asegúrese de que la extensión del nombre de archivo sea .xml.
    • Invocar el método AssemblerResult del objeto getJobLog. Este método devuelve una instancia com.adobe.idp.Document que contiene información de validación.
    • Invoque el método com.adobe.idp.Document del objeto copyToFile para copiar el contenido del objeto com.adobe.idp.Document en el archivo.
    NOTA

    Si el documento DDX no es válido, se genera un OperationException. Dentro de la sentencia catch, puede invocar el método OperationException del objeto getJobLog.

Consulte también

Validación de Documentos DDX

Inicio rápido (modo SOAP): Validación de documentos DDX mediante la API Java (modo SOAP)

Inclusión de archivos de biblioteca Java de AEM Forms

Configuración de las propiedades de conexión

Validar un documento DDX mediante la API de servicio Web

Valide un documento DDX 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

    Reemplazar localhost con la dirección IP del servidor de formularios.

  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 el 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 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 propiedad MTOM con el contenido de la matriz de bytes.
  4. Configure las opciones de tiempo de ejecución para validar el documento DDX.

    • Cree un objeto AssemblerOptionSpec que almacene las opciones de tiempo de ejecución mediante su constructor.
    • Establezca la opción de tiempo de ejecución que indica al servicio Ensamblador que valide el documento DDX asignando el valor true al miembro de datos AssemblerOptionSpec del objeto validateOnly.
    • Configure la cantidad de información que el servicio Ensamblador escribe en el archivo de registro asignando un valor de cadena al miembro de datos AssemblerOptionSpec del objeto logLevel. al validar un documento DDX, desea que se escriba más información en el archivo de registro que le ayudará en el proceso de validación. Como resultado, puede especificar el valor FINE o FINER. 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.
  5. Realice la validación.

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

    • Un objeto BLOB que representa el documento DDX.
    • El valor null del objeto Map que generalmente almacena documentos PDF.
    • Un objeto AssemblerOptionSpec que especifica opciones de tiempo de ejecución.

    El método invokeDDX devuelve un objeto AssemblerResult que contiene información que especifica si el documento DDX es válido.

  6. Guarde los resultados de validación en un archivo de registro.

    • Cree un objeto System.IO.FileStream invocando su constructor y pasando un valor de cadena que represente la ubicación del archivo de registro y el modo en el que se abrirá el archivo. Asegúrese de que la extensión del nombre de archivo sea .xml.
    • Cree un objeto BLOB que almacene información de registro obteniendo el valor del miembro de datos AssemblerResult del objeto jobLog.
    • Cree una matriz de bytes que almacene el contenido del objeto BLOB. Rellene la matriz de bytes obteniendo el valor del campo BLOB del objeto MTOM.
    • Cree un objeto System.IO.BinaryWriter invocando su constructor y pasando el objeto System.IO.FileStream.
    • Escriba el contenido de la matriz de bytes en un archivo PDF invocando el método System.IO.BinaryWriter del objeto Write y pasando la matriz de bytes.
    NOTA

    Si el documento DDX no es válido, se genera un OperationException. Dentro de la sentencia catch, puede obtener el valor del miembro OperationException del objeto jobLog.

Consulte también

Validación de Documentos DDX

Invocación de AEM Forms mediante MTOM

En esta página