Generating an application document

Use the Document Application tool to generate an application document. An application document provides application data and details, including business processes, specifications, requirements, reports, correspondence, and interfaces, to stakeholders.

Information in an application document is presented in order based on how the application was built (for example, by case life cycle management), and includes all of the specifications linked with an implementation rule.

1. Open the Document Application tool by clicking Application > Tools > Document from the Designer Studio menu.
2. Click Application document.
3. Select the Include related built-on application layer assets check box to include cases from the selected application and referenced assets from any application in the stack, excluding Pega layers such as PegaRULES and PegaDM. This check box is available and selected by default if your application has a built-on application.
4. In the Application field, select an application in your stack.
5. In the Level of detail field, specify the type of information to include in the document. The following options are available:
   • High level overview — A business summary of case types, flows, specifications, and requirements.
   • Full application documentation —  Detailed rule information, in addition to the high level overview content.
   • Property references — Information about the property rules referenced by case types and Entity Relationship Diagrams.
6. Click Customize to configure the following information:
   • Rulesets — Select the rulesets to include in the document.
   • Case/Supporting types — Select the case types and supporting specification types to include in the document. Available options depend on the following criteria:
     • The rulesets selected in the Rulesets section. Only case types whose implementation class belongs to selected rulesets are listed.
     • The supporting specification types defined on the application and built-on application rule forms.
   • Document sections — Select the sections to include in the document. Sections are selected by default based on the value in the Level of detail field. You can modify the default selections.
   • Case type assets — Specify the details that you want to include for each case type. For more information, see Case type assets.
   • Entity relationship diagrams — Specify whether to include entity relationship diagrams (ERDs) in the document.
7. In the Chapter titles field, select whether to use short descriptions or rule names.
8. Select the Show class and ruleset references check box to control visibility of the applies to class and ruleset names in the generated document.
9. Select the Provide links to rule forms check box to include links that open rules directly from the document.
10. Specify the order of chapters for the generated document.
11. On the Screen captures tab, add screen captures that include representative sample data.
12. Optional: Click Save document configuration from the Actions menu to save your configuration settings.
13. Click Generate document to generate the Word document with the current settings.

Open topic with navigation