Sequence Diagrams for Jira

Description

A Jira add-on for creating sequence diagrams from plain-text instructions.

Based on Andrew Brampton's excellent js-sequence-diagrams, this add-on is enables sequence diagrams to be easily embedded into a Jira issue.

Need to attach sequence diagrams to Confluence pages? Check out Sequence Diagrams for Confluence

Usage

Start by creating/editing an issue in Jira
From the issue tools menu, select "Attach sequence diagram"
Choose a theme for the diagram (either "simple" or "hand")
Specify your diagram instructions as per the notation examples
Click submit, and a Sequence Diagram panel will appear on the right
To modify the diagram, choose "Edit sequence diagram" from the issue tools menu
To delete the diagram, choose "Delete sequence diagram" from the issue tools menu

Example Syntax

			title: Diagram title
			participant A
			participant B
			A->B: Normal line
			B-->A: Dashed line
			A->>B: Open arrow
			B-->>A: Dashed open arrow
			note left of A: Note to the left of A
			note right of B: Note to the right of B
			note over A: Note over A
			note over A,B: Note over both A and B

Supported Java vendors (Server version)

The app has been verified to support the following Java vendors:

Oracle JRE / JDK
AdoptOpenJDK

Limitations

Export to Print/XML/Word

The rendered diagram is a vector graphic (SVN) generated dynamically in the browser using Javascript.

For this reason, it is not possible to include diagrams when exporting with Export to Print, Export to XML or Export to Word, as these static export formats are generated on the JIRA server.

Common Mistakes

If you include a diagram title, make sure to include a colon (:) after the word 'title', e.g. title: My Diagram
If you listed the participants, do not include a colon after the word 'participant', e.g. participant Bob

Still having trouble?

Sometimes it helps to start with a very simple diagram first, such as

A->B: test

Make sure that is working first, before gradually adding more actors, messages, notes etc.

Security & Privacy Statement

Sequence Diagrams for Jira is a paid add-on for Atlassian Jira Server (on premise installations) and Atlassian Jira OnDemand (cloud hosted).

Server Version

The server version is implemented as a Java JAR add-on, using the Atlassian SDK.

When installed, the add-on runs entirely within the Jira server process.

Neither the add-on provider or any other party is able to view the content of your Jira issues.

Cloud Version

The cloud version runs on the Heroku cloud platform. Heroku's physical infrastructure is hosted and managed within Amazon's secure data centers and utilizes the Amazon Web Service (AWS) technology. The Amazon servers are located in Northern Virginia in the United States.

Status information about the Heroku cloud platform can be found here.

Both Heroku and Amazon have published a security statement you can find here:

This add-on stores the sequence diagram data as a property of the Jira issue, so no data is stored, transported or logged from the Atlassian OnDemand servers to the Sequence Diagrams for Jira servers. Neither the add-on provider or any other party is able to view the content of your Jira issues.

Effective as of Sep 20, 2016.