Skip to main content

Mermaid diagrams

Use a Mermaid diagram when a picture is easier to keep as text. Typical uses are a sequence of calls between systems, a small entity-relationship view, a flowchart, or a lightweight dependency sketch.

Caplo draws the diagram on the canvas. For sequence and entity-relationship diagrams, it can also recognize the repository items you name and show those connections in Relations and in reports.

For a business process with tasks, events, and gateways, use Process modeling (BPMN).

Shared diagram with a Mermaid shape

Create a Mermaid diagram​

Stay in Architect mode. Open the more-tools chevron on the diagram toolbar. In Mermaid & BPMN, choose Mermaid Diagram. It is the first tool in that group.

Mermaid Diagram and BPMN Diagram tools in the more-tools menu

Drag on the canvas. The editor opens as soon as the shape is created. Double-click the shape later to edit it again.

Edit the text​

The code is on the left and the picture is on the right. Use the syntax link in the editor when you need the Mermaid reference. Save when you want the canvas, and any recognized repository connections, to update.

Mermaid editor with live preview

Pick a repository item with @

Type @ while you edit and choose an existing application, process, or other repository item. Caplo then uses that item when it reads the diagram.

Sequence example:

Entity-relationship example:

Write a name that contains spaces in quotes, for example SAP["SAP S/4HANA"]. In a sequence diagram, a name that contains # or ; needs the form participant Portal@{"alias":"A#B"}, because Mermaid otherwise treats # as a comment.

For the rest of the syntax, see the Mermaid docs.

Use it with the repository​

Sequence diagrams and entity-relationship diagrams are the ones Caplo reads for repository connections. Name the participants or entities so they match items already in the repository, or insert them with @.

Those connections then show up where you explore relations and in reports that follow relation paths. They come from the Mermaid diagram: change the text, save, and the connections follow. When you want a connection you manage on its own, draw it with linked shapes and an arrow on the canvas.