RedmineTimeTracking » History » Version 16

Mikkel Kirkgaard Nielsen, 2016-11-02 11:37
rephrase explanation about accepted/decimal time formats to be more logical and precise, spent-time->spent time and other minor textual fixes

1 1 Jean-Philippe Lang
h1. Time tracking
2 1 Jean-Philippe Lang
3 9 Mischa The Evil
{{>toc}}
4 5 James Rowe
5 5 James Rowe
h2. Introduction
6 5 James Rowe
7 16 Mikkel Kirkgaard Nielsen
Time tracking allows users to track how many hours of work are logged to a specific issue or project. Each time entry of "spent time" can be categorized by activity, and further explained with comments. By filling time estimates, project managers are able to produce better suited project planning as well as follow individual user's progress. 
8 6 James Rowe
9 16 Mikkel Kirkgaard Nielsen
Time tracking is always related to a user, thus it can be used to track how many billable hours this user has accomplished. See the [[RedmineTimelogDetails|spent time details]] or [[RedmineTimelogReport|spent time report]] pages for more information.
10 5 James Rowe
11 15 Red Miner
You can use a standard time tracking module in Redmine or go with an easy way and use alternative *Redmine time tracker* https://tmetric.com/help/integrations/redmine-time-tracking/     
12 15 Red Miner
13 5 James Rowe
h2. Installing/Configuration
14 5 James Rowe
15 9 Mischa The Evil
Time tracking is a standard module of Redmine and can be enabled/disabled for each project in the *Modules* section of the new project form, or the *Settings* tab of an existing project.
16 1 Jean-Philippe Lang
17 2 Jean-Philippe Lang
h2. Logging time on an issue
18 2 Jean-Philippe Lang
19 2 Jean-Philippe Lang
You can log time on an issue by clicking !/images/time_add.png! *Log time* from the issue details view.
20 1 Jean-Philippe Lang
21 9 Mischa The Evil
p=. !log_time.png!
22 1 Jean-Philippe Lang
23 1 Jean-Philippe Lang
You can also log time when updating an issue.
24 1 Jean-Philippe Lang
25 9 Mischa The Evil
p=. !Update_LogTime.png!
26 1 Jean-Philippe Lang
27 1 Jean-Philippe Lang
h2. Logging time at project level
28 1 Jean-Philippe Lang
29 1 Jean-Philippe Lang
You can log hours at project level by leaving the issue field empty.
30 9 Mischa The Evil
31 9 Mischa The Evil
h2. Accepted time formats
32 9 Mischa The Evil
33 16 Mikkel Kirkgaard Nielsen
Estimated and spent time can be entered using either separated hour and minutes or combined in the following formats:
34 16 Mikkel Kirkgaard Nielsen
# Separated: hour and minutes as an integer using standard time format: *@1h@*, *@1 h@*, *@1 hour@*, *@2 hours@*, *@30m@*, *@30min@*, *@1h30@*, *@1h30m@*, *@1:30@*
35 16 Mikkel Kirkgaard Nielsen
# Combined: as a fraction of hours in decimal time format using either period (.) or comma (,) as decimal separator: *@1.5@*, *@1,5@* (equals to @1h30@)
36 1 Jean-Philippe Lang
37 1 Jean-Philippe Lang
h3. Decimal time format
38 9 Mischa The Evil
39 16 Mikkel Kirkgaard Nielsen
When entering estimated or spent time values in Redmine using "decimal time format":http://en.wikipedia.org/wiki/Decimal_time you have to be aware that Redmine will also show accumulated time values in decimal time format.
40 9 Mischa The Evil
41 16 Mikkel Kirkgaard Nielsen
Consider the following example:
42 1 Jean-Philippe Lang
43 16 Mikkel Kirkgaard Nielsen
* in a project you have 4 issues with the following spent time values: *1.00*, *0.10*, *0.15*  & *0.40*. Now in the Spent Time reports (Project overview -> Spent time -> [Details | Report]) you will see the accumulated total of the decimal values of 1.65 hours (1 hour 39 minutes), not a separate accumulation of the hour and minutes after the decimal point (which would yield an incorrect value of 2.05 hours).
44 16 Mikkel Kirkgaard Nielsen
45 16 Mikkel Kirkgaard Nielsen
* _Explanation_: this is intended behaviour since the four spent time values are entered in decimal time format. The values are interpreted as follows: 
46 9 Mischa The Evil
** 1.00 decimal equals 60 minutes (1 hour)
47 9 Mischa The Evil
** 0.10 decimal equals 6 minutes
48 9 Mischa The Evil
** 0.15 decimal equals 9 minutes
49 9 Mischa The Evil
** 0.40 decimal equals 24 minutes
50 9 Mischa The Evil
** 1.65 decimal equals 99 minutes
51 16 Mikkel Kirkgaard Nielsen
** 2:05 hours (125 minutes) equals 2.0833333333333335 (est.) in decimal notation
52 9 Mischa The Evil
53 16 Mikkel Kirkgaard Nielsen
Due to rounding of the decimal values to two decimals done when showing an accumulated value there can possibly be a tiny difference (as can be seen from the 2:05 example above).
54 9 Mischa The Evil
55 9 Mischa The Evil
Some references:
56 9 Mischa The Evil
* http://en.wikipedia.org/wiki/Decimal_time
57 9 Mischa The Evil
* http://www.springfrog.com/converter/decimal-time.htm
58 11 Jean-Philippe Lang
59 11 Jean-Philippe Lang
h2. Logging time via commit messages
60 11 Jean-Philippe Lang
61 13 Mischa The Evil
With the *Enable time logging* option turned on (see _Application settings -> Repositories_), developers can log time against an issue via their commit messages using the following syntax (hours must be preceded with an issue id):
62 11 Jean-Philippe Lang
63 11 Jean-Philippe Lang
  Fixed something, #435 @1h30
64 11 Jean-Philippe Lang
65 11 Jean-Philippe Lang
This commit message will log 1h30 on issue !#435.
66 14 Mohit Sindhwani
67 14 Mohit Sindhwani
If you encounter a problem with this, ensure that under _Application settings -> Repositories_, make sure that *Activity for logged time* is set to something other than 'Default' and use a format similar to the below in your commit message.
68 14 Mohit Sindhwani
69 14 Mohit Sindhwani
  refs #435 @1h30