C:\DITA\WKFS_oXygen_Files\fragments\webhelp.fragment.head.xml
Jump to main content C:\DITA\WKFS_oXygen_Files\fragments\webhelp.fragment.before.body.xml

# Creating a Document List

A former application, Doc Prep, had a functionality where a call could be made to get a doc list, and then that doc list could be populated into the body of a document. This functionality has been expanded to Expere. This solution provides a way to get a list of documents that apply to the transaction and then populate that list back to a document, such as a Closing Agenda or Welcome Letter.

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

Data Management has been updated to include the correct data points for TXN content (MISMO is not supported at this time)

- ExpereTxn.xsd has been updated to include 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 was added there to be able to author PTRs against it.
Document Properties within Requirements Editor includes a Document List drop list to indicate the REQ is a Document List document as well as allow you to select one of the following options:

- (Empty): Indicates that this is not a document list document (same as if the checkbox is unchecked currently)
- 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 checked currently)

When Expere identifies a REQ file that is 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 is not be restricted to a particular document or location (Dynamic Only)
   Note:
   - Do not use Document List when authoring Static documents. It’s available today as an option, but it is not supported and will be removed in the future.
   - You are able to author the Document List on a Dynamic document.
   - 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

## 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:
C:\DITA\WKFS_oXygen_Files\fragments\webhelp.fragment.after.body.xml