Contents:
Table of Contents | ||
---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
Custom values are user-defined outputs used in rich filter gadgets and time series, just like the built-in values. The custom values add new options for value display (label, color, formatting) and support for total formulas (sum, average, min, max). They can be based on issue count, numeric & time tracking field values, or computed duration (resolution time & issue age). Also, the scope of the custom values can be further refined using JQL sub-queries.
...
Attribute | Description | ||
---|---|---|---|
Label | The label is mandatory. It is used to identify and display custom values in rich filter gadgets and time series. | ||
Color | Optionally, you can set a custom color to display the value in some of the rich filter gadgets. | ||
Base value | Select the value on which your custom value is based. Your custom value can be based on:
| ||
Value type | The value type is automatically computed based on the Base value you have chosen. The value type helps you to easily understand the compatibility with Time Series (see Using Custom Values in Time Series below). The possible value types are:
| ||
Total formula | The total formula is used when displaying totals for the custom values. Possible options are sum, average, minimum, and maximum values. | ||
Decimals | The number of decimals to be displayed when formatting numeric values: Maximum 3, Maximum 2, Maximum 1, None, Exactly 3, Exactly 2, Exactly 1.
| ||
Show thousands separator | If this checkbox is checked, the numeric values are displayed using a thousand separator (based on the user's locale). | ||
Value display | This setting allows you to choose how to display time-tracking values. The available options are:
| ||
JQL filter | You can optionally use a query to restrict the definition of this custom value to only a subset of issues. The custom value will be empty for the issues that do not satisfy this query. |
...
To do the following: | Do this: |
---|---|
Edit a Custom Value | Click the edit icon at the right of any custom value. A dialog appears. Make your changes and click on the Save custom value button. Note that once a custom value is created, there is one setting that cannot be changed anymore – the Value Type. This means that if you have selected Issue Count as the base value, you cannot change it anymore. If you had selected, for example, a number field as the base value, then the value type would be Numeric. You could then update the Base value and select another number field, but you could nod choose Issue Count anymore (the value type would have to remain Numeric). This is necessary to ensure the consistency of custom values with time series once used in the Rich Filter Time Series Chart gadgets (see Using Custom Values in Time Series below). To change the Value Type, you You need to create a new custom value to change the Value Type. |
Delete a Custom Value | Click the delete icon at the right of any custom value. |
Reorder the Custom Values list | Hover over the vertical “grid” icon of the custom values, then drag and drop up or down to the new position. This order is applied when displaying the custom values in the settings of the rich filter gadgets and the time series where they can be used. |
...
Calculated custom values are a special case of custom values having a computed base value. Rich Filter for Jira Dashboards provides two calculated custom values , that represent time duration:
Issue age / resolution time - predefined duration value calculated as the time elapsed between the resolution time (or now for unresolved issues) and the created date
Custom duration - duration value calculated as the time elapsed between any two date/date time fields or between a date/date time field and now
...
Tip |
---|
Lead TimeYou can combine the Issue age / resolution time base value with JQL sub-queries to build custom values that show only the resolution time or only the issue age. For instance, if you wish to see the lead time of your resolved issues, you can add the JQL query resolution that is not empty to your custom value definition and use the average total formula. Your custom value will show the average resolution time of your resolved issues – called the Lead Time. |
Anchor | ||||
---|---|---|---|---|
|
...
Custom duration
Custom duration is a computed duration value, calculated as the time elapsed between any two date/date-time fields or between a date/date-time field and now. To create a custom value based on a custom duration, select the Custom duration option in the Base value drop-down menu. Next, select the Start time and End time, which can be a date/date-time field or the Current time.
...
Anchor | ||||
---|---|---|---|---|
|
...
Using custom values in Rich Filter Gadgets
Once defined, custom values can be used in rich filter gadgets the same way built-in values are. The gadgets display the custom values taking into account considering their attributes – label, color, total formula, value display (for time tracking fields) and JQL filter.
...
Learn more: Rich Filter Smart Counters Gadget.
Info |
---|
If the smart filter has a color tag type, |
...
each value is displayed using the colors |
...
defined in the smart filter clauses. If the smart filter does not have a color tag type, |
...
the color of the custom value (if defined) is used to display the values. |
The Rich Filter Statistics gadget
Learn more: Rich Filter Statistics GadgetThe Rich Filter Two Dimensional Statistics gadget
Learn more: Rich Filter Two Dimensional Statistics Gadget.
The Rich Filter Results gadget
Learn more: Rich Filter Results GadgetInfo When displaying custom values in rich filter results, if the view is configured to display totals for value rows, then the Total formula is used when computing the total displayed in the footer of the view.
Tip |
---|
The Value display setting can |
...
conveniently display your time-tracking fields in days, hours, minutes, or seconds. The same setting is applied when exporting the custom values to Excel! |
Anchor | ||||
---|---|---|---|---|
|
Once defined, the custom values can also be used in Time Series. If you're not already familiar unfamiliar with Time Series, you should first have a look at our Configuring Time Series section.
When creating or editing time series, you can chose to use your custom values as value.
...
The time series will have the same value type as the custom values on which they are based on. For instance, if your custom value is Numeric type, then your time series will also have the same value type, too.
Like any other time series, the time series based on custom values can be displayed as line charts with the Rich Filter Time Series Chart gadget or as tables with the Rich Filter Statistics gadget.
...