|Version 7 (modified by tst, 7 years ago) (diff)|
Trac and SlimTimer integration
Table of Contents
Provides some rudimentary support for:
- creating SlimTimer tasks from trac tickets;
- setting hours in trac tickets (such as the 'totalhours' field of the TimingAndEstimationPlugin) based on SlimTimer data; and
- backing up SlimTimer data to an external database.
The plugin allows a group of users to be defined by trac username and SlimTimer login providing some basic group sharing of SlimTimer tasks.
There are two parts to its operation: synchronisation and reporting.
When a trac ticket enters the assigned state (i.e. it is accepted by someone), TracSlimTimer creates a corresponding task in SlimTimer. The ID of the SlimTimer task is then recorded with the trac ticket (as a custom field).
The operation is shown below.
More generally, synchronisation occurs when:
- a ticket is assigned. Note that it is not just sufficient to put a name in the "assigned to" field. The assigned person also needs to accept the ticket before it enters the assigned state. Until then the ticket is in the "new" state.
- a ticket is closed.
- a ticket is reopened.
- a ticket is deleted.
- any of the following fields is changed while the ticket is in the assigned or reopened state:
The following synchronisation is performed:
- When tickets are assigned or reopened a corresponding task in SlimTimer is created if it does not already exist.
- When a SlimTimer task is created the SlimTimer ID is stored in a custom field of the trac ticket.
- When a ticket is closed in trac the corresponding task is marked as complete in SlimTimer.
- When a ticket is reopened in trac the corresponding task is marked as incomplete in SlimTimer.
- When a ticket is deleted in trac the corresponding task is marked as complete in SlimTimer.
- The name of the SlimTimer task is composed of the trac ticket ID followed by the trac summary, e.g. " #40: Plan & co-ordinate 0.4 release"
- The tags of the SlimTimer task will include the trac milestone and keywords.
- The coworkers of the SlimTimer task will include all the users configured in the TracSlimTimer module who have the "default CC/coworker" property selected and any users listed in trac's CC field.
- The total hours recorded in SlimTimer are stored in the trac ticket using the custom field 'totalhours' (for compatibility with the TimingAndEstimationPlugin)
The second function of TracSlimTimer is to collect all the SlimTimer data for the configured users and record it in a separate data store. This provides a backup of the SlimTimer data and allows reporting for a whole group of users.
The operation is shown below.
Currently only MySQL is supported as a database. From MySQL the user can perform their own reporting (e.g. using Excel via MyODBC or some web-reporting tool.)
Not all users will require this function and it is possible to operate TracSlimTimer without a database.
This plugin will currently only work with trac 0.10. This is because:
- ITicketChangeListener is used so it will not work with 0.9
- Only ClearSilver templates are provided so it will not work with Genshi.
Some of the code has been written so that it might just work with 0.11 and Genshi if the templates were provided. For example, there is code in admin_ui.py to use the alternate IAdminPageProvider vs IAdminPageProvider templates but it is entirely untested.
- Install the plugin. If you want to run it from source you might use something like,
/opt/trac/0.10.3/install/bin/python setup.py develop -md /var/trac/0.10.3/var/trac/plugins
Otherwise you can can make the egg and use easy_install. e.g.
/opt/trac/0.10.3/install/bin/python setup.py bdist_egg
Then run /opt/trac/0.10.3/install/bin/easy_install <egg> where <egg> is whatever got dumped in your dist directory.
You might have some trouble with dependencies. If you do check below under dependencies.
- Enable the plugin in trac.ini. For example, in /var/trac/0.10.3/var/trac/conf/trac.ini. you should add tracslimtimer.* = enabled under [components], e.g.
... [components] ... tracslimtimer.* = enabled
- Upgrade (setup) the environment for the plugin by running trac-admin, e.g.
/opt/trac/0.10.3/install/bin/trac-admin /var/trac/0.10.3/var/trac upgrade
This adds the slimtimer_id custom ticket field. If you skip this step you'll probably get an error in the error.log (see below for more information on troubleshooting).
[Tue Apr 24 12:50:34 2007] [error] [client 10.0.10.177] PythonHandler trac.web.modpython_frontend: TracError: The Trac Environment needs to be upgraded. Run trac-admin /var/trac/0.10.3/var/trac upgrade", referer: ...
- Restart the trac server, e.g.
If you have any issues, create a new ticket.
Download the zipped source from here.
-  by rjollos on 2012-10-02 19:56:38
Refs #10248: Branching for Trac 0.11 and later. Copied 0.10 directory to branches/0.10. Moved 0.10 directory to trunk.
-  by rjollos on 2012-08-09 21:01:33
Fixes #1904: Fixed incorrect package_data specification. Thanks to Paolo Caravello for the patch.
-  by tst on 2007-04-27 09:20:33
Added time tracking schema.