Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

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.

Using the Application Document Wizard

Updated on June 10, 2020

Use the Application Document wizard to quickly share your application designs with stakeholders. You can create interactive, professional-looking documents that are tailored to your target audience. By using this wizard, you can save time, promote reuse, and generate meaningful project artifacts.

The following figure highlights the key features of this wizard.

Key features of the Document Application form

Key features of the Document Application form

The number of steps and available options in the wizard depend on the type of Word template that you are using. The following templates are supported:

Template nameDescriptionAvailable steps in the wizard
Application Document

Captures application data and details, including business processes, specifications, requirements, reports, correspondence, and interfaces.

  • Select
  • Define
  • Capture
  • Order
Application Profile

Captures a high-level application overview and project information such as implementation time frames and sizing estimates.

  • Select
  • Order
Specification Document

Captures application specifications and linked requirements.

  • Select
  • Order

This article describes how to generate a document by using the Application Document template.

Getting started

Prepare your system to generate a complete Application Document:

  1. Verify that all prerequisites are installed on your computer:
    • A supported version of Internet Explorer (for capturing screen shots)
    • Microsoft Visio (for viewing entity-relationship diagrams, or ERDs)
  2. Start the wizard from the Designer Studio > Application > Tools > Document menu or the Application Overview landing page (Actions > Document Application > Application Document).
  3. Select the Create new document option to start the wizard with default settings.
  4. Select the name of an application in your stack from the Select an Application list.
  5. Select Application Document from the Select a Template list.
If you do not have Internet Explorer or Microsoft Visio, screen shots and entity-relationship diagrams are omitted from the generated document. Microsoft Word is required to view (not generate) the document.

Running the wizard

You can complete the steps in sequential order or skip to any step by using the numbered icons in the wizard header.

To run the wizard in sequential order:

  1. Start the wizard by using the steps in the previous Getting started task.
  2. Complete the fields in Step 1: Select to define which application details, such as case types, rulesets, and flows to include in the document. Click Next.
  3. Identify the flows in your application with screens to include in the document.
  4. Run each flow to completion by entering realistic data. Record the work IDs for future reference.
  5. Complete the fields in Step 2: Define to associate your recorded work IDs with a corresponding case type. You can also use this step to create entity-relationship diagrams. Click Next.
  6. Complete the fields in Step 3: Capture to build a screen shot catalog that is based on the work IDs provided in Step 2. The images in this catalog are labeled and inserted into the document. Click Next.
  7. Complete the fields in Step 4: Order to define the order of chapters and sections in the document.
  8. Review your settings by clicking the Back and Next buttons.
  9. Generate the document.
Generating the document

You can generate a document during any step when you run the wizard.

To generate a document:

  1. Close all Word sessions. Only one Word session initiated by Pega 7 can be open at a time.
  2. As a best practice, click Save to make your current wizard settings reusable.
  3. Click Document Now. The Application Document starts to be generated in the background.
    Dialog box for generating an application document
  4. When generation is complete, download the Application Document and specify a name for the document.
    Document generation success message
  5. Move your Application Document from the default temp directory to a shared location for distribution.

For best practices and more information about supported templates, refer to theAbout Application Documentation Wizard help topic.

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

  • Previous topic How to use the DCO Compatibility tool
  • Next topic How to add application details in the Application Document Wizard

Have a question? Get answers now.

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

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us