Cloud Migration Resources
Planning a Cloud migration? These resources can help you get started:
→ Dashboard Hub Cloud features – Review Cloud features and understand key differences between DC and Cloud.
→ Migration support from Appfire – Learn how we can help you migrate smoothly.
Jira Custom Charts
This page provides an example of how to use the Jira Custom Charts gadget in Dashboard Hub to build customized reports based on JQL.
Overview
The needs of Jira users vary across organizations. Users often need to run a JQL query in Jira to find relevant information. Custom Charts is a flexible, highly customizable gadget that displays the result of a JQL query or an existing filter, as a table or a chart. You can select a predefined filter or a custom JQL, then indicate how you want to display the results, the columns you want to display in your report and perform grouping and aggregations.
Example
To list all the work items in the Teams in Space project (project = “TIS”) in To Do (status = "TO DO"), sorted by CreationDate in descending order (ORDER BY created DESC) use the following JQL query:
project = "TIS" AND status = "TO DO" ORDER BY created DESC
Get started with JQL or have a look at the Advanced Search to master queries in Jira.
How to use the Jira Custom Charts gadget
This section explains how to add and configure the gadget.
To add the gadget to a dashboard:
Click Edit in your dashboard, then click Add Gadget.
Use the Search bar in the Add gadget page to find the required gadget.
Select the Jira Custom Charts gadget. The Add Gadgets page displays.
(optional) The name field is completed by default. You can edit the name to make it more meaningful to your team.
Select the datasource from where you want to retrieve work item statistics. To learn more about datasource types, see Datasources.
Use the filter options to limit the data you analyze; select a Jira filter or enter a JQL query, then click Load. If you don’t add any, the gadget will request all the content in the source instance; this might cause performance issues. We recommend adding at least one clause, for example, to list all the issues of the project Teams in Space use the clause
project = "TIS”. Remember that the gadget returns query results that are not fixed and can change over time.Select a view type to best visualize data. You can select any of the following visual formats to represent the resulting data of the JQL query: table, line chart, tile chart, pie chart, bar chart, grouped bar chart, stacked bar chart, or multi-line chart.
(optional) Depending on the view type you select, choose how to group the data. See the options in the next section for more information.
Click Add to save the configuration and add the gadget to your dashboard.
View types and groupings
Table
View the results of your JQL query as a table, where you can select which columns are displayed. If you select a table view type, there are additional options to consider:
The columns that will appear in the list to display the search results. At least one column has to be present. Drag to reorder the columns.
Group results by selected columns in case you want to group the results of the query by the previously selected columns. The resulting rows are split into groups, based on their values. Check the group results section.
The aggregations in case you need to perform calculations -Count, sum, max, min, mean- over the results. Check the aggregations section.
Calculated columns
In this field, you find columns that are not natively available in Jira as .
Customer Portal
This column provides a link for the referred issue to the corresponding Customer Portal link for users of the Customer Portal. This is useful when you share a dashboard with customers. See Manage access to the Jira Service Management Customer Portal) for more information.
Instead of
https://acme.atlassian.net/browse/ISM-12this column would link to
https://acme.atlassian.net/servicedesk/customer/portal/1/ISM-12Group results
Group results by selected columns: If you choose to group the results by the previously selected columns, the result rows will be split into groups, based on their values. Therefore, only one row will be displayed for each group.
For example, if we filter the previous list of issues by the column Status, the results will show only two rows, one for the status To Do and the other for the status Done.
If we select these three columns: Status, Assignee, and Project, the resulting list will display three rows, like in the following image:
The grouping of columns is typically combined with aggregations.
Aggregations
Aggregations are also common in the SQL domain. These functions get the values of grouped rows as input to that function to return a calculated value. This gadget currently supports five functions:
Count.: Returns the number of rows in that group.
Sum: Returns the sum of the sequence of numbers in the group.
Min: Returns the smallest value of the range of values of the group.
Max: Returns the largest value of the range of values of the group.
Mean: The arithmetic mean sums the values of the grouped rows and divides the result by the number of rows being averaged.
Show values (only in Tile charts): Displays the raw values of the returned range.
For example, if you want to calculate the mean of the story points:
1D Pivot Table
The 1D Pivot Table view provides a single-dimensional (1D) perspective on your data. In other words, one level of grouping is expressed when you select the value for the Rows field.
You can select a specific attribute or field to act as the basis for organizing and aggregating data. The resulting table presents a clear representation of the chosen dimension, summarizing key metrics and allowing for efficient analysis.
The elements of the 1D pivot table are as follows:
Rows (dimensions) :The selected row represents the Jira field used for grouping.
Aggregation: Aggregations get the values of grouped rows as the input of that function to return a calculated value. Check the aggregations section.
Field: The displayed field values depend on the chosen aggregation type.
View type: 2D Pivot table
The 2D Pivot Table view introduces a second dimension (2D) to expand on the capabilities of the 1D Pivot Table. Select 2 different (rows and columns) to cross-tabulate data to analyze data across both dimensions simultaneously.
The elements of the 2D pivot table are as follows:
Rows (dimensions): The selected row represents the Jira field that is used for grouping.
Columns (dimensions): The selected column represents the Jira field that is used for grouping.
Aggregation: Aggregations get the values of grouped rows as the input of that function to return a calculated value. Check the aggregations section.
Field: The displayed field values depend on the chosen aggregation type.
Chart
If you use a chart view type, there are additional options to consider.
The Chart by parameter to select the x-axis value, in other words, what you see in the horizontal axis. These values or concepts are indicated in the chart legend.
The Type parameter to indicate what type of aggregation you want to apply to the field parameter: Count, sum, max, min, or mean. Show values is only available for Tile charts. Check the aggregations section.
The Field parameter to select the y-axis values (vertical axis), think of what you want to count (or any other aggregation), and plot in the chart.
Chart by: Indicates the dimension or the x-axis values (horizontal axis), also referred to as the series, or in layman’s terms, the concepts we see in the legend of the chart.
Group by: The second dimension for grouped, stacked or multi charts.
Aggregation + field: The aggregation you want to apply to the field: count, sum, max, min, mean (see the aggregations section), to plot the values in the chart (y-axis or vertical axis).
Line chart
A line chart represents the results of your JQL query as a series of data points connected by a straight line. It’s common to visualize trends over periods or dates in the x-axis.
Multi line chart
This chart is a line chart with more than one line, which is useful when we need to compare data in a time series or trends.
Tile chart
This visual representation presents the information in a set of tiles. You can display the result of your JQL and apply aggregations. For example, you can display the number of requests of each request type of your Jira Service Management support desk, or display the sum of all the original estimates of the assigned issues, by assignee.
Bar chart
A bar chart represents the results of your JQL query as a series of rectangular bars with the height proportional to the represented values. It’s useful to compare results of different types or categories.
For example, Chart by assignee, type count, and field issues would display a chart where each assignee would display the number of assigned issues:
Grouped bar chart
We can perform more complex comparisons of the information returned by our JQL query by grouping by specific . In the previous example, we could add a Group by status, and we’d see the number of issues by assignee grouped by the issue status:
So for each category, in our case, the Chart by Assignee, there are two or more colored bars, whose labels can be seen at the top of the chart.
Stacked bar chart
Similar to the grouped bar chart, but in this case, the combined results of the groups are on top of each other. Thus, the height is the combined result, making it not appropriate for cases with negative values.
Pie chart
A pie chart is a visualization of your data in a circular graph, where each slice indicates the quantity of the result of your JQL. When a pie chart has several sections or slices, it’s difficult to compare one with another. To overcome this inconvenience, the pie chart comes with a table indicating the values of each slice and the % it represents.
When the field selected in “Chart by” has a date format e.g., Created, a new selector appears to allow grouping by day, week, month, quarter, or year, making the results easier to understand and communicate.
Multi pie chart
This chart adds one more dimension to the pie chart, so users can compare sets of information within a single chart. Just add a new field to the “Group By” to display the values in the second ring.
Area chart
An area chart is a visualization that represents the results of your JQL query as a series of data points connected by a straight line and filled with a colored area beneath it, which can help emphasize the magnitude of the values being represented. An area chart is often used to show trends over time or categories, as well as to compare multiple series of data.
Stacked area chart
A stacked area chart is a variation of the area chart in which the areas are stacked on top of each other rather than overlaid. Each stack represents a category or group, and its height indicates the group's total value. It's useful for showing each group's relative contribution to the total, as well as for tracking changes in the total over time. However, stacked area charts may not be suitable for displaying negative values, as they can become difficult to read.
Supported field types
Jira built-in system fields
Custom field types
The list of available custom fields is pulled directly from your connected Jira instance. Only supported custom field types appear in the selection menu.