Versions Compared

Key

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

...

The settings of this gadget are divided in 2 3 tabs:

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

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

  • Colors tab

Data tab

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

...

Setting

Description

Gadget Title

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

Data source

Select the type of Data Source used by the gadget:

  • TheagileBoard of your team.

  • A Saved filter containing the issues for which you want the metrics to be calculated. Make sure that the specified filter is shared with the users who will also visualize this gadget. Check Include the sub-tasks if you want the sub-tasks from the selected board, filter or JQL to be included in the calculation.

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

Cycle starts

Indicates what to consider as the start event of a cycle.

You can choose between:

  • When the issue was created

  • When the issue entered a status that has category "New" - the cycle starts when the issue was transitioned to any workflow status of category "New". This includes those gray-colored statuses from Jira, like New, Backlog or To Do.

  • When the issue entered a status that has category "In Progress" - the cycle starts when the issue was transitioned to any workflow status of category "In Progress". This includes those blue-colored statuses from Jira, like In Work, In Progress or In Testing.

  • When the issue entered this status - cycle starts when the issue was transitioned to the specified workflow status.

Choose also how to handle the case when there are multiple transitions to the start status or to the status category by setting If multiple entries in the start status, consider the ? entry to first or last. See the example below.

Example
You configured the gadget to start the cycle When the issue entered a status that has category "In Progress" and to end the cycle When the issue entered a status that has category "Done" and there was a Jira issue that had multiple entries in the "In Progress" status before being moved to "Done". How should the cycle time be calculated, from the first or from the last transition in the "In Progress" status?

Workflow with multiple entries in In Progress statusImage Removedimage-20240618-081002.pngImage Added

If you set If multiple entries in the start status, consider the first entry, the cycle will start when the issue was transitioned in the "In Progress" status for the first time.

Cycle time starting from the first transition to In ProgressImage Removedimage-20240618-081018.pngImage Added

If you set If multiple entries in the start status, consider the last entry, the cycle will start when the issue was transitioned in the "In Progress" status for the last time.

Cycle time starting from the last transition to In ProgressImage Removedimage-20240618-081032.pngImage Added

Cycle ends

Indicates what to consider as the end event of a cycle.

You can choose between:

  • When the issue entered a status that has category "Done" - the cycle ends when the issue was transitioned to any workflow status of category "Done". This includes those green-colored statuses from Jira, like Done, Resolved or Closed.

  • When the issue entered a status that has category "In Progress" - the cycle ends when the issue was transitioned to any workflow status of category "In Progress". This includes those blue-colored statuses from Jira, like In Work, In Progress or In Testing.

  • When the issue entered this status - the cycle ends when the issue was transitioned to the specified workflow status.

  • When the issue entered its current status

You can also choose how to handle the case when there are multiple transitions to the end status by setting If multiple entries in the end status, consider the ? entry to first or last. See the example below.

Example
You configured the gadget to start the cycle When the issue entered a status that has category "New" and to end the cycle When the issue entered a status that has category "Done" and there was a Jira issue that had multiple entries in "Done". How should the cycle time be calculated, till the first or till the last transition in the "Done" status?

 

Workflow with multiple entries in the Done statusImage Removedimage-20240618-081112.pngImage Added

If you set If multiple entries in the end status, consider the first entry, the cycle will end when the issue was transitioned to the "Done" status for the first time.

Cycle time ending in the first transition to DoneImage Removedimage-20240618-081126.pngImage Added

If you set If multiple entries in the end status, consider the last entry, the cycle will end when the issue was transitioned to the "Done" status for the last time.

Cycle time ending in the last transition to DoneImage Removedimage-20240618-081136.pngImage Added

Multiple cycles

Decide how the gadget should handle those Jira issues that have multiple cycles. This situation occurs if the issue was transitioned multiple times through the start and the finish statuses of the cycle.

Example
You configured the gadget to start the cycle When the issue entered a status that has category "In Progress" and to end the cycle When the issue entered a status that has category "Done" and there was a Jira issue that was moved from "In Progress" to "Done" multiple times, so it had multiple cycles. What cycle do you want to be displayed?

An issue with multiple cyclesImage Removedimage-20240618-081147.pngImage Added

You can choose between:

  • Display all cycles - all the cycles will be displayed with their own dot in the plotting chart and their own entry in the data table.

  • Display only the first cycle - only the first cycle of the issue will be displayed, with all the others being ignored

  • Display only the last cycle - only the last cycle of the issue will be displayed, with all the others being ignored

  • Display as one cycle from the start time of the first cycle to the finish time of the last cycle - a single cycle will be displayed, having as the start time the moment when the first cycle started and as the finish time the moment when the last cycle ended. See the picture below.

 

An issue with a cumulative cycle.Image Removedimage-20240618-081158.pngImage Added

Time interval

Specify the time interval for which to display data. You can specify a fixed time interval or a number of days back relative to the current date, with the current day being included.

...

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

...

Setting

Description

Calculate in

Specify in what time unit measure the results will be displayed.

Don't count weekends

Check this option if you want to exclude the weekends (Saturdays and Sundays) from the cycle time calculation.

Display average line

Check this option if you want the chart to display a line with the average cycle time for the specified time interval.

Display rolling average line and standard deviation

Check this option if you want the chart to display the rolling average line, which allows visualizing the trend, along with the standard deviation that allows identifying the outliers. You must also specify the odd number of X issues representing the window used for calculating the rolling average and the standard deviation. The rolling average and standard deviation are issue-based, not time-based. For every issue shown on the chart, the rolling average and the standard deviation (at that point in time) are calculated by taking the issue itself, X/2 issues before the issue and X/2 issues after the issue, then averaging their cycle times. For example, if you choose to calculate based on a 15-issues window, the calculation will be based on the issue itself, with 7 issues to the left and 7 issues to the right.

Display threshold line

Check this option if you want the chart to display a line representing a threshold. The issues that have a cycle time higher than the specified Threshold value will be colored in red.

Display percentile lines

Check this option and enter the values (percents) corresponding to the percentiles to be displayed. A percentile is a value from the data set that splits the data into two pieces: the lower piece contains the percent of the data, and the upper piece contains the rest of the data. For example, the 75% percentile will be displayed as a horizontal line with 75% of the issues under it and the rest of the issues (25%) over it.

Use logarithmic scale for the vertical axis

Check this option if you want the chart to display a logarithmic scale instead of a linear scale for the Y axis.

Show legend

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

Show data table

Check this option if you want a data table to be displayed along with the chart. The Data tab displays the issues along with their cycle time details and the average calculation.

The Data tab showing the issues along with their cycle timeImage Removedimage-20240618-081226.pngImage Added

Colors tab

...

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.

...

The following blog articles provide more information on how to use this gadget.