Validating DDX Documents

You can programmatically validate a DDX document that is used by the Assembler service. That is, using the Assembler service API, you can determine whether or not a DDX document is valid. For example, if you upgraded from a previous LiveCycle version and you want to ensure that your DDX document is valid, you can validate it using the Assembler service API.

Note: For more information about the Assembler service, see LiveCycle ES Services.

Note: For more information about a DDX document, see DDX Reference.

Summary of steps

To validate a DDX document, perform the following tasks:

1.	Include project files.

2.	Create an Assembler client.

3.	Reference an existing DDX document.

4.	Set run-time options to validate the DDX document.

5.	Perform the validation.

6.	Save the validation results in a log file.

Include project files

Include the necessary files in your development project. If you are creating a client application by using Java, include the necessary JAR files. If you are using web services, ensure that you include the proxy files.

The following JAR files must be added to your project’s class path:

•	adobe-livecycle-client.jar

•	adobe-usermanager-client.jar

•	adobe-assembler-client.jar

•	adobe-utilities.jar (required if LiveCycle ES is deployed on JBoss)

•	jbossall-client.jar (required if LiveCycle ES is deployed on JBoss)

If LiveCycle ES is deployed on a supported J2EE application server other than JBoss, you must replace the adobe-utilities.jar and jbossall-client.jar files with JAR files that are specific to the J2EE application server that LiveCycle ES is deployed on. For information about the location of all LiveCycle ES JAR files, see Including LiveCycle ES Java library files.

Create a PDF Assembler client

Before you can programmatically perform an Assembler operation, you must create an Assembler service client.

Reference an existing DDX document

To validate a DDX document, you must reference an existing DDX document.

Set run-time options to validate the DDX document

When validating a DDX document, you must set specific run-time options that instruct the Assembler service to validate the DDX document as opposed to executing it. Also, you can increase the amount of information that the Assembler service writes to the log file. For information about the run-time options that you can set, see the AssemblerOptionSpec class reference in LiveCycle ES API References.

Perform the validation

After you create the Assembler service client, reference the DDX document, and set run-time options, you can invoke the invokeDDX operation to validate the DDX document. When validating the DDX document, you can pass null as the map parameter (this parameter usually stores PDF documents that the Assembler requires to perform the operation(s) specified in the DDX document).

If validation fails, an exception is thrown and the log file that contains details that explains why the DDX document is invalid can be obtained from the OperationException instance. Once past the basic XML parsing and schema checking, then the validation against the DDX specification is performed. All errors that are located in the DDX document are specified in the log.

Save the validation results in a log file

The Assembler service returns the validation results that you can write to a XML log file. The amount of detail that the Assembler service writes to the log file depends on the run-time option that you set.


View Java walkthrough	View web service walkthrough

Current page: http://livedocs.adobe.com/livecycle/8.2/programLC/programmer/help/000611_3.html