Report Usage

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

Specific functionality:

• This report gives information about 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 completed - At risk.

  • If 90 - 100% issues completed - On track.

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

• For Work ratio:

  • Off Track: If the work ratio is above a certain threshold, it indicates that the project is falling behind schedule. You might set a threshold like 120%, meaning if the work ratio exceeds 120%, the project is considered off track.

  • On Track: If the work ratio is within an acceptable range, the project is on track. This range could be, for example, between 89% and 120%.

  • At Risk: If the work ratio is below a certain threshold, it indicates that the project may be at risk of not meeting its targets. This threshold could be, for instance, 89%.

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

Setting up a report

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

Data source

In this tab we can choose to get issues either by project, sprint, version, saved filter or JQL.

Project select

“Project“ field is required. It lets the user choose from which project issues will come from.

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

Board select

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

“Sprint“ field is required. It lets user choose Sprint related to choosen Sprint board.

Version select

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

Saved filter select

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

JQL filter

JQL field let user filter issues by using JQL requests. Report is using atlassian’s JQL component so it has synax checking and auto complete implemented. When the user finishes inserting the JQL the user needs to validate the JQL using the button underneath the input. Number of issues is clickable. By clicking, user is redirected to the page with list of issues in Jira project.

Parameters

In this tab user have to set up “Duration“, “Metric“, “Include weekends“.

"Duration“ fields are required. There user can choose a start and end date in a datepicker. Out of this will be defined duration. Datepicker also contains a dateswapper, allowing the user to quickly switch months. Minimum timeframe can be 2 days, maximum - 3 months.

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

• If there is a start date setted for Sprint and a duration (except for custom)  the end day will be calculated based on them.

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

• In case if dates haven`t been specified, user has to select them in Duration fields.

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

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

• If the Version has a start date and the end date is absent, in duration field will be shown the start date. In that case user have to specify end date.

• If the Version has an end date and the start date is absent, in duration field will be shown the end date. In that case user have to specify start date.

“Metric“ field is required. It lets user choose the metric of the key performance indicator by which report will be calculated. For example: Issue count, Story points, Work ratio.

“Include weekends” toggle let user possibility to include or exclude weekends while building a report.

Parameters

In this tab user have to set up “Period“, “Show label“.

“Period“ lets user select the time unit to customize the displayed data on the report. By default it setted as days.

Some specifics for choosing period:

• If user select days, it will be shown as week day and date. An example: Fri, Jan 12.

• If user select weeks, it will be shown as first day of week - last day of week. An example: Jan 1 - Jan 7.

• Weeks period can be chosen only for duration more than 21 days and for number of days that is a multiple of 7.

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

Description

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