Dashboard Gadgets

Owned by Yuri (Unlicensed)
Last updated: Oct 28, 2024 by Yuri Lapin
9 min read

Topics

Progress Gadget

This gadget shows work progress for a selected version or package:

  • how many issues are in "To Do", "In Progress" and "Done" categories

  • issues percentage in each category

One can click the numbers link to open those issues in Jira's Issue Navigator.

Configuration

The gadget has the following configuration options:

  1. Board - release board

  2. Package/Version - package or version to show progress for (depends on the selected board)

  3. JQL filter. Additional JQL filter to fine tune the output.

  4. Description - free text description, good to bring business, technical context or just comment on the data depicted.

  5. Auto refresh - automatically refreshes gadget

Release Calendar Gadget

Release calendar gadget shows all packages and versions on a calendar view from a particular board.

The versions and packages will be placed on the calendar according to release date.

The following color coding is used.

  1. Releases are marked blue 

  2. Versions are marked green 

Configuration

The gadget has the following configuration options:

  1. Board - release board

  2. Show archived packages and versions - adds archived items as well

  3. Show week from Monday - Sun is by default

  4. Description - free text description, good to bring business, technical context or just comment on the data depicted.

  5. Auto refresh - automatically refreshes gadget

Scope Change Gadget

Available for fixVersions only, not the Virtual versions.

Scope change gadget outlines the details of scope changes in package or version over time:

  • Added issues - issues added to package or version during the specified period of time

  • Removed issues - issues removed from package or version during the specified period of time

It is recommended to track such changes and manage them properly.

One can open issues in Issue Navigator to get more details and/or handle issues further.

Configuration

The gadget has the following configuration options:

  1. Board - release board

  2. Package/Version - package or version to show scope change for (depends on the selected board)

  3. Report Interval - you can choose from predefined intervals or define a custom date range

  4. Include Sub-tasks - whether to include sub-tasks to output or not

  5. Issue types - filter on issue types for the output

  6. Estimation - point that you want to use to show the impact of the change

  7. Show items - number of issues per page to show in each category

  8. Description - free text description, good to bring business, technical context or just comment on the data depicted.

  9. Auto refresh - automatically refreshes the gadget

Environments Gadget

In order to embed information about environments and deployed versions into Jira dashboards an Environments Gadget has been created:


Configuration

The gadget has 2 types of the configuration:

  1. Environment - to take an environment-centric view. In other words: show what is deployed to a particular environment.

  2. Version - version-centric view. Show where the version has been deployed.

Environment-centric view

Configuration view:

  • Board - Board name from which the environments will be taken

  • Type  - choose a mode of the gadget. In this case: Environment.

  • Environment - choose the environment from available on the board.

  • Sort by release date [ASC/DESC] - direction of sorting by release date.

  • Show environment description in the gadget. This option is could be beneficial to show some useful information (like URL, test login and password etc) right on the gadget. 

  • Description - free text description, good to bring business, technical context or just comment on the data depicted.

Configured gadget:

Version-centric view

Configuration view:

  • Board - Board name from which the environments will be taken

  • Type  - choose a mode of the gadget. In this case: Version.

  • Version - choose a version from available on the board.

  • Description - free text description, good to bring business, technical context or just comment on the data depicted.

Configured gadget:

Package Status Gadget

Package status gadget shows the details of the package as well as all associated versions:

  • Name - name of the package or version

  • Status - status of the package or version on the Release Board

  • Progress - issue based progress widget similar to Progress Gadget

  • Release date - planned release date of the package or version

  • On critical path - version is on critical path if its release delay affects the whole package delay

Configuration

The gadget has the following configuration options:

  1. Board - release board

  2. Package - package to show status for (depends on the selected board)

  3. Entity Types - shortlist entity types you want to include in Package Status Gadget.

  4. Description - free text description, good to bring business, technical context or just comment on the data depicted.

  5. Auto refresh - automatically refresh gadget

Release Roadmap Gadget

Roadmap gadget shows all packages and versions on a timeline view from a particular board and pretty much a replica of roadmap view from the same board.

The versions and packages will be placed on the roadmap view according to start / release date. Navigate you mouse to your point of interest to outline a tool tip with additional information.

Configuration

  1. Board - release board

  2. Archived - whether to show just active versions and packages or achieved as well

  3. Tags - shortlist roadmap to show entities with version or package Tags assigned

  4. Report interval - define the timescale of the gadget

  5. Start Date - self-explanatory.

  6. Description - free text description, good to bring business, technical context or just comment on the data depicted.

  7. Update every 15 min - to keep it close to realtime.

Burnup Gadget

Available for Fix Versions only. Coming soon for Epics and Sprints. Not available for JQL Versions.

Burnup gadget depicts burnup chart for a version or a set of burnup charts plus cumulative burnup chart for the entire package.

Detailed explanation on how the burnup chart works is provided on the Reports page.

Configuration

  1. Board - release board

  2. Package or Version - package or version to show progress for (depends on the selected board)

  3. Units - units which will be used for report

    1. Issue count 

    2. Story points

    3. Original time estimate 

  4. JQL filter - additional JQL filter to adjust gadget output

  5. Draw from Start Date - version report will drown from version start date if the date is specified. Otherwise, the report will drown from the date when the first item was added to the version.

  6. Show version/package summary - show the summary widget in addition to burnup chart

  7. Description - free text description, good to bring business, technical context or just comment on the data depicted.

  8. Auto refresh - automatically refreshes the gadget

Trends Gadget 

Available for Fix Versions only. Coming soon for Epics and Sprints. Not available for JQL Versions.

Trends gadget depicts “scope change” and “done items“ velocity trends for a version or a set of trends charts plus cumulative trends chart for the entire package.

Detailed explanation on how the trends chart works is provided on the Reports

Configuration

  1. Board - release board

  2. Package/Version - release or version to show progress for (depends on the selected board)

  3. Group by - choose an aggregation period

    1. Day

    2. Week

    3. Month

  4. Units - units which will be used for report

    1. Issue count 

    2. Original time estimate 

    3. Story points

  5. JQL filter - additional JQL filter to adjust gadget output

  6. Done items trends switcher. Turns on/off done items trend

  7. Scope change trend switcher.  Turns on/off scope change trend

  8. Draw from Start Date - version report will drawn from version start date if the date is specified. Otherwise, the report will drown from the date when the first item was added to the version.

  9. Show version/package summary - show the summary widget in addition to trends chart

  10. Description - free text description, good to bring business, technical context or just comment on the data depicted.

  11. Auto refresh - automatically refreshes the gadget

Release List Gadget 

Release List gadget is an echo of List View in a format of Dashboard Gadget.

Configuration

  1. Board - release board

  2. Group by - choose an aggregation type

    1. None

    2. Packages

    3. Projects

    4. Tags

    5. Types

  3. Items per page - 10/25/50/100

  4. Sort by / direction - one of the column from the list + direction

  5. Name - full text search by name

  6. Archived - All/Unarchived/Archived

  7. Tags - list of Tags for versions and packages

  8. Columns - shortlist for columns (packages and versions) or all of them

  9. Release date - Any/Quarter/Month/Custom

  10. Environments - shortlist for environments for versions or all of them

  11. Projects - shortlist for projects for versions or all of them

  12. Project categories - shortlist project categories

  13. Issue type - All/Versions/Cross-project/Sprints/Epics/JQL versions

  14. CPV elements - CPV stands for Cross-Project Versions. Show specific per-project versions in addition to cross-project or not.

  15. Version Properties - filters by version specific custom properties

  16. PackageProperties - filters by package specific custom properties

  17. Description - free text description for widget output

  18. Auto refresh - automatically refreshes the gadget

Exporting Gadgets to Confluence

Step 1. Create Jira Dashboard

Create a new Dashboard - the Dashboard will be included in the Confluence page, so you could add there one or multiple gadgets.

Assign correct permission to the dashboard so the relevant people can see it.

Change layout to the single-column layout!

Add your prefered gadget(s).

Switch to wallboard mode and copy URL in the browser.

Step 2. Create Confluence Page

Open the Confluence page and add the iFrame macro.

Put URL from the Wallboard and customize the size.

Save page and share with your team.