☑️ Prerequisite Skills: Creating a Document Export Query in Configurable Joins

Third-party systems sometimes require document metadata to be included on the document itself, as opposed to being in an associated index file.

To satisfy this requirement, we can add required information to the pdf:xml export in the Document Export query.

In this article, we’ll use the Configurable Joins - Document query base and a subquery export to create the pdf:xml export.

Step 1: Building the standard parts of the pdf:xml subquery export

Start by recreating the standard portions of the pdf:xml export.

1. In the Exports section, next to the Export button, select the subquery button. An Edit Part popup appears.

   
   

2. Set the following configurations:

   • Name: pdf:xml

   • Output: XML

   • Node: batch

3. In the Exports area, click the Export button. An Insert Query Part popup appears.
   
   

4. In the Direct Exports section, under the Document category, select Record GUID.

5. Click Continue. The export now appears on the Edit Part popup.
   
   

6. Hover over the Document Record GUID export and select the Edit (pencil) icon. An Edit Part popup appears.
   
   

7. Change the Name value to @id and click Save. The export is renamed on the Edit Part popup.
   
   

8. In the Exports area, to the right of the Export and subquery export buttons, click the Literal button. An Edit Part popup appears.
   
   

9. Set the following values:

   • Name: @mode

   • Literal: stream
     
     

10. Click Save. The literal appears on the Edit Part popup.

11. In the Exports section, select Export button. An Insert Query Part popup appears.
    
    

12. In the Direct Exports section, under the Document category, select Scope.

13. Click Continue. The export now appears on the Edit Part popup.
    
    

14. Hover over the Document Record Scope export and select Edit. An Edit Part popup appears.
    
    

15. Change the Name value to @scope and click Save. The renamed export appears on the Edit Part popup.
    
    

16. In the Exports section, click the Export button. An Insert Query Part popup appears.
    
    

17. In the Direct Exports section, under the Document category, select XML.

18. Click Continue. The export now appears on the Edit Part popup.
    
    

19. Hover over the Document XML export and select edit. An Edit Part popup appears.
    
    

20. Change the Name value to node() and click Save. The renamed export appears on the Edit Part popup.
    
    

21. Click Save to complete and save the query.
    

Step 2: Adding an @header attribute with desired metadata

Before adding the @header attribute to your pdf:xml export, consider which data need to be included, and ensure that the joins to access these data are configured appropriately. See Configurable Joins - Joining documentation for more information.

Though we are adding an @header attribute to our pdf:xml export, this data appears only within the footer of the resulting document.

1. Open the pdf:xml Subquery Export created above.

2. Add a nested Subquery Export by selecting the Subquery icon next to the Export button:

1. Name: @header

2. Output: Concatenate

3. Add the desired data with literal separators as needed for readability.

   

4. Save the @header nested subquery export.

   

5. Reorder the exports within the pdf:xml subquery export so that the node() export is at the bottom.

6. Save the pdf:xml subquery export.