# Usage

After installing and starting the trial period, the app will add a custom field name **UML text** to the Jira instance.

The first step is to add the custom field **UML text** to issue types and projects.

## For classic Jira projects

### Associate the UML field to issue screens

Navigate to the **Custom fields** page.

![Mermaid UML Diagrams and Graphviz Diagrams for Jira](https://fulstech.files.wordpress.com/2020/07/image.png?w=1024)

![Mermaid UML Diagrams and Graphviz Diagrams for Jira](https://fulstech.files.wordpress.com/2020/07/image-1.png?w=1024)

Search for the custom field **UML text** and add it to screens.

![Mermaid UML Diagrams and Graphviz Diagrams for Jira](https://fulstech.files.wordpress.com/2020/07/image-2.png?w=1024)

![Mermaid UML Diagrams and Graphviz Diagrams for Jira](https://fulstech.files.wordpress.com/2020/07/image-3.png?w=1024)

![Mermaid UML Diagrams and Graphviz Diagrams for Jira](https://fulstech.files.wordpress.com/2020/07/image-4.png?w=1024)

### Add the **UML** panel to the issue screen

On an issue view, click on the “three dots” icon and select **UML Diagrams**.

## **For Next-gen Jira project**

Click on **Project settings** on the left sidebar.

![Mermaid UML Diagrams and Graphviz Diagrams for Jira](https://fulstech.files.wordpress.com/2020/09/image-1.png?w=1024)

On the **Project settings** page, click on **Apps** on the left sidebar.

![Mermaid UML Diagrams and Graphviz Diagrams for Jira](https://fulstech.files.wordpress.com/2020/09/image-3.png?w=1024)

Click on **App fields** on the left sidebar and enable **Mermaid UML for Jira Cloud.**

![Mermaid UML Diagrams and Graphviz Diagrams for Jira](https://fulstech.files.wordpress.com/2020/09/image-4.png?w=1024)

Go back to the **Project settings** page, click on **Issue types** on the left sidebar.

![Mermaid UML Diagrams and Graphviz Diagrams for Jira](https://fulstech.files.wordpress.com/2020/09/image-2.png?w=1024)

Drag the **UML text** field from the right sidebar and drop it into the **Description fields** area.

![Mermaid UML Diagrams and Graphviz Diagrams for Jira](https://fulstech.files.wordpress.com/2020/09/image-5.png?w=1024)

![Mermaid UML Diagrams and Graphviz Diagrams for Jira](https://fulstech.files.wordpress.com/2020/09/image-6.png?w=1024)

## Add Mermaid UML graphs to an issue

Click on the **Edit** button.

![Mermaid UML Diagrams and Graphviz Diagrams for Jira](https://fulstech.files.wordpress.com/2020/07/image-6.png?w=842)

**Please do not edit the custom field itself. Whenever you want to add or modify graphs, please use the app’s Edit button.**

The UML content is wrapped around by **{uml}…{uml}**. The diagram is defined using Mermaid. Mermaid (<https://mermaid-js.github.io/mermaid/#/>) allows you to define UML diagrams in plain-text format just like Markdown. For a live editor to draft your diagrams, please try <https://mermaidjs.github.io/mermaid-live-editor>.

Sample content:

```
{uml}
sequenceDiagram
    participant Alice
    participant Bob
    Alice->>John: Hello John, how are you?
    loop Healthcheck
        John->>John: Fight against hypochondria
    end
    Note right of John: Rational thoughts <br/>prevail!
    John-->>Alice: Great!
    John->>Bob: How about you?
    Bob-->>John: Jolly good!
{uml}

{uml}
gantt
dateFormat  YYYY-MM-DD
excludes weekdays 2014-01-10

section A section
Completed task            :done,    des1, 2014-01-06,2014-01-08
Active task               :active,  des2, 2014-01-09, 3d
Future task               :         des3, after des2, 5d
Future task2               :         des4, after des3, 5d
{uml}
```

![Mermaid UML Diagrams and Graphviz Diagrams for Jira](https://fulstech.files.wordpress.com/2020/07/image-7.png?w=856)

After that, click **Save**.

![Mermaid UML Diagrams and Graphviz Diagrams for Jira](https://fulstech.files.wordpress.com/2020/07/image-8.png?w=1024)

## Examples

### Flowchart

Flowcharts can be rendered with Mermaid. See more <https://mermaid-js.github.io/mermaid/#/flowchart>.

![Input](/files/-MhIdeP_9qwFFjMXGLyu)

![Render](/files/-MhIdjq-fl2RZxqDtmu7)

### Sequence diagram

Sequence diagrams can be rendered with Mermaid. See more <https://mermaid-js.github.io/mermaid/#/sequenceDiagram>.

![Input](/files/-MhIe4Un8Eo3hWoWYYX4)

![Render](/files/-MhIeD_QK-LvhMteP_Fj)

### Class diagram

Class diagrams can be rendered with Mermaid. See more <https://mermaid-js.github.io/mermaid/#/classDiagram>.

![Input](/files/-MhIeWswsa5-7FqR3c0z)

![Render](/files/-MhIeauFRKF8tHym5HLL)

### State diagram

State diagrams can be rendered with Mermaid. See more <https://mermaid-js.github.io/mermaid/#/stateDiagram>.

![Input](/files/-MhIeq24gHrmQE9_v0ZY)

![Render](/files/-MhIeua2A220VI3jfw7H)

### User Journey

User Journey can be rendered with Mermaid. See more <https://mermaid-js.github.io/mermaid/#/user-journey>.

![Input](/files/-MhIhPIxr6ELAF866lj7)

![Render](/files/-MhIhW7GCNPtPnK9GAv7)

### Gantt chart

Gantt charts can be rendered with Mermaid. See more <https://mermaid-js.github.io/mermaid/#/gantt>.

![Input](/files/-MhIgxkKyCrWsrPHevPU)

![Render](/files/-MhIh1WjWk0ouUTnz2iD)

### Piechart

Pie charts can be rendered with Mermaid. See more <https://mermaid-js.github.io/mermaid/#/pie>.

![Input](/files/-MhIhhjFRsa0Yx2RByY5)

![Render](/files/-MhIhmqtL_cy-dt981v5)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://fulstech.gitbook.io/docs/whiteboarding-and-diagramming/mermaid-uml-diagrams-and-graphviz-diagrams-for-jira/jira-cloud/usage.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.