NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

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

Scrollbar
iconsfalse

...

The JIRA Issues macro allows you to display a table of JIRA issues perform the following tasks:

  • Display information from JIRA on a Confluence page

...

  • in the following ways:
    • Display a table listing JIRA issues that meet your criteria
    • Display a count of

...

    • issues that meet your criteria
    • Display a link pointing to a single issue
  • Create a JIRA issue in Confluence

...

...

For instructions, refer to the

...

following Atlassian help page:

https://confluence.atlassian.com/conf613/jira-issues-macro-964960842.html

Multiexcerpt include
MultiExcerptNameExitDisclaimer
nopaneltrue
PageWithExcerptwikicontent:Exit Disclaimer to Include

...

Create a JIRA issue in Confluence

To create a JIRA issue in Confluence

  • Type {jira and when the macro browser opens, select the JIRA macro.
  • Select Create New Issue.
  • Select the Project and Issue Type.
  • Enter the Summary and Description.
  • Select the Priority.
  • Select Insert.

The issue is created in the selected JIRA project.

Display a count of JIRA issues in Confluence

To display the count of the total JIRA issues in a particular project

  • Type {jira and when the macro browser opens, select the JIRA macro.
  • In the search box, enter the JQL query corresponding to the issues you want to count.
  • Select search.
  • When the preview of the table opens, select Display Options and then Total Issue Count.
  • Select Insert.

The following is the issue count for the JQL query 

Code Block
project = TEST AND resolution = Unresolved ORDER BY priority DESC, key DESC

Key Points for Accessibility

If you use the JIRA macro to display a list of issues or a count of issues, the result is accessible to people with disabilities. Here is an example of each:

  • A JIRA macro displaying a count of issues: 
    Jira
    serverNCI Tracker
    jqlQueryproject =

...

  • LEXSYSTEST AND resolution = Unresolved

...

  • counttrue
    serverId7954a81f-12da-3366-a0ef-97c806660e7c

This is a count of the unresolved issues in the Demo Project (TEST).

Display a table of JIRA issues in Confluence

To display a table listing the JIRA issues in a particular project

  • Type {jira and when the macro browser opens, select the JIRA macro.
  • In the search box, enter the JQL query corresponding to the issues you want to display.
  • Select search.
  • When the preview of the table opens, select Insert.

The following table is the output of the JQL query

Code Block
project = TEST AND resolution = Unresolved ORDER BY priority DESC, key DESC

...

  • A JIRA macro displaying a list of issues: 
    Jira
    serverNCI Tracker
    columnskey,summary

...

  • ,

...

  • status

...

  • maximumIssues20
    jqlQueryproject =

...

  • LEXSYSTEST AND resolution = Unresolved

...

  • serverId7954a81f-12da-3366-a0ef-97c806660e7c
Tip

You can also display a table of JIRA issues by entering the URL for the table in a Confluence page. The URL for the preceding table is

Code Block
https://tracker.nci.nih.gov/issues/?jql=project%20%3D%20TEST

The following table was inserted on the page by typing this URL on the page.

...

However, if you use the JIRA macro to display a single issue, the result has an icon without alt text, so it is not accessible to people with disabilities. Here is an example:

Lexsystest-31 Create script to pull NCI's base version of CentOSImage Added

To remain compliant with the Section 508 mandate, you have the following options:

  • Display a single JIRA issue as a simple hyperlink, as described in Using the JIRA Shortcut, and as shown here: LEXSYSTEST-31.
  • Use the JIRA Issues macro to display a count or list of issues, as shown above.