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.

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

Updated on June 10, 2020

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

By completing the fields in Step 2 of the Application Document Wizard, you can supplement your Application Documents with Entity Relationship diagrams (ER diagrams). You can also define criteria for the system to capture screenshots of your application flows. The screen capture process occurs later on in Step 3.

Before you attempt to follow the guidance in this article, verify that your system meets all pre-requisites. Follow the Getting Started instructions in Using the Application Document Wizard.

For an overview and guidance on completing other steps in the Application Document Wizard, refer to the Related content section of this article.

Adding Entity Relationship diagrams

Use the fields in the Entity Relationship Diagrams section to embed Microsoft Visio objects in your document that illustrate class structure and dependencies. Each ER diagram is stored in the system as an instance of Rule-File-Binary with an attached *.vdx file.

To create ER diagrams:

  1. Check the box next to each case type and class name.
  2. Add more classes by clicking the add row icon and entering a fully qualified class name in the Class Name field.
  3. Select an application ruleset name and unlocked version in the Ruleset and Ruleset Version fields. This is the ruleset version that stores the ER diagram.
  4. Select options in the Classes and Properties fields to refine the level of detail in each ER diagram.
  5. Click Create.
  6. Wait for the progress icon to stop spinning.
  7. Click the icon in the Edit column next to a case type or class name to open the Rule-File-Binary instance.
  8. Click Download file to save the *.vdx file to your local system.
  9. Open the *.vdx file in Microsoft Visio to review it.

In this example ER diagram, the TravelEvent class has one Location andhas zero to many Customers and Parties. Each instance of of the Email class has the pyEmailAddress property.

ER diagrams appear as embedded objects in the generated document. Stakeholders can double-click the icon to open the *.vdx file in Microsoft Visio.

To modify an existing ER diagram in the Application Document Wizard, refer to the Working with Entity Relationship diagrams help topic.

The Entity Relationship Diagram section is only visible when the Entity Relationship Diagrams option is selected in Step 1.

Defining screenshot data

Use fields in the Screenshot Data section to define how screenshots of starting flows are included in the generated document. Each screenshot is stored in the system as an instance of Data-Content-Image with an attached *.jpg file.

To define screenshot data for a case type:

  1. Use the Cases Explorer to locate and open the case type.
  2. Open the starting flow by clicking the rule opener icon next to the Starting Processes field on the Processes tab.
  3. Review the contents of the Diagram tab to familiarize yourself with the number of steps, assignments, and flow actions in the flow. Click a subprocess shape to expand it.

    In this example starting flow, the Travel Event case type is created in three steps: Create Event, Review Event, and Confirmation.

  4. Run the starting flow by selecting the case type name from the top-level +Create menu in Designer Studio.
  5. Complete each step in the flow by entering meaningful data in each field.

    Following is an example of completed fields in the Create Event, Review Event, and Confirmation steps for a Travel Event case:
  6. Pay attention to the work ID associated with the completed flow or case instance. You need to reference this work ID in a later step.
    In the example above, theTravel Event case instance has a work ID of Event-4.
  7. Click Define Screenshot Data next to the case type.
  8. Enter the work ID of your case instance in the Define Screenshot window. This tells the system to associate the values stored in this work object with the screenshot for each step.
  9. Click Create to create a data transform based on the specified work object.
  10. Click Close.

Repeat this process for each case type and associated starting flow.

Click Next to continue to Step 3 of the wizard, where you can build and customize the screenshot catalog.

Related content

Using the Application Document Wizard

How to add application details in the Application Document Wizard

How to build a screenshot catalog in the Application Document Wizard

How to order content in the Application Document Wizard

  • Previous topic Updating customized Application Document templates with server-side document generation
  • Next topic Integrating Agile Workbench with CA Agile Central

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