For guidance on the Application Document Wizard in previous releases, see:
- DCO 6.2 and 6.3 - Using the Application Document Wizard
- DCO 6.1 - Using the Application Document Wizard
This article describes how to use fields in Step 1 of the wizard when an Application Document template is selected. By completing the fields in Step 1 of the Application Document Wizard, you can control which application details are included in your generated document.
Before you attempt to follow the guidance in this article, you need to set up your system to create documents. Follow the Getting Started instructions outlined in Using the Application Document Wizard.
For guidance on completing other steps in the Application Document Wizard, refer to the Related content section of this article.
Use the fields in the Options section to define the basic structure and presentation of your document.
- Select a document type from the Detail level list that best matches the purpose of your Application Document:
- High Level Overview – Presents a business summary of case types, flows, specifications, and requirements.
- Full Application Documentation – Adds to the High Level Overview content by including additional chapters with detailed rule information.
- Property References – Limits output to only property rules referenced by case types and Entity Relationship Diagrams.
- Refine the document presentation based on your target audience:
- Select a style from the Section headings will display list. A Short Description is purpose-driven, while a Rule Name is implementation-specific.
- Check the Suppress class and ruleset references box to hide technical details about rules. This keeps content focused for business users.
- Check the Create links to rule forms within document box to include icons that open rules directly in the application. This is a great way to engage developers and facilitate interactive reviews.
Chapter and section settings
Use thebuttons to build a set of chapters and sections. Each button launches a modal with a list of items you can include in the generated document. You can make changes by checking or clearing the check box next to each item.
- The default settings in each modal are determined by the option you select in the Detail level list.
- The list of items in the Case Types and Supporting Specification Types section is restricted by the selected ruleset names in the Rulesets section.
- When you check the Flows box, all flows referenced by a case type (excluding pyStartCase) are added to the document.
- Specifications attachments are automatically included in the document when you check the Specifications box and each attachment uses the Include in doc? option.
Previewing your document
Refresh the Document Table of Contents section to preview your table of contents. You can try out different combinations of options to see how they impact the document structure without generating a physical Word document.
This section is read-only and must be manually refreshed. Click the expand icon next to a chapter to see the contained sections.
Once you verify all of your selected options, click Step 2 in the wizard.to move on to