Skip to content

Plugin description and instructions

nicStuff edited this page Jul 17, 2012 · 10 revisions

Plugin description and instructions

This is a redmine plugin which adds some extensions to time tracking on issues, and is a modified version of the "redmine-timesheet-plugin" by Eric Davis. Particularly, this plugin works on two parts:

  1. permits to insert start time, end time and billed hours when logging time for an issue;
  2. shows the time entries via many criteria and exports them in CSV.

The first part is completely new and here's a screenshot:

Time logging view of an issue in redmine

The second part is the modified version of "redmine-timesheet-plugin", and here's a screenshot of the page:

Timesheet view of timesheet plugin revisited

The functional differences between this plugin and "redmine-timesheet-plugin" by Eric Davis are the following (referring to the screenshot):

  • the 'Group by' select is renamed to 'Sort by' and controls how the results are sorted instead of how them are grouped: the sorting is per-<selected field> and then per-date for each request;
  • there is a new period selector which allows to chose a period by year and, optionally, by month;
  • there is a new group of fields 'Fields to include': these fields control the columns that are outputted (e.g. by selecting only 'User', 'Week of Year' and 'Hours' those will be the only three columns in output). Not only: by selecting the fields you 'group' the results by the fields selected except that for hours and billed hours, which are shown as sum of the grouped results. For example, if you select the three fields of before you will see that each row has a different 'User'-'Week of year' couple, and 'Hours' is the sum of the hours for each row with the same 'User'-'Week of year' couple before grouping (strictly speaking it makes a logical SQL GROUP BY on selected fields).

Installation

For installing the plugin you can follow redmine instructions for installing a plugin, or you can follow these simple steps:

  • stop the redmine server;
  • download the plugin. You can use the "downloads" section visible from the "Source" and get the plugin in your preferred format between .tar.gz and .zip; if you're using redmine 1.1.x, select the branch redmine-1.1.x-compatible before downloading. Otherwise, download with the branch master selected;
  • rename the folder containing the plugin in 'redmine_timesheet_extensions' if it wasn't that;
  • copy that folder in the path /vendor/plugins of your redmine installation;
  • run the plugin migration (in the terminal, from the root directory of redmine installation, type rake db:migrate_plugins). The migration only adds a column to the table 'time_entries' named 'billed_hours', which will store the billed hours: although the migration could break your database, that's a rare event and it shouldn't happen to you. Moreover second me it's better to make a dump just for staying relaxed, especially if the DB is a production DB;
  • then start the server and try it!

If you have some issues feel free to contact me on GitHub or on theonenkl on gmail.

Compatibility

Although there are no incompatilities found, it is clear that you can't use this plugin with "redmine-timesheet-plugin" because these two add the same link on the left top and something could crash: so use one or another.

The switch between this plugin and Eric Davis plugin and viceversa is unpainful.

Feedback

If you find this plugin useful, well made, or on the contrary, badly made, not working, feel free to write me some lines (my mail is theonenkl at gmail dot com), the first that come in your mind: those will be sincerely appreciated, and will help me to make the plugin better. Thank you!

I hope that you find the plugin useful and I'm open to support for making it better. Finally, if you find some english errors, well, no one is perfect (tell them to me, thanks) :)

Donations

If you really like this plugin you can make a paypal donation to me if you desire (e-mail address theonenkl on gmail (and gmail has only dot com at the moment)), so I will have a stronger argumentation to justify to my wife all the time spent on the PC :) talking about this "plugin".