Issue timers can be used to keep track of the time you work on issues. The timer can be started and stopped automatically, but can also be handled manually.
The basic idea is that when a user starts working on an issue, a timer is started and when the work is finished the timer is stopped, and then a work log can be created to register the time on the issue.
In order to use issue timers you need make two configurations:
- Give access so that your users are allowed to use timers. This is done by adding the role permission "Use timers", see "General/Settings/Roles&Groups/Role permissions" --> in the issue section
- To use issue timers on a project the "Use issue timer" option need to be checked in the project settings. This is found in "Project/Settings/Issue timer settings":
Once these configurations have been done, users can start using issue timers. Issue timers can be controlled at different places in the system:
- Edit issue page
- Issue context menu
- The new "Issue timer" menu in the top toolbar
- Issue status changes
1. Edit issue page
On the edit issue page there is now a new panel called "Issue timer" on the righthand side:
In this panel you have the option to control the timer for the specific issue that is being edited. There are functions for Start/Stop/Pause and creating work logs based on the timer.
When a timer is started a new row will appear in the table showing the start time, and an indication that the timer is running. If the timer is paused, then a duration will be displayed in the "Duration " column, showing how long the timer was running before it was paused. The timer can then be started again by pressing the start button, which will create a new row in the table with the new start time.
If a timer is paused, the same thing will happen in terms of the timer in the "Issue timer" panel, but the difference is that when a timer is stopped, a setting on the project can automatically generate a new work log on the issue (see next section for more information about work log creation). It is also possible to remove a timer instance by pressing the remove icon () next to the timer.
Issue timers work a bit different depending on the setting for how times are registered on work logs (see "Work log settings" for more information). If time should only be registered using a date and the time spent working on the issue, then timer works as described above. If you've been working on an issue during during the day with some pauses, you'll probably have a couple of different timers in the table.
If you press the "Create work log" button then a work log dialog will be displayed, and the "time spent" field will be prefilled with the aggregated time of all the timers on the issue. If you continue by creating the work log, then the timers will dissappear from the table in the issue timer panel, since they are no longer active on the issue (i.e a work log has been created).
If both start and end time needs to be registered on worklogs, then issue timers work slightly different. Since both start and end times are important on worklogs, then the only option you have for timers are Start and Stop. It doesn't make sense to pause an issue, since the exact time is important. This means that instead of creating one work log for many timer instances, you now should create one work log for each timer. The same rule applies here that if you create a work log for a timer instance, then it will dissappear from the table, since it is no longer an active timer on the issue.
See below how the Issue timer panel looks using this setting for work logs:
2. Issue context menu
In the issue context menu (for example if you right-click in the issues list), the user now have the option to either start or stop an issue timer, depending on if the issue already have a running timer or not.
3. The new "Issue timer" menu in the top toolbar
In the new Issue timer menu in the top toolbar, you can quickly get an overview of all active timers in the system.
- If no timers are active, then the menu will be displayed with the normal stopwatch icon () and the text will be grey.
- If there are active timers (paused or stopped but no worklog), then the same icon is used, but the text is displayed with blue color.
- If there are running timers, then the running timer icon () is used.
By clicking the menu, all the issues with active timers will be displayed, and all available actions are included in submenus. By clicking on the issue title, the issue will be opened in a separate tab.
4. Issue status changes
Starting and stopping timers can also be connected to status changes on issues (NOTE: timer actions based on status changes will only be triggered by status changes that is made by the user himself).
In order to configure which timer action is connected to which status, you go to "General/Settings/Issue configuration/Issue statuses". Here you have a list of valid issue statuses, and how they work. If you have selected a timer action, this will be displayed in the "Special flags" column, as either "Start timer" or "Stop timer". To specify which action is used on the issue status, you press the edit icon and check the appropriate box ("Start timer" or "Stop timer"). If the status doesn't have a timer action, then no timer action will be taken for this status.
Work log creation when stopping timers
When a timer is stopped, the user can specify three different options for generating work logs. This settings is made per project in Project/Settings/Issue timer settings:
1. Never create work log
Work logs are never created when stopping timers. Using this option, the user needs to manually create work logs at the end of each day.
2. Create work log and show work log dialog
When the timer is stopped, a work log dialog is displayed with prefilled values for most fields. If a work log category should be used, then this needs to be selected and a description can be entered.
3. Automatically create a work log
Everytime a timer is stopped, a new work log is automatically generated, based on the time information in the timer. The description and work log category are left empty.