[WikiStart#WikiStart back][[BR]]
= Timelogs =
[wiki:timelogs#Abstract Abstract][[BR]]
[wiki:timelogs#Concept Concept][[BR]]
[wiki:timelogs#Implementation Implementation][[BR]]
[wiki:timelogs#Using Using Timelogs][[BR]]

This implementation is inspired by the Timelog extension published in the
roundup customising examples under
http://roundup.sourceforge.net/doc-0.8/customizing.html#examples


== Abstract ==
How much time did you spent on your issues? And on which tasks within your
issues did you spent the time? This questions are not only important for you
to be able to analyse your workflow and to identify inefficiency, but also of
interest for your customers.

Customers hire you to solve their problems and you want your customers to to
pay you for the work on the issues. Timelogs help you to track down the time
you and your workers spent on the issues.

== Concept ==
Timelogs are attached to changenotes/messages. This way you can always see on which
particular part of the issue you spent your time. 

[[Image(http://www.irlaender.de/projects/fast/timelogs_overview.png, 450,align=center)]][[BR]]
''(Picture: Overview of timelogstructure)''

Because messages are bound to messages they can be used for:

 * Issues
 * Remote Events
 * Workpackages (possible but not implemented)

Timelogs can be rated. As mentioned above you can see on which particular
part of the issue the time was spent and thus identify inefficiency. If it
took three hours to find out what the problem in the issue really is and 80% of
time was reading documentation you probably do not want to charge the full
time on your customer. So you can rate your spent time with e.g. 60%, which
basically means that 60% of the three hours entered as Timelog are chargeable
to customers.

== Implementation ==
More info soon...
== Using ==
Below you find some hints how to use Timelogs.
To be able to add new Timelogs will need to have either the role "Developer"
or "Internal". Rating of Timelog need the additions privileges of the
"Manager" role.
=== Adding new Timelogs ===
Timelogs can be add in two ways:
1. While creating a new changenote
Every time a user adds a change note he can enter the time in the small form
field directly below the changenote text-field. Note, that can not add 
Timelogs without entering a message.

[[Image(http://www.irlaender.de/projects/fast/add_timelog1.png, 450,align=center)]][[BR]]
''(Picture: Adding new Timelog)''

Timelogs must be entered following this format:

[#y] [#m] [#w] [#d] [[[H]:H:MM]:SS]

Examples:

 1. 30min -> 00:30
 2. 4 Hours and 45min -> 04:45
 3. 0.5min -> 00:00:30
 4. 120min -> 0:120 or 2:00

After adding the Timelog it will be displayed below the message. Users can
only see their own Timelogs. Users with the "Manager" role can see all
Timelogs.

[[Image(http://www.irlaender.de/projects/fast/timelogs_below_message.png, 450,align=center)]][[BR]]
''(Picture: Manager can see all timelogs)''

2. Adding new Timelogs to an existing messages.
Timelogs can be added to existing messages. On the message item page you can
add an additional Timelog. This can be useful to show that multiple persons
(e.g. pair-programming) were involved here.

[[Image(http://www.irlaender.de/projects/fast/add_timelog2.png, 450,align=center)]][[BR]]
''(Picture: Adding new Timelog to an existing message)''

Hint: This can also be used to correct Timelogs which has been entered. If
you entered too much time you can add some negative time to correct this.

=== Rating Timelogs ===
Below the messages list you will find the Timelog list. This list gives you a
summarised overview of all Timelogs within the issue, its ratings and relation to
workpackages.

[[Image(http://www.irlaender.de/projects/fast/timeloglist.png, 450,align=center)]][[BR]]
''(Picture: The timeloglist)''

As you can see we have three Timelogs in this list. Two of those Timelogs are
related directly to this issue. The last timlog comes from the Remote Event
we assigned to this issue.
For each Timelog you can see:
 * The full path to reach the message this Timelog is attached to
 * Who created to Timelog
 * In which workpackages this Timelog is assigned to
 * The Rating of the time
 * The unrated Time
 * The rated Time

Finally you get can see.
 * How much time was spent on this issue overall
 * How much time is already assigned in workpackages
 * How much time is free to be assigned in workpackages

If you do not know what workpackages are see workpackages for more details.

Important: Only rated time will be displayed in workpackages!