Gadgets for Dashboards and Confluence

Topics

Release Management app adds the following dashboard gadgets into Jira gadgets repository:

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

  • release delay status and delay in days

  • projected release date

The progress is calculated based on issue count in the issue status categories "To Do", "In Progress" and "Done".

The progress is also displayed as <number of issues> / percentage under the category name.

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

The gadget also shows number of days left until the planned release date.

If the "Projected release date" could be calculated then the gadget shows number of days till the "Projected release date" instead of planned release date.

In case that package or version is delayed, the number of due days will be replaced to the number of delayed days.

Configuration

The gadget has the following configuration options:

  1. Board - release board

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

  3. Auto refresh - automatically refreshes gadget

Universal Progress Gadget

This gadget shows work progress for a custom JQL function:

  • how many issues are in "To Do", "In Progress" and "Done" categories (defined by workflow status)

  • issues percentage in each category

The progress is calculated based on issue count in the issue status categories "To Do", "In Progress" and "Done".

The progress is also displayed as <number of issues> / percentage under the category name.

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

Configuration

The gadget has the following configuration options:

  1. Name - caption of the gadget

  2. JQL - custom JQL that come as a source of issues for the progress bar

  3. Auto refresh - automatically refreshes gadget

Package Status Gadget

Package status gadget shows the details of the package within all versions that are part of the package:

  • 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

  • Projected release date - automatically calculated projected release date of the release or version based on issue progress

  • 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. Auto refresh - automatically refresh gadget

Scope Change Gadget

Only applicable for Fix Versions as we can't yet track history for 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 or 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. Show items - number of issues per page to show in each category

  7. Auto refresh - automatically refreshes the gadget

Environments Gadget

In order to embed information about environments and deployed versions into Jira dashboards or Confluence 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.

  • 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. 

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.

Configured gadget:

Trends Gadget 

Only applicable for Fix Versions as we can't yet track history for Virtual Versions.

Trends gadget depicts scope change and 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 Page.

Configuration

  1. Board - release board

  2. Package or Version - package 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 - custom JQL function 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. Auto refresh - automatically refreshes the gadget

Burnup Gadget

Only applicable for Fix Versions as we can't yet track history for Virtual 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. Original time estimate 

    3. Story points

  4. JQL - custom JQL function 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. Auto refresh - automatically refreshes the gadget

Release Calendar Gadget

Release calendar gadget shows all packages and versions on a calendar view from one or multiple release boards.

The versions and packages will be placed on the calendar according to release date. If the release date is not presented but the projected release date is calculated  - the items will be arranged according to the projected release date.

Also, a warning icon for delayed versions/packages will be shown.

  1. Packages are marked blue 

  2. Versions are marked green 

  3. The warning icon indicates delayed versions or packages

  4. (i) icon indicates that the version is placed based on the projected release date 

Configuration

  1. Boards - single or multiple release boards

  2. Tags - shortlist the output by package/version Tags

  3. Show - check if you want to versions, package and/or their milestones

  4. Show archived packages and versions

  5. Start week from Monday

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

Roadmap Gadget

Roadmap gadget shows all packages and versions on a roadmap view from a single or multiple release boards 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. All the milestones defined for the versions and packages that fit the boundaries of start/release dates will be outlined as well. Progress bar for versions and packages in here either. Navigate you mouse to point of interest to version/package - a tooltip with additional information.

Configuration

  1. Boards - single or multiple release boards

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

  3. Delayed - shortlist only Delayed versions or only "On Track" or show all together

  4. Report interval - define the timescale of the gadget

  5. Start Date - self-explanatory.

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

Milestones Report Gadget

The gadget is a replica of Milestones Report that you can now put on the Dashboard or Confluence. I shows the status of all milestones or all packages selected as well as their underlying component versions.

Configuration

  1. Boards - single or multiple release boards

  2. Packages - shortlist of packages from selected boards as a source for Milestones Report Gadget

  3. Archived - whether to show just active versions and packages as well

  4. Delayed - shortlist only Delayed versions or only "On Track" or show all together

  5. Show Packages - show milestones in bulk or per package

  6. Show Details - show milestones per each and every component version 

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

Release Notes Gadget

The gadget is a replica of Release notes you can generate on any Release Management board.

Configuration

  1. Boards - single or multiple release boards

  2. Package or Version - shortlist of packages/versions from selected boards as a source for Release Notes

  3. Release Notes template - one of the templates from selected board

  4. Date/Time format that you want to use

  5. Limit gadget height (in pixels) - since the output of release notes might be too long you might want to limit it to scroll on demand

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

More "Gadgets"?

We always keen to add more insightful gadgets as we develop new features into our add-on. If you have idea of a gadget please do not hesitate to drop us suggestion via ServiceDesk Portal. Appreciate that.