1.Description
Time in Status allows you to report the time spent on each status or each assignee by filtering the search criteria as user, project or custom filter regarding your own choice. You can create your report based on 7/24, business hours or business days. Also you can add the fields or statuses which you want.
The plugin is designed to generate reports that can be analysed to inspect the time expenditure of statuses/assignees in issues and identify bottlenecks.
2.Installation
To install Time in Status, follow these steps:
- Log in as a user with the JIRA Administrators.
- Select Add-ons from the Administration menu at the top right of your screen.
You can install the Add-On in two ways : Install the Add-On from Marketplace or Upload an Add-On.
Upload an Add-On:
- Click the Manage Add-ons link. Picture 1
- Click the Upload Add-on link at the top right side of the page.
The 'Upload Add-on' dialog appears. - Locate the Time in Status plug-in
- Upload the .jar executable file that you have downloaded from the Atlassian Marketplace.
Picture 1 Install the Add-On from Marketplace:
- Click the Find New Add-ons link.
- Enter Time in Status in the Search the Marketplace box.
- To install the add-on, click the Install button for free add-ons or the Buy Now or Free Trial buttons for paid add-ons.
3.Configuration
How to Configure
- Click Settings >> Add-Ons.
- Click Time in Status Settings.
- Select the User Groups that are allowed to access the report and move to the list on the right. If you want all groups to access the report, check Everyone can access.
- Select the User Groups that are allowed to access exporting the report as excel format or as a printed version and move to the list on the right. If you want all groups to access the access exporting the report, please check Everyone can access.
- Export permission is available as a separate permission because taking exports might be hard on the server if you have a large number of issues and/or long issue histories.
- You can configure Business Days for the your company's working days. Selected days will be used to calculate business days if report is prepared for Business Hours calendar.
- You can configure Work Hours for the working time interval of your company. Selected hours will be used to calculate business hours if report is prepared for Business Hours calendar.
- You can add date with or without description which can be applied every year.The days entered here, will be processed as holidays so will not be included in durations when report is prepared for Business Hours calendar.
- Click Save Settings.
4.Time in Status Reporting
In order to examine Time in Status reports: Click the Time in Status tab on the ribbon bar which will automatically appear after you successfully install Time in Status
4.1 Report Parameters
1. Report Type drop-down lets you select the report-type which counts as a filtering for your search criteria.
- User type creates reports including the issues are the ones that have been assigned to the certain user in the "Assignee" field at a specific time throughout that issues' lifecycle.
- Project type creates reports according to issues that are included in a certain JIRA project.
- Advanced type creates reports based on a filter of your own choice.
2. Regarding your choice, write a Project, User or Filter name under the report type.
3. Statuses section lets you select statuses which will be included in the report.
Custom fields
Time in Status also supports custom fields. Checked custom fields from the "Fields" section will be included in the report.
5. Time Period field allows you select the report date interval. You can select if this interval will be based on issue creation date, update date or resolution date.
6. You can create a report based on Status or Assignee.
- Status: The amount of time passed on each status will be shown in the report.
- Assignee: The amount of time passed on each assignee will be shown in the report.
7. You can create a report based on 3 different calendars: 7/24, Business Hours, Business Days
- 7/24 creates reports for 7/24 time schedule. Note that every time of the day is included in this sort of report.
- Business Hours creates reports based on business hours (which can be configured in plugin configuration page) and one day is 24 hrs long
- Business Days creates reports based on business hours (which can be configured in plugin configuration page) and the duration of one day is defined in plugin configuration page (usually 8 or 9 hours)
Business Hours and Business Days reports produce the same output for durations shorter than one business day. For longer durations things change: For example a 4h duration is same for both report types but 25h for a 7/24 report is 1d1h for a Business Hours report and 3d1h for a Business Days report. (presuming an 8 hr work day)
8. You can select the display format of values. For example for a duration value of "5 days 18 hours 54 minutes 45 seconds", each option shows these values:
- Basic: 5 d 18 h 54 m 45 s
- DD:HH:mm:ss: 5:18:54:45
- HH:mm:ss: 138:54:45
- Days: 5.79
- Hours: 138.91
- Minutes: 8334.75
- Seconds:500085
9. When you finish to select all parameters, your report is now ready.
Issue Based / Issue Type Based
Deleted Statuses
Time in Status also handles deleted statuses and their time calculations automatically. It shows deleted statuses(if any) as shown below. Note that this feature is valid if a status is deleted from "Administartor>Statuses" in the system menu. Deleting a status from a workflow is different situation. In this case, deleted statuses are not shown in the report.
Including durations for statuses
Note that durations for unselected statuses are not included in the report.
Changed usernames in JIRA
The plugin also handles the case that if an username is changed by a system admin the current (changed) username will be shown in the report.
4.2 How the data is calculated?
4.2.1 Filtering
Time in Status calculates report data by first filtering issues based on your report type:
- User report type filters issues assigned to the selected user (currently or in the past) so it runs a filter like "assignee was john.doe"
- Project report type filters issues in the selected project. Filters like: project = ABC
- Advanced report type uses the filter you select from the drop down.
The report goes through each issues current data and history.
The date interval is filtered according to create dates of the issues.
Please note that, the User report type also has a specific case, it does not simply filter issues based on user, it only shows the durations for that user for the selected statuses.
4.2.2 Columns By
For status based reports status changes and durations between those status changes are collected from each issues history and displayed to you in columns. If the issue was in the same status more than once in its workflow then the total duration will be displayed in that status column.
For assignee based reports the same calculation takes place but this time assignee changes are inspected instead of status changes. Once again, if the issue was assigned to the same person more than once in its workflow then the total duration on this individual will be displayed in that column.
Please note that, if you exclude some statuses from the report (by unselecting them from Statuses button menu) the behavior will be different for Status or Assignee based reports. For Status based reports, unselected status columns will simply disappear from the report. For assignee based reports the time spent on those statuses will be excluded from the report so probably the report will show the same number of people (in columns) but will display shorter durations since time spent on some durations are excluded. If the some person was the assignee of the issue only on some status that was excluded from the report then his/her column would disappear altogether since s/he has no time for the included statuses.
4.2.3 Calendar
For 7x24 calendar reports, realtime durations will be used to calculate the durations. This means if the issue transitioned to status Open at 13:00 and was transition to In Progress at 11:30 of next day, then a 7x24 report will show a duration of 22 hours and 30 minutes for Open status.
For Business Hours calendar reports, only business hours count. Business Hours definition can be configured through admin screens. Let's say your business hours are set for 08:00 to 17:00, Monday through Friday. If the issue was transitioned to Open at 16:30 on Friday and was transitioned to In Progress at 09:00 of next Monday, then a Business Hours report will show 1 hour and 30 minutes for the open status. If the issue changes status outside business hours then it calculates as if the former status was completed at the end of business day and the latter status begun at the beginning of the next business day. The same rules apply for assignee based reports of course.
4.2.4 Averages
IssueType based averages are calculated by simply taking arithmetic averages of durations. (Available in Excel export or IssueType based grouped report)
5.Time in Status Print Version & Excel Report
You also have the option to export the report as an Excel format.
Values are exported to Excel with the format they are displayed on screen, (like HH:mm:ss, etc...)
6. REST API
It is possible to access report data via REST call to a JIRA endpoint introduced by Time in Status. The parameters of the REST call correspond to Time in Status report parameters explained above.
Rest Call Format
The rest call should be made in the following format
<base_url>/rest/tis/report/1.0/<format>?reportType=<reportType>&<selection>&columnsBy=<columnsBy>&fields=<fields>&statuses=<statuses>&startDate=<startDate>&endDate=endDate&dateType=dateType&calendar=<calendar>&viewFormat=<viewFormat>
Parameters
Token | Description | Value Samples |
---|---|---|
base_url | The baseURL of your JIRA instance. |
|
format | The output file format of the report. Possible options are:
|
|
reportType | Defines how the issues to be included in the report will be selected. Possible options are:
|
|
selection | Defines the value that will be used to filter the issues. This parameter depends on reportType selection.
|
|
columnsBy | Defines the column structure of the report. Possible options are:
|
|
fields | The IDs of fields (separated by commas) on JIRA Issue that will be added to report output as columns. Both system and custom fields are supported. | assignee,customfield_10020,customfield_10007,description,duedate |
statuses | The IDs of statuses of which the durations will be included in the report. System expects you to provide existing status IDs. It is possible to leave this parameter empty but then the report will include issue rows without any duration columns. For assignee based reports, durations of unselected statuses will be excluded from durations of assignee columns. |
|
startDate | The start date of report interval in "yyyy-MM-dd hh:mm" format | 2017-07-01 00:00 |
endDate | The end date of report interval in "yyyy-MM-dd hh:mm" format | 2017-08-31 23:59 |
dateType | The date field type that startDate and endDate parameters will be based on. Possible options are:
|
|
calendar | The calendar that report durations will be calculated based on. Possible options are:
|
|
viewFormat | The format of duration data in the report. Possible options are:
|
|
Sample
http://192.168.0.71:7500/jira75/rest/tis/report/1.0/csv?reportType=project&project=PMP&columnsBy=status&fields=assignee,customfield_10123&statuses=3,10000,10001&startDate=2017-09-01 00:00&endDate=2017-10-31 00:00&dateType=created&calendar=normalHour&viewFormat=minutesFormat
Return
The REST call returns an XLS or CSV file that contains all the data in the report.
7. Previous JIRA Versions Support
For the customers are using older JIRA Server versions: Please visit "Version History" page of this plugin and download the compatible version.
8. Support
Let us know if you encounter any problem about Time in Status plug-in.
You can reach our support team through pluginsupport.obss.com.tr web portal or by sending an email to plugin@obss.com.tr.