Skip to main content

Diagrams

Introduction​

Diagrams are essential tools for understanding, designing, and communicating software systems. They provide a structured way to represent system components, relationships between them, and interactions at various levels of abstraction.

In IBM Industry Solutions Workbench, you can create, manage and maintain various levels of diagrams based on the principles of C4 Modeling and create effective visual representations of your planned project.

Overview​

The Diagrams page provides you with an overview of all diagrams in the project, sorted by level:

  • Level 1 - System context diagrams
  • Level 2 - Container diagrams
  • Level 3 - Component diagrams

A click on the Label of a diagram will open it in the modeling tool.

You can view the details of a diagram by clicking on the respective row within the table or using the table row action Open details. This opens a second column to the right of the table displaying the details. All writable fields are editable here as well.

Create a diagram​

Diagrams that have been created within the diagram modeling tool (see Modeling tool) are automatically displayed within the diagrams overview. Additionally, it is possible to create new diagrams from the Diagrams overview page.

To create a new diagram, use the Create capability to the right of the table tool bar.

Diagrams are defined using the following master data:

  • Type: Choose the level of the diagram (Level 1 - System context, Level 2 - Container, Level 3 - Component; required)
  • Label: The name of the diagram (required)
  • File name: Unique identifier for the diagram that is used in the repository to where it is saved. If not specified by the user, the Label is used as a base for the File name (required)
  • Domain: Business domain to which the diagram belongs (optional)
  • Description: This is a description of the diagram (optional)
  • Tags: To tag the model element (optional)

Edit a diagram​

All editable fields can be directly edited within the details view of a diagram. You can view the details of a diagram by clicking on the respective row within the table or using the table row action Show details. The details view is also available in the modeling tool from the overflow menu in the header. This opens a second column to the right of the table where all information can be accessed and changed.

Both in the table row actions and the details view, you can access the following actions concerning the diagram:

  • Open diagram: Opens the diagram in the modeling tool
  • Share diagram: This opens a dialog where you can copy the diagram's URL or share it directly via email.
  • Clone diagram: Creates an exact copy of your diagram (see below)
  • Export as PNG: Export your diagram as an image in the PNG file format
  • Delete diagram: Delete the whole diagram (see below)

Clone a diagram​

Diagrams can also be cloned, creating an exact copy of the selected diagram. This can be of use if you want to save a specific state of a diagram, or if you want to base another diagram on the progress you already have made. The capability to clone a diagram can be accessed from the table row actions.

If you select Clone diagram, a modal opens where you can enter a new label for the cloned diagram. After creation, it will be displayed in the diagrams overview table.

Delete a diagram​

The capability to delete a diagram can be found in overflow menu at the end of each table row, as well as in the overflow menu of the details section of each diagram.

⚠warning

You can only delete a model element if it is not in use. You can check the usages of a model element in the Usages section of its details. You will need to confirm the action before the selected model element is permanently deleted.