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 started 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-080604.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-080633.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-080644.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.

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 the "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-080718.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 in the "Done" status for the first time.

Cycle time ending in the first transition to DoneImage Removedimage-20240618-080729.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 in the "Done" status for the last time.

Cycle time ending in the last transition to DoneImage Removedimage-20240618-080739.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 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-080753.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-080805.pngImage Added

Display data until:

Specify the date until the data is displayed. You can choose between:

This date (recommended): - The time intervals will be aligned with the specified date.
Previous day (end-of-day) - the data will be displayed until the end of Yesterday without the need to manually enter a date.

Interval duration

Specify the duration (in weeks) for the time intervals used when calculating and displaying the average time.

Display the data for ? intervals back

Specify the number of time intervals to be displayed in the chart relative to the date specified at "Display data until".

...

Setting

Description

Calculate in

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

Series to Display

Choose what series to display in the chart. You can select one or more options:
Average Cycle Time - displays the average cycle time for each time interval in the chart.
Trendline - displays a line on the chart that reveals the overall direction of the data. The trendline can be:

  • Linear - a best-fit straight line that shows if the average cycle time is increasing or decreasing at a steady rate.

  • Polynomial - is a curved line determined based on an order 2 polynomial formula, which is recommended when the data fluctuates.

Don't count weekends

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

Show the Overall Average Cycle Time, calculated as the average of the last ? intervals

Check this option and specify a number of intervals, if you want the chart to calculate and display the overall average.

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, for every time interval in the chart, 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-080840.pngImage Added

Display horizontal gridlines

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

Refresh cached data at next display

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

 

...