Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

At times, there might be errors in the DOT language you use while creating Graphviz diagrams in Jira issues. This page explains the means how to view these errors to see what went wrong and possibly fix them.

Steps

In the intended Jira issue:

  1. Click Click Graphviz from the menu options to see the Graphviz for Jira section.
  2. Click Graphviz from the menu options again or Add a Graphviz diagram in the Graphviz for Jira section to navigate to the Graphviz Diagrams for Jira window :for further edits.
    Image Modified
  3. Enter the following in the Graphviz Diagrams for Jira window:
    • Graphviz source attachment: None (because this example uses DOT language as input).
    • Graphviz output attachment name: Nil.
    • Layout: dot
    • Content:Create diagram from: Select Create a new diagram from scratch.
    • Content: Enter the following

      Code Block
      graph {
          a -- b;
          b -- c;
          a -- c;
          d - c;
          e -- c;
          e -- a;
      }
    Click Preview to preview the output diagram before saving the changes

    • Layout: dot
    • Graphviz output attachment name: Nil.
  4. Click the Preview (Image Added) icon on the top right corner of the Content field to preview the diagram. The error is displayed below the Preview button in the preview pane as the following:
    Image RemovedImage Added
    Or when you click Save without previewing the output, the error is displayed in the Graphviz for Jira section of the issue as the following:
    Image RemovedImage Added
    This error message points to the exact line where and how the wrong DOT code is used with an indication towards what went wrong. This helps you fix the error. While previewing, you can make the changes immediately and click Refresh (Image Added) icon to view the output in the preview pane.


Info

The steps mentioned here are for the new Jira issue view. If you

...

are using the old Jira issue view, replace step 1 and 2 with the following:

Click Add a Graphviz diagram in the Graphviz for Jira section to navigate to the Graphviz Diagrams for Jira window for further edits.