Controls
- 1 Overview
- 2 Use
- 2.1 Report on
- 2.2 Report type
- 2.3 Compare to
- 2.4 Filters
- 2.4.1 Filters Summary
- 2.4.2 [Report on] Statuses
- 2.4.3 Hide [Report on] without dates
- 2.4.4 Releases
- 2.4.5 Limit to SemVer releases only
- 2.5 View settings
- 2.5.1 View Settings Summary
- 2.5.2 Sort By
- 2.5.3 Group By
- 2.5.4 Round Dates To
- 2.5.5 Show Completion Percentages
Overview
Controls allow you to modify what parts of your JQL is reported on.
Use
Before modifying your report with the controls, you must add reporting data by adding primary JQL to the sources tab.
Report on
Report on allows you to specify which level of your issue hierarchy is reported on. The highest level of the issue hierarchy is selected by default. To change which level is reported on click the dropdown under “Report on”:
Select the level you want to report on:
You may also want to report on released versions of your issue hierarchy, to report on releases, hover over “Releases”:
Select the level you want to report on:
Report type
The report type control allows you to change which type of report you’d like to create. To change the report type, select the drop-down under ”Report type”:
Click the report type you’d like to create:
Compare to
The compare-to control allows you to compare the present reported data to its past state. You can select the data you want to compare using a slider or the date picker. The difference between the slider and date picker is the if you use the date picker, it will always compare to that date. If you use the slider, the comparison will be relative to the current date. For example, say you set it to a date 2 weeks ago. If you come back 2 weeks later, it will compare to two weeks from the present, but now it’s been 4 weeks since the initial comparison.
To compare to a date using the slider, click the slider control:
Slide to the moment in time you want to compare to:
To use the date picker, click the date input next to “Compare to”:
Select the date you want to compare to:
Filters
The “Filters” control allows you to add filters to the reported-on data. Filters are specific to the “Report type” and reported-on Data (“Report on”).
To access filters, select “Filters”:
Select the filters you want to apply:
Below is a summary of the filters and when they can be selected which report types.
Filters Summary
Below is a summary of each of the filters; a more in-depth look at each is in the following sections.
Filter | Description | Report Type | Report On |
---|---|---|---|
[Report on] Statuses | Allow you to select which reported issue level status to either include or exclude. |
|
|
Hide [Report on] without dates | Allows you to filter out any issues on the reported-on issue hierarchy level without properly set start and end date fields. |
|
|
Releases | Allows you to choose which releases to include in the report |
|
|
Limit to SemVer releases only | Allows you to include only releases that follow a SemVer format. |
|
|
[Report on] Statuses
Supported report types |
|
Supported report on |
|
“[Report on] STATUSES” allows you to select which reported issue level status to either include or exclude. For example, to filter outcomes by including only those with the “Development” status, you’d set:
Report on: Outcomes
Filter: Show Only - Development
Conversely, if you wanted to report on all the outcomes that are not in development, you’d set:
Report on: Outcomes
Filter: Hide - Development
Hide [Report on] without dates
Supported report types |
|
Supported report on |
|
Hide [Report on] without dates allows you to filter out any issues on the reported-on issue hierarchy level without properly set start and end date fields.
For more information on how to set date fields for Status Reports, see Global Teams Configuration.
To filter out issues without dates, click “Filters”:
Click the toggle labeled “Hide [Report on]s without dates”:
Releases
Supported report types |
|
Supported report on |
|
The “RELEASES” filter is only available if you are reporting on a release and lets you choose which releases to include in the report.
To select which releases to include, click “Filters”:
Click the releases drop-down:
Select the releases to include:
Limit to SemVer releases only
The “Limit to SemVer releases only” filter is only available when reporting on release, and it lets you include only releases that follow a SemVer format.
For more information on SemVer, see the official specification.
To only include SemVer Releases, click “Filters”:
Click the toggle labeled “Limit to SemVer releases only”:
View settings
The “View settings” control the appearance of your report, enabling you to group, sort, round, and customize your data in various ways. View settings are specific to the Report Type.
To access your report’s view settings, click “View settings”:
Select the view setting you want to change:
View Settings Summary
Below is a summary of each view setting; the following sections provide a more in-depth look at each.
View Setting | Description | Report Type |
---|---|---|
Sort By | Allows you to control how the report data is sorted |
|
Group By | Allows you to control how your report is grouped |
|
Round Dates To | Allows you to round the start and end dates of the issues on the reported level |
|
Show Completion Percentages | Allows you to choose whether or not to include a percentage for how close to completion whatever you are reporting on is |
|
Sort By
Supported report types |
|
The “SORT BY” View setting allows you to control how the report data is sorted. There are two options:
JQL Order (default): Issues will be sorted according to the order returned by the JQL query.
Due Date: Issues will be sorted by the nearest upcoming due date.
Sort by: JQL Order
Sort by: Due Date
To change the “SORT BY” view setting, click “View settings”:
Click the “SORT BY” drop-down:
Select the “SORT BY” option:
Group By
Supported report types |
|
The “GROUP BY” View setting allows you to control how your report is grouped. The Group view setting is only available in the Gantt Chart for non-release reporting. There are three options:
None (default): No grouping will be applied
Parent: Issues will be grouped under their parent issue
No parent will be shown if you are reporting on the highest level of your issue hierarchy.
Team: Issues will be grouped by their team
To change the “GROUP BY” view setting, click View settings:
Click the “GROUP BY” drop-down:
Select the “GROUP BY” option:
Round Dates To
Supported report types |
|
The “ROUND DATES TO” view setting allows you to round the start and end dates of the issues on the reported level. There are five rounding options available
Day (default): Rounds to the nearest day
Week: Rounds to the nearest day
Month: Rounds to the nearest day
Half Quarter: Rounds to the nearest day
Quarter: Rounds to the nearest day
To change how your report rounds dates, click “View settings”:
Select the drop-down by “ROUND DATES TO”:
Select the rounding option you want:
Show Completion Percentages
Supported report types |
|
The “Show completion percentages” control allows you to choose whether or not to include a percentage for how close to completion whatever you are reporting on is.
Disabled (default)
Enabled
To enable or disable “Show completion percentages,” Click “View settings”:
Select the toggle labeled “Show completion percentages”: