Work with Modeling Conventions

Learn how to check if your modeling style is consistent with general or company-specific guidelines. Use modeling convention reports to improve your diagrams over time.

Modeling conventions make it easier to use a consistent modeling style.

A modeling convention consists of modeling guidelines regarding notation set, labeling, process structure and diagram layout.

With modeling convention checks, you can find out if a diagram violates these guidelines. You can run a check while modeling or when you save a diagram. Additionally, you can create a modeling conventions report after a check that contains an summary of the errors. Modeling conventions can be defined by your workspace administrator.

To run the check, you have several options:

  • Choose (Review) in the editor toolbar and select the convention.

  • Depending on your workspace settings, a prompt for a check when saving a diagram can be integrated. In this case, choose (Review) in the save dialog.

  • Select Start of the navigation pathHelp Next navigation step Modeling ConventionsEnd of the navigation path in the menu of the explorer.

Elements which violate conventions are flagged with an exclamation mark. To view a short info about the violation, hover over the exclamation mark. Additionally, the information is summarized in a table below the process diagram.

In the table, choose the element to view it in the diagram. If available, choose (Link) for more information about a guideline.

Modeling Conventions Report

You can create a modeling convention report for one or multiple diagrams in the explorer. The report contains a summary of violations of modeling conventions and is generated as an XLSX file.

To create a report, follow these steps:

  1. Select Start of the navigation pathReporting Next navigation step Modeling ConventionsEnd of the navigation path in the explorer.

  2. Select the diagrams and modeling conventions you want to include.

  3. Choose Start analysis.

    An XLSX file is generated.