Work with modeling conventions

The functions available to you depend on your license.

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:

  • Click 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, click in the save dialog.

  • Select Help > Modeling Conventions 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, click the element to view it in the diagram. If available, click the link icon 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 Reporting > Modeling Conventions in the explorer.

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

  3. Click Start analysis.

    An XLSX file is generated.