Versions Compared

Key

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

...

  • Data tab - contains the required settings of the gadget, such as title or data source

  • Series tab - lets you choose what series (lines) to display in the chart

  • Forecast tab - contains settings for calculating the forecast lines

  • More Settings tab - contains the optional settings, such as card colors

  • Colors tab - lets you customize the color of the lines displayed in the chart

Data tab

On this tab you can configure the required settings of the gadget.

...

Setting

Description

Gadget Titletitle

Choose what to display in the title bar of the gadget.

Data Sourcesource

Select the type of Data Sourcesource used by the gadget:

  • ASaved filterthat contains the Jira issues in your release (the scope of your project release). Make sure that the specified filter is shared if you want other people to visualize the dashboard.

  • A JQL query that returns the issues you want to be processed by the gadget.

Release Start Date

The start date of your release.

Release End Date

The end date of your release
  • .

Time interval

Represents the time interval of the release.

You choose from multiple options:

Custom dates - choose this option if you want to manually enter the Start date and End date of the release.

Dates of a project release - Choose this option if you want the gadget to use the start and end dates of an existing project release (added on the Releases page of a Jira project). Make sure the selected release has a Start date and End date set. Any subsequent changes to the release dates made on the project's Releases page will be automatically reflected in the gadget, without the need to reconfigure it.

Be aware that you can also check the Continue to display data after release end date option in the More Settings tab if you want the chart to still display data even if the end date has passed.

Intervals of

Indicates the time interval for calculating the chart data. If you do Agile development, this should be set according to the length of your sprints or iterations.

Calculate by

Specify on which criteria the calculation to be performed. You can choose between:

  • Story Points - the default value; use this option if the issues are estimated in Story Points. If the issues are from team-managed projects (aka next-gen projects), select Story Point Estimate instead.

  • Original Time Estimate - use this if you use time estimates; calculation will be done in hours. The Scope will be calculated as the sum of the Original Estimate field of all the issues from the filter, and each time an issue is marked as done, the Burned and Remaining lines will increase/decrease with the amount of hours that is set at Original Estimate for that issue. This option does not consider the time spent (work logged).

  • Time Remaining & Time Spent - use this option if you use time estimates and your team logs the worked time on a daily basis; calculation will be done in hours. The Scope will be calculated as the sum of the Time Spent and Time Remaining of all the issues from the filter. Burned is calculated as the sum of Time Spent of all the issues from the filter plus the sum of Time Remaining of all the issues from the filter that are done. Remaining is calculated as Scope minus Burned. This option does not consider the Original Estimate field.

  • Issue Count - use this if you want the calculation to be done by the number of issues.

  • Other numerical custom fields defined in your Jira instance - pickup the numerical custom field that you use to track or estimate the issues.

Series tab

On this tab you can choose what series to display in the chart.

...

Setting

Description

Series to Display

Choose what series to display in the chart. You can select one or more options:

Ideal Burndown - the ideal line specific to a burndown chart. It indicates how the remaining work should evolve in the ideal case. It is calculated based on Scope (see below).

Ideal Burnup - the ideal line specific to a burnup chart. It shows how the done (burned) work should evolve in the ideal case. It is calculated based on Scope (see below).

Remaining - the total amount of remaining work at that time; it is specific to the burndown chart.

Burned - the total amount of work done at that time; it is specific to the burnup chart.

Scope - represents the current release goal - the total amount of work to be done in the release at that time. Select this if you want to see the changes in the release scope over time.

Forecast Scope - makes a forecast (prediction) about the scope and displays it as a dashed line between the end of the Scope line and the release end date.

Forecast Burndown - makes a forecast (prediction) about when the remaining work is finished and displays it as a dashed line between the start of the release and the estimated release end date.

Forecast Remaining - makes a forecast (prediction) about when the remaining work is finished and displays it as a dashed line between the end of the Remaining line and the estimated release end date.

Forecast Burned - makes a forecast (prediction) about when the remaining work is finished and displays it as a dashed line between the end of the Burned line and the estimated release end date.

The calculation of forecast lines is based on the settings in the Forecast tab.

Calculate the ideal series based on

Choose how the ideal series will be calculated. The current scope means that the Ideal Burndown line starts from a value that is the same as the current (latest) value of the Scope series, while The initial scope means that the Ideal Burndown line starts from a value that is the same as the value of the Scope series at the start of the release. You can also choose A fix scope value of and specify a number representing the total work estimate of the release. This third option is useful when you have a rough estimate of the total work but have not yet added all the corresponding issues or estimates in Jira.

