The Application Document wizard allows you to specify reusable document settings and application data content to create professional looking documentation of application assets throughout a project lifecycle or in support of your day to day maintenance updates.

Documents are based on Microsoft Word templates you can customize to meet your organization's documentation styles and standards.

Launching the Wizard

From the developer portal, select Application > Document.

When the wizard starts the list of steps you take to select document settings and create the document is displayed on the left side of the screen. Steps are:

• Select Application - selects the application you want to document, the template, and whether you want to use a set of previously saved settings
• Select RuleSets - selects the RuleSets
• Select Work Types - selects the work types and use case categories of the individual work types
• Select Criteria - selects the general level of document detail, the chapters and tables, and the rule detail
• to include for the work types
• Order Flows - sets the display order of flows
• Define Diagrams - sets the criteria for including entity relationship diagrams (ERD); then, creates and displays the diagrams for review and edit
• Define Screenshot Data - sets up work object data for models that are applied to screen shots of flow components
• Capture Screens - captures screen shots of harnesses, flow actions and correspondence based on a selected display style
• Create Document - creates the document in Microsoft Word based on the settings selected; allows you to edit and save the document

Creating Document Settings

For each step:

1. 1. Select the settings.

Click on a step to display a pop-up help window similar to the one below that describes how to complete the step.

• Click Next >> to move to the next step.
• Click a step at any time to return to a step or click <<Back to return to the previous step.
• Click Save to create a new saved setting or to save changes to previously saved settings. When you save a new setting, enter a name to describe the setting and click Apply to save it.
• Click Cancel if you want to close the wizard.
• Click Delete if you want to remove the named setting.

Creating the Document

1. 1. Click the Create Document step.

1. Click Create Document to launch Microsoft Word in a separate window where it compiles the settings, screen shots, and rule information into a professional looking document.
2. When the document opens, review and edit it.
3. Save it to a local file.
4. Click Close to exit the wizard.

Customizing Document Templates

You can create custom templates that meet your company's document styles and standards.

The default application and profile documents are defined in the Word Template rules PegaAccel-Task-DocumentApp.ProjectDocument and .ApplicationDocument.

To customize the document:

1. In the Find By tool, enter ProjectDocument or ApplicationDocument. Select the template rule.
2. Perform a Save As to a new name and to a RuleSet that lists the Pega-AppDefinition RuleSet as a prerequisite.
3. Enter a short but meaningful description of the template. The text you enter here is the text that displays in the selection box on the Select Application step.
4. Select Document Application as the category.
5. Click Edit Word Template to display and edit the template.
6. Save the template.
7. Click Upload File.
8. When the load completes, click Save.

For more information about setting up Template rules, see the Knowledge Base article How to use Word Template-based Correspondence Generation.

This article links to the following articles about the capabilities available in the DCO 3.2 and 3.1 releases.

Return to About the Direct Capture of Objectives