Report Usage

This report comes in the form of a line chart report. It provides a snapshot of the team's progress in completing the planned work and achieving goals in set terms. The report has two lines - guideline and actual line to compare the actual progress to the expected one. On the Y-axis user can see the metric value and on the X-axis user can see the Start and End date.

Open

Specific functionality:

• This report gives information about the project status. Whether it is On track, Off track, or At risk.

• For Story points and Issue count:

  • If we have less than 85 - 89% issues/story points completed - At risk.

  • If 90 - 100% of issues/story points completed - On track.

  • If we have less than 85% - Off track.

• For Remeining estimate:

  • Off Track: If the remaining estimate completion is less than 85%.

  • On Track: If the remaining estimate completion is more than 90%.

  • At Risk: If the remaining estimate completion is in the range of 85-90%.

Open

• While hovering the line tooltip appears. It shows the selected date (one the user is hovering over), guideline (showing the planned amount of completed values till the chosen moment), and unresolved value (amount of left values till the set due date).

• Labels on the line can be added and removed. While they are added the user can see the number of tasks created or resolved at a certain moment.

• The report is built considering all issue types.

Setting up a report

The report has 4 tabs of configurations: Data source, Parameters, Display, Description.

Data source

Configure and manage the source of data for generating reports.

Project select

The Project field is required. It lets the user choose from which project issues will come from. By default, it is set as a project where the app was opened.

Component(s) lets the user choose component(s) of a project which lets the user get the tickets related to it.

Board select

The Board field is required. It lets the user choose the Sprint board.

The Sprint field is required. It lets the user choose Sprint related to chosen Sprint board.

Version select

The Version field is required. It lets the user select the tickets related to a certain version.

Saved filter select

The Saved filter field is required. It lets the user filter issues by existing filters.

JQL filter

The JQL field lets user filter issues by using JQL requests. The report uses Atlassian’s JQL component so it has syntax checking and auto-complete implemented. When the user finishes inserting the JQL the user can validate the JQL using the button underneath the input. Number of issues is clickable. By clicking, the user is redirected to the page with a list of issues in the Jira project.

Parameters

Allow users to tailor the report to their specific needs and preferences.

Duration field is required. There user can choose a start and end date in a datepicker. Out of this will be defined a timeframe for the report. The minimum timeframe can be 2 days, maximum - 2 months.

Some specifics about duration in case of choosing Sprint in DataSource:

• If there is a start date and end day set for Sprint, they will be automatically set in the duration field.

• If a custom duration is selected, the start date and end date will be taken only if they have been specified in Sprint.

Some specifics about duration in case of choosing Version in Data Source:

• If the Version has a start and end date it will be set in Duration fields.

The Metric field is required. It lets the user choose the metric of the key performance indicator by which the report will be calculated. For example: Issue count, Story points, and Remaining estimate. The default value for this field is Issue count.

The Include weekends toggle provides the user the possibility to include or exclude weekends while building a report.

Display

Manage the visual appearance and presentation of the report, including the visibility of specific elements and the formatting of data.

The Show label toggle enables/disables the dots that indicate a chosen period value.

Description

It serves as a space where users can provide context, explanations, and additional information about the report.

Description lets the user add any additional information no more than 500 characters about the created report.
The description will be presented directly on the report card (in case of its presence).