UML Diagrams

Owned by Angelica Salazar
Last updated: Nov 14, 2024Version comment
2 min read

Overview

The UML (Unified Modeling Language) diagramming feature allows users to create various UML diagrams directly within easeRequirements for Jira. The integration with the PlantUML editor enables users to use simple text commands to generate complex diagrams (including formula) without needing a separate tool and render them visually in issue descriptions for better clarity and understanding of requirements.

To use the full capabilities of PlantUML, an installation of Graphviz is necessary on the Jira Data Center instance. This action requires server administrator assistance.

User Interface

An extra section for UML diagrams named “Diagrams” appears in the issue Detail View of easeRequirements for Jira. The diagrams created are displayed and can be managed in this section.

Operations

Purpose

Action

Comment

Purpose

Action

Comment

Add a diagram

  • Go to a project tree.

  • Open the detail view of an issue.

  • In the diagrams section, select the + icon to create a new UML diagram in the add diagram dialog.

  • Add a title and input your PlantUML code.

  • Use the View button to render your code manually. The view also renders the code automatically every few seconds.

  • Select the checkboxes for Save as PNG and/or Save as SVG if you want them saved as attachments as well.

  • Select Save in the add diagram dialog to proceed with saving.

The diagrams created will be added as a *.puml attachments to the issue selected.

Edit a diagram

  • Go to a project tree.

  • Open the detail view of an issue.

  • In the diagrams section, select the ellipse (…) on the thumbnail of the diagram you want to edit.

  • Select Edit to open the edit diagram dialog.

  • Select Update in the edit diagram dialog to proceed with saving your modifications.

 

Delete a diagram

  • Go to a project tree.

  • Open the detail view of an issue.

  • In the diagrams section, select the ellipse (…) on the thumbnail of the diagram you want to delete.

  • Select Delete to open the delete diagram dialog.

  • Select Remove in the delete diagram dialog to proceed with removing.

The deleted diagram will disappear in both attachments and diagrams section.

Add diagram as a PNG attachment

  • Go to a project tree.

  • Open the detail view of an issue.

  • In the diagrams section, select the ellipse (…) on the thumbnail of the diagram you want to add as PNG attachment to the issue.

  • Select Add as PNG attachment.

 

Add diagram as an SVG attachment

  • Go to a project tree.

  • Open the detail view of an issue.

  • In the diagrams section, select the ellipse (…) on the thumbnail of the diagram you want to add as SVG attachment to the issue.

  • Select Add as SVG attachment.