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.

Contents of application overview and data model documents

Suggest edit Updated on September 10, 2021

Provide stakeholders with high-level information about your application by generating application overview and data model documentation. Customize the document to include only relevant information.

You can include the following details in the application overview:

  • Case types
    • Case types details
      • Graphic representation of stages in case types
      • Case wide optional processes
      • Case wide optional actions
    • Stages in case types details
      • Statuses associated with each stage
      • Processes associated with each stage
      • Stage wide optional processes
      • Stage wide optional actions
      • Conditions for skipping a stage
  • Data types
    • Systems of records
    • References between data types and case types
  • Roles
    • Number of operators for each role
    • Web channels available for each role
    • Pages available for each role for each web channel
  • Channels and interfaces
    • Roles that use a specific channel as a default channel
    • Roles with access to a specific channel
  • Features that are defined in the application

A data model document contains the following information that you can export to .xml and .docx files:

  • All data types and case types with descriptions
  • References between data types and case types
  • System of records for each data type
  • Fields for each data type and case type with the following details:
    • Label
    • ID
    • Type
    • Field group type, if applicable
    • List items, if applicable
    • Is calculated field
    • Calculation details, if calculated
    • Description

For more information about the application overview and data model documents, see the following articles:

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