Dashboard Gadgets
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:
Board - release board
Package/Version - package or version to show progress for (depends on the selected board)
JQL filter. Additional JQL filter to fine tune the output.
Description - free text description, good to bring business, technical context or just comment on the data depicted.
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.
Releases are markedĀ blueĀ
Versions are markedĀ greenĀ
Configuration
The gadget has the following configuration options:
Board - release board
Show archived packages and versions - adds archived items as well
Show week from Monday - Sun is by default
Description - free text description, good to bring business, technical context or just comment on the data depicted.
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:
Board - release board
Package/Version - package or version to show scope change for (depends on the selected board)
Report Interval - you can choose from predefined intervals or define a custom date range
Include Sub-tasks - whether to include sub-tasks to output or not
Issue types - filter on issue types for the output
Estimation - point that you want to use to show the impact of the change
Show items - number of issues per page to show in each category
Description - free text description, good to bring business, technical context or just comment on the data depicted.
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:
Environment - to take an environment-centric view. In other words: show what is deployed to a particular environment.
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:
Board - release board
Package - package to show status for (depends on the selected board)
Entity Types - shortlist entity types you want to include in Package Status Gadget.
Description - free text description, good to bring business, technical context or just comment on the data depicted.
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
Board - release board
ArchivedĀ - whether to show just active versions and packages or achieved as well
Tags - shortlist roadmap to show entities with version or package Tags assigned
Report intervalĀ - define the timescale of the gadget
Start Date - self-explanatory.
Description - free text description, good to bring business, technical context or just comment on the data depicted.
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
Board - release board
Package or Version - package or version to show progress for (depends on the selected board)
Units - units which will be used for report
Issue countĀ
Story points
Original time estimateĀ
JQL filter - additional JQL filter to adjust gadget output
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.
Show version/package summary - show the summary widget in addition to burnup chart
Description - free text description, good to bring business, technical context or just comment on the data depicted.
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
Board - release board
Package/Version - release or version to show progress for (depends on the selected board)
Group by - choose an aggregation period
Day
Week
Month
Units - units which will be used for report
Issue countĀ
Original time estimateĀ
Story points
JQL filter - additional JQL filter to adjust gadget output
Done items trends switcher. Turns on/off done items trend
Scope change trend switcher.Ā Ā Turns on/off scope change trend
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.
Show version/package summary - show the summary widget in addition to trends chart
Description - free text description, good to bring business, technical context or just comment on the data depicted.
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
Board - release board
Group by - choose an aggregation type
None
Packages
Projects
Tags
Types
Items per page - 10/25/50/100
Sort by / direction - one of the column from the list + direction
Name - full text search by name
Archived - All/Unarchived/Archived
Tags - list of Tags for versions and packages
Columns - shortlist for columns (packages and versions) or all of them
Release date - Any/Quarter/Month/Custom
Environments - shortlist for environments for versions or all of them
Projects - shortlist for projects for versions or all of them
Project categories - shortlist project categories
Issue type - All/Versions/Cross-project/Sprints/Epics/JQL versions
CPV elements - CPV stands for Cross-Project Versions. Show specific per-project versions in addition to cross-project or not.
Version Properties - filters by version specific custom properties
PackageProperties - filters by package specific custom properties
Description - free text description for widget output
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.