Document List

With Requirements Editor you can generate a list of relevant documents for a specific transaction. This list can then be automatically populated into a document, such as a Closing Agenda or Welcome Letter.

Expere understands the documents included in a request by looking at the response file, and populates that list to the content.

Data Management includes the correct data points for TXN content (MISMO isn't supported):
  • ExpereTxn.xsd includes the document list information:
    • /Txn/Packets/Packet/Documents/Document/DocumentName
    • /Txn/Packets/Packet/Documents/Document/InstanceDisplayName
Note: This isn’t something that would typically go in the Txn schema, but it's there to be able to author PTRs against it.
Document Properties includes a Document List drop list to indicate the REQ is a Document List document and also allows you to select one of the following options:
  • (Empty): Indicates that this isn't a document list document (same as if the checkbox is currently unchecked)
  • Partial: Indicates the document contains a partial list of documents in the package
  • Full: Indicates the document contains the full list of documents in the package (same as if the document list checkbox is currently checked)

When Expere identifies a REQ file that's a Document List document, it adds the document list information to the ExpereTxn transaction. This allows PTRs to be written against that information.

Supported functionality

  1. Ability to Author a Document List isn't restricted to a particular document or location (Dynamic Only)
    Note:
    • Don't use Document List when authoring Static documents. It’s available today as an option, but isn't supported and will be removed in the future.
    • You can author the Document List on Dynamic and PDF documents.
    • The dynamic document will present any Static or Dynamic document name in the list per the request.
  2. Single OR Double Column lists: supported but will need to be authored
  3. List format: Bullet, Numeric, or Simple List format
  4. Margin Requirements: follow the structure of REQ file
  5. Multi-Page Lists: lists that expand more than one page
  6. Page Break: needs to be authored if required
  7. Order of the List: matches the order in the Response
  8. Each document and instance is included in the generated list
  9. List Document Name options
    • PacketName if authored
    • DocumentName if authored
    • InstanceDisplayName if authored
  10. For PDF documents, DocumentListDataItems can be added as children of the Instance element. The following elements are supported.
    <DocumentListDataItems>
       <DocumentListDataItem>
          <Name>Name</Name>
          <Value>Value</Value>
       </DocumentListDataItem>
    </DocumentListDataItems>

Authoring examples

If iterating over /Txn/Packets/Packet: this allows you to print the PacketName with a DTA (PRINT ./PacketName)

If iterating over /Txn/Packets/Packet/Documents/Document: this allows you to print the DocumentName or InstanceDisplayName with a following DTA (PRINT ./InstanceDisplayName or PRINT ./DisplayName)
Note: When you create or update a document/REQ, you must go to Properties and select Document List in order for the document to present the information/list correctly.

Workflow

The workflow is as follows.

Authored REQ file > Engine identifies if a REQ file is a Document List document > Expere generates all documents except for the REQ that contains the Document List and updates the TXN with the schema and information (see below) > Expere then generates the REQ file that has the Document List flag with the correct information.

TXN Schema

/Txn/Packets/Packet/Documents/Document/DocumentName

/Txn/Packets/Packet/Documents/Document/InstanceDisplayName

TXN Example
<Txn>
    <Packets>
        <Packet>
            <PacketName>Packet1</PacketName>
            <Documents>
                <Document>
                    <DocumentName>My First Document Name</DocumentName>
                        <InstanceDisplayName>My First Document Instance Display Name</InstanceDisplayName>
                    </Document>
                <Document>
                    <DocumentName>My Second Document Name</DocumentName>
                    <InstanceDisplayName>My Second Document Instance Display Name</InstanceDisplayName>
                </Document>
            </Documents>
        </Packet>
        <Packet>
            <PacketName>Packet2</PacketName>
            <Documents>
                <Document>
                    <DocumentName>My Third Document Name</DocumentName>
                        <InstanceDisplayName>My Third Document Instance Display Name</InstanceDisplayName>
                </Document>
                <Document>
                    <DocumentName>My Forth Document Name</DocumentName>
                    <InstanceDisplayName>My Forth Document Instance Display Name</InstanceDisplayName>
                </Document>
            </Documents>
        </Packet>
    </Packets>
</Txn>
Authoring Example: