This user guide will help you understand how to navigate and utilize the pre-made reports available in the Gallery. Please note that this guide does not cover the functionality of the Universal Report. For information on the Universal Report, please refer to the Universal Report Guide.
The process on how to use the ready-to-go reports (templates) is explained below:
Let’s go through the process step-by-step.
Choosing template
You can choose a template by browsing the Gallery using the search tab, or by listing all available reports, including beta versions. Refer to this guide to learn how to configure the Gallery for a smoother process.
For example, let's say you select the "Created vs. Resolved" report. To choose this report, left-click on the report icon, as shown on a screenshot below:
When the choice is done, simply click with left mouse button on the report icon.
Filling in Parameters
In this context, parameters define the data scope that we intend to retrieve from Jira. You can set these parameters either through JQL or a pre-defined user input form. To start defining parameters, click "select" as shown on a screenshot below:
A form will appear where you can enter filters for Project, Epics, and Issue or apply filters defined by you and other Jira users. You can also set parameters to collect data beyond the selected filters.
For instance, if you limit your data scope to a single issue and enable the "Include parent issues" checkbox, your fetched data will also include the parent issue. If you enable the "Include child issues" checkbox, it will include any child issues.
The form itself is presented on a screenshot below:
If you prefer, you can click "Switch to JQL" to enter your JQL expression directly.
Fetching Data
Once you've defined your parameters, the Report Builder performs an initial data fetch to display the data chunk you are requesting from Jira, as shown below on a screenshot:
The Report Builder accurately shows how many items (tasks) are included in your data request. To confirm your data request, click the "Apply filtering" button as shown on a screenshot below:
Each time you click the "refresh" button, the data is fetched according to the set parameters.
However, you can skip this step and proceed with further report configuration if you wish.
Some reports allow you to modify the initial data score. For the chosen report, the "Days previously" field dictates how far back the data is gathered:
Selecting calculation methods
While the core calculation methods for Gallery reports are hidden from the user interface, you can still apply simple pre-defined rules to compute the report outcomes. These may include basic aggregation rules (minimum, maximum, average, etc.), date grouping rules (by days, weeks, etc.), or specific ticket skipping rules.
For the chosen report, you can select how to aggregate data around dates as shown on a screenshot below:
Different methods may be available for other reports.
Selecting visualisation options
While Gallery reports come with pre-defined visuals, you can make some visualization changes. For instance, in our chosen report, you can select the color scheme:
Other reports may offer different visualization tools.
Formatting and rendering the report
A few formatting options are typically available:
Show Data Table: Enables you to review the chart data in a table format.
Show Report Sources: Presents the entire set of gathered data in a table format.
To enable these options, click on the corresponding checkboxes as shown on a screenshot below:
Finally, to render the report, click on the "refresh" button (as mentioned in the Fetching Data section). Your gathered data will be presented, and the report will be rendered as shown on a screenshot below:
Please also notice the data table and report sources are available as shown on a screenshot below:
After Report Generation
That’s it! you can now save the report to your dashboard using “Add to my reports“ button, edit the report permissions as described in this guide, export the report as described here, or add it to the dashboard as per this article.