Skip to main content

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

How to add application details in the Application Document Wizard

Suggest edit Updated on June 10, 2020

For guidance on the Application Document Wizard in previous releases, see:

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.

Document-wide settings

Use the fields in the Options section to define the basic structure and presentation of your document.

  1. 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.
  2. 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 the Make Selection buttons 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.

Helpful Tips:

  • 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 Next to move on to Step 2 in the wizard.

Related content

Using the Application Document Wizard

How to add Entity Relationship diagrams and screenshots to an Application Document

How to build a screenshot catalog in the Application Document Wizard

How to order content in the Application Document Wizard

Did you find this content helpful? YesNo

Have a question? Get answers now.

Visit the Collaboration Center to ask questions, engage in discussions, share ideas, and help others.

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us