Tip

Tips & Tricks

  • To configure the gadget as a "classic" burndown chart, select only the Ideal Burndown and Remaining series.

  • To configure the gadget as a "classic" burnup chart, select only the Ideal Burnup and Burned series.

  • To configure it as an epic burndown / burnup chart configure the gadget to use a filter or JQL that returns the issues from your epic(s): parentEpic in (EPIC-1, EPIC-2 …)

Forecast tab

On this tab you can define how the forecast lines are calculated.

...

Setting

Description

End date forecast based on

Specify how the end date forecast is calculated.

The average velocity of all the completed intervals - by choosing this option the end date forecast will be calculated based on the average velocity (average amount of work completed) of all the completed time intervals from the chart.

The average velocity of the last x intervals - by choosing this option the scope forecast will be calculated based on the average velocity (average amount of work completed) of the most recent x completed time intervals from the chart.

A fixed velocity of … - by choosing this option the scope forecast will be calculated based on a fixed velocity, entered manually.

These settings affect all the forecast series, except Forecast Scope.

Consider the scope forecast when making the end date forecast

By checking this option, the calculation of the end date forecast will also take into account the scope forecast, not just the velocity.

Scope forecast based on

Specify how the scope forecast is calculated.

The average scope changes of all the completed intervals - by choosing this option the scope forecast will be calculated based on the average scope change ratio of all the completed time intervals from the chart.

The average scope changes of the last x intervals - by choosing this option the scope forecast will be calculated based on the average scope change ratio of the most recent x completed time intervals from the chart.

A fixed scope change ratio of … - by choosing this option the scope forecast will be calculated based on a fixed change scope ratio, entered manually.

These settings affect the Forecast Scope series, as well as the other forecast series if the Consider the scope forecast when making the end date forecast is checked.

More Settings tab

On this tab you can configure the optional settings of the gadget.

...

Setting

Description

"Done" means

Specify how the gadget should consider issues as done when determining the work completed.

The default option is Issue status has the category done, which means that the issue is considered done if it has reached a “done” category status (such as Resolved, Closed, Done or any other green-colored status of Jira).

Choose Issue is in last column of the selected board and select an agile board if you want to consider issues as done when they reach the last column of the board or, more exactly, a status that is mapped to the last board column.

ChooseIssue is in one of these statuses, and then select one or more workflow statuses, to consider issues as done when they reach one of these custom statuses.Calculate the ideal series based on

Choose how the ideal series will be calculated. The current scope means that the Ideal Burndown line starts from a value that is the same as the current (latest) value of the Scope series, while The initial scope means that the Ideal Burndown line starts from a value that is the same as the value of the Scope series at the start of the release. You can also choose A fix scope value of and specify a number representing the total work estimate of the release. This third option is useful when you have a rough estimate of the total work but have not yet added all the corresponding issues or estimates in Jira.

Show legend

Check this if you want the chart legend to be displayed.

Display milestones

Check this option and enter the values (percentages of the planned release duration) corresponding to the milestones to be displayed. A past milestone will be displayed in red if the Remaining work at that time was higher than Ideal Burndown, or in green if it was lower, thus indicating if the milestone was reached or not. The future milestones are displayed in gray.

Continue to display data after release end date

Check this option if you want the chart to still display data even if the release date has passed. When this option is checked, the chart lines Scope, Remaining, Burned and forecast will continue after the release end date.

Display horizontal gridlines

Check this option if you want the chart to display gridlines for the vertical axis.

Enable scroll zoom

Check this if you want to be able to zoom in while scrolling with the mouse wheel over the chart.

Refresh cached data at next display

This gadget uses data caching for faster display, which means that some resulting data after processing is saved and reused the next time the gadget is loaded. If you check it, the cache of the gadget will be cleared and recreated on the next reload. This setting is not persistent.

Colors tab

...

On this tab you can customize the color of the lines displayed in the chart.

...

Setting

Description

Automatically assign colors

Check this if you want the chart to automatically assign colors for the series.

Custom colors

Select any custom color you want the series to be displayed on by either entering the color's hexadecimal code or picking a color.

You can also use the Copy and Import buttons to copy and import the color configuration to gadgets of the same type.

...