Set XDP result and source properties

Use Document Builder to apply properties to the XDP result and source documents. For example, these properties select the XDP documents to use and the order in which they are considered. Before you begin these instructions, open a DDX file that produces an XDP result.

  1. From the canvas panel, select the result XDP icon.

  2. In the XDP Result panel, supply values where needed. (See XDP result properties you can set from the Result tab.)

  3. Save your work and then click Validate to validate the DDX file. (See Validating the DDX Document.)

  4. Click Preview to view an example of the resultant document. (See Previewing the Result from a DDX Document.)

  5. From the canvas panel, select an XDP source icon.

  6. From the XDP Source panel, supply values where needed. (See XDP source properties you can set from the XDP Source panel.)

  7. Save your work and then click Validate to validate the DDX file.

  8. Click Preview to view an example of the resultant document.

XDP result properties you can set from the Result tab

Result:
Name of the resultant document. The name must be unique among all resultant documents in the DDX document.
If the XDP result is returned to the client, other operations in the process can use the specified name to reference the stream.

Return data to the client:
When this check box is selected, the result XDP document is returned to the client as a stream. Otherwise, the result XDP document is available as transient data, which can be referenced as source from within a subsequent XDP source icon.

Aggregate XDP Content:
Select All to add at the insertion point every level of data from the XDP content. (Order of insertion is inner-to-outer level.) Select None to add at the insertion point only the most inner level of data from the XDP Content. Use this property only if your source XDP documents contain forms designed to work with form fragments.

Retain Insertion Points:
Specify the insertion points to retain. Select All to retain all of the insertion points. Select None to remove all of the insertion points. To retain specifically named insertion points, select List and then provide the names of each insertion point to retain. Use this property only if your source XDP documents contain forms designed to work with form fragments.

Remove Insertion Points:
Specify the insertion points to remove. Select All to remove all of the insertion points. Select None to retain all of the insertion points. To remove specifically named insertion points, select List and then provide the names of each inserting point to retain. Use this property only if your source XDP documents contain forms designed to work with form fragments.

XDP source properties you can set from the XDP Source panel

Source:
Name of a single input data stream, an ordered list of data streams, or an external data URL. Each stream or URL must resolve to a document. If the document is not XDP, the Assembler service tries to convert the document to XDP.

This source is required:
Select this check box to terminate XDP assembly if this source does not specify a valid XDP document.

This is the Base Document:
Select this check box if the XDP source is the base document. The base document provides the initial structure that the Assembler service uses to set certain document-level properties of the result XDP document. These document-level properties include form data, document-level JavaScript code, and viewer preferences. The resultant document can contain only one source identified as a base document. Documents other than the base document contribute pages, document components (such as bookmarks, links, file attachments), page labels, page content, and page properties to the resultant document.

Doc match regex:
Selects source names and their associated data streams from the inputs map. Depending on the Match Mode: property, the matched documents are either included or excluded in the assembled document. If more than one name matches, the names are sorted, as specified in the Sort Locale: and Sort Order: properties. The Assembler service supports the Java regular expressions. (See the Java tutorial Lesson: Regular Expressions.)
Instead of specifying this parameter, you can specify the Source: parameter. If you also specify the Source: parameter, the document is included only if it matches the regular expression regarding the match mode sense.

Sort Locale:
Locale to use for sorting the names matched by the Match Mode: property. The value of this attribute must be a valid two-character ISO language code (see ISO 639). If you omit this parameter, the Assembler service determines the locale from the DDX TargetLocale element. Document Builder does not provide an interface for setting the TargetLocale element. However, you can use the Source mode to specify this element by directly editing the DDX document. (See Editing the XML for the DDX Document.)

Sort Order:
If the regular expression specified in the Doc match reg expression: parameter matches multiple documents, this attribute specifies the order in which those documents are sorted. This attribute is not used if the source attribute is specified and it matches an entry in the inputs map. Select Ascending to sort the matched documents in ascending order: A-Z. Select Descending to sort the matched documents in descending order: Z-A.

Match Mode:
Specifies whether the match results are included or excluded from the document assembly. Select Include to include the matched data streams. Select Exclude to exclude the matched data streams. This parameter applies only when you also provide the Doc match reg expression: parameter.

Include subfolders:
If true, all files in the folder and subfolders are included. This results in a list of documents for the PDF source element that maintains the original folder structure. If false, only the files in the specified folder are included. This parameter is used when the Doc match reg expression: parameter specifies subfolders.

Include all docs:
Select this field to include files in the folder and subfolders. This results in a list of documents for the PDF source element that maintains the original folder structure. Deselect this field to include only the files in the specified folder. This parameter is used when the Doc match reg expression: parameter specifies folders.

Just include these docs:
Range of documents to include from the ordered list specified in the Source: parameter or obtained by applying the Doc match reg expression: property. Leave this field blank if all documents are included. Here are examples of document ranges:

  • 1,3,5 Includes the first, third, and fifth documents from the ordered list of documents.

  • 1-5,8-10 Includes the first through fifth and eighth through tenth documents from the ordered list of documents.

  • 8-last Includes the eighth through last documents from the ordered list of documents.

This parameter is used when the Doc match reg expression: parameter specifies folders and subfolders. See “Page and document ranges” in the Assembler Service and DDX Reference.

This parameter corresponds to the DDX property identified as the XDP source element’s select attribute.

Fragment:
The name of the subform in the XDP source to include in the XDP result. Omit this property if the entire XDP source document is used in the XDP result. This property is invalid when it appears in base XDP sources.

Retain Insertion Points:
Specify the insertion points to retain. Select All to retain all of the insertion points. Select None to remove all of the insertion points. To retain specific named insertion points, select List and then provide the names of each insertion point to retain. Use this property only if your source XDP documents contain forms designed to work with form fragments.

Remove Insertion Points:
Specify the insertion points to remove. Select All to remove all of the insertion points. Select None to retain all of the insertion points. To remove specific named insertion points, select List and then provide the names of each inserting point to retain. Use this property only if your source XDP documents contain forms designed to work with form fragments.

For more information, see Assembler Service and DDX Reference.