Document List and Partial Document List functionality

Document List

When a package is created, Expere creates a list of documents included in that package, the names of which are derived from the InstanceDisplayName within the document .REQ file. The REQ file properties file specifies that a full document list should be created within the document that is selected, such as the Closing Instructions (ClosingInstructions.req).

When producing a full document list, the PKGD will contain a documentList element with the value "True" (the same as today if it's checked), if its not selected the documentList element will not appear.

Note: A generated set of documents, can have at most one document which contains the <DocumentList> descriptor

Partial Document List

Note: Only Dynamic and Embedded PDF documents can comprise a Partial Document List. Static Documents currently can not be part of the Partial Document List as "DocumentListDataItems" can not be authored in a Static Document

Partial Document List functionality allows a filtered list of generated documents to be included in another document. The REQ files need to include specific information for Expere to assemble the documents in an order in which Expere knows at least one document includes a partial document list and to be able to produce an accurate list.

Generating a partial document list within a document: for Expere to capture the list of documents and generate a partial document list, at least one document being generated must have Document List set to Partial in the in the REQ Document Properties. Programmatically, the <PartialDocumentList/> element is authored in a users' content library as part of a PKGD file

For the document to appear in the partial document list, the DocumentListDataItems / DocumentListDataItem / Name and Value elements are authored within the Instances / Instance element in each individual REQ. For example: the Name would be set to "DocumentType" and Value would be set to "SecurityDocument."

If the Name and Value elements are defined for a given document, Expere places the Name / Value pair(s) and InstanceDisplayName in the transaction schema:

<TXN>
    <Documents>
        <Document>
            <InstanceDisplayName>SecurityDocument1</InstanceDisplayName>
            <DocumentListDataItems>
                <DocumentListDataItem>
                    <Name>DocumentType</Name>
                    <Value>SecurityDocument</Value>
                </DocumentListDataItem>
            </DocumentListDataItems>
        </Document>
        <Document>
            <InstanceDisplayName>SecurityDocument2</InstanceDisplayName>
            <DocumentListDataItems>
                <DocumentListDataItem>
                    <Name>DocumentType</Name>
                    <Value>SecurityDocument</Value>
                </DocumentListDataItem>
            </DocumentListDataItems>
        </Document>
    </Documents>
</TXN>

Note: The Iterator's PTR includes logic for refining the partial document list based on the specified Name / Value pairs as noted in the TXN code sample.

Note: This PTR is used to print the values of the InstanceDisplayName. Other additional information can be utilized if desired.

Behind the scenes for partial document lists, the partialDocumentList element may be set to "True". For Hosted Expere users, refer to the Expere Document Services Web Services Guide: DocDescriptor. For on-prem, self-hosted users, refer to the Expere Developer Guide: DocDescriptor.