Back ForwardGenerating an Application Document — Step 1

This topic guides you through the Select step of the Application Document Wizard for an Application Document template. Separate instructions are available for Application Profile and Specification Document templates.

Review best practices for optimal results.

 

Options

Use the fields in this section to control document-wide settings.

Field Description
Detail Level

Refines the Application Document's chapters and tables. Options include:

High Level Overview — 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 — Details on property rules referenced by case types and Entity Relationship Diagrams.

Section headings will display

Controls how rule-related headings in the document are formatted. Options include: Short Description and Rule Name.

Suppress class and ruleset references

Controls visibility of the applies to class and ruleset names in the generated document.

Create links to rule forms within document Includes hyperlinks to open rules directly from the document.

 

Rulesets

Click Make Selection to view a list of application rulesets. Check any box next to a ruleset name to include it in the generated document.

Use the Select All and Clear All buttons to make quick selections.

 

Case Types and Supporting Specification Types

Click Make Selection to view a list of application case types and supporting specification types. Options in the list vary based on:

Check any box next to a case type or specification type to include it in the generated document.

Use the Select All and Clear All buttons to make quick selections.

 

Document Sections

Click Make Selection to view a list of possible chapters to include in the generated document.

Default selections are based on the value in the Detail Level field. You can add or remove options by checking the box next to a chapter name.

Use the Select All and Clear All buttons to make quick selections.

NoteClick Refresh in the Document Table of Contents section to see a preview of your selected chapters and their associated subchapters.

 

Case Type Criteria

Click Make Selection to specify which case type details are included in the generated document. For example, you can include flows but exclude flow actions.

Default selections are based on the value in the Detail Level field. Add or remove options based on your project needs.

Use Select All and Clear All buttons to make quick selections.

 

Document Table of Contents

This section gives you a preview of the generated document's table of contents.

Each  row represents a chapter. Expand any row to see its subchapters.

Click Refresh to update the preview with your latest settings.

 

Step 2