Project

General

Profile

PluginRate » History » Version 2

Eric Davis, 2009-04-24 23:57
Updated screenshots

1 1 Eric Davis
h1. Rate Plugin
2
3
The Rate plugin stores billable rates for Users.  It also provides an API that can be used to find the rate for a Member of a Project at a specific date.
4
5
h2. Features
6
7
* Track rates for a user based on
8
** Date Rate came into effect and
9
** the Project
10
* Store historic rate amounts
11
* Lock rates to preserve historic calculations
12
* Rate.for API for other plugins
13
* Integration with the Billing plugin
14
* Integration with the Budget plugin
15
16
h2. Screenshots
17
18 2 Eric Davis
|=. *User rates per project*  |
19
| !user_rate_per_project_thumb.png!:http://www.redmine.org/attachments/1942/user_rate_per_project.png |
20
|=. *User rate history*  |
21
| !users_rate_history_thumb.png!:http://www.redmine.org/attachments/1944/users_rate_history.png |
22
|=. *Project member rates*  |
23
| !project_members_rate_thumb.png!:http://www.redmine.org/attachments/1940/project_members_rate.png |
24 1 Eric Davis
25
h2. Getting the plugin
26
27
A copy of the plugin can be downloaded from "Little Stream Software":https://projects.littlestreamsoftware.com/projects/redmine-rate/files or from "GitHub":http://github.com/edavis10/redmine_rate/tree/master
28
29
h2. Installation and Setup
30
31
There are two sets of steps to install this plugin.  The first one should be done if you have used version 0.1.0 of the Budget Plugin or 0.2.0 of the Billing Plugin.  This is because the rate data needs to be migrated out of the Budget plugin and into this plugin.
32
33
h3. Option One: If you have data from a previous version of Budget or Billing
34
35
These installation instructions are very specific because the Rate plugin adjusts data inside the Budget plugin so several data integrity checks are needed.
36
37
# Backup up your data! Backup your data!
38
# Follow the Redmine plugin installation steps a [[Plugins]]  Make sure the plugin is installed to @vendor/plugins/redmine_rate@
39
# Make sure you are running the 0.1.0 version of the Budget plugin and 0.0.1 version of the Billing plugin
40
# Run the pre_install_export to export your current budget and billing data to file @rake rate_plugin:pre_install_export@
41
# Run the plugin migrations @rake db:migrate_plugins@ in order to get the new tables for Rates
42
# Upgrade the budget plugin to 0.2.0 and the billing plugin to 0.3.0
43
# Rerun the plugin migrations @rake db:migrate_plugins@ in order to update to Budget's 0.2.0 schema
44
# Run the post_install_check to check your exported data (from #3 above) against the new Rate data. @rake rate_plugin:post_install_check@
45
# If the script reports no errors, proceed.  If errors are found, please file a bug report and revert to your backups
46
# Restart your Redmine web servers (e.g. mongrel, thin, mod_rails)
47
# Setup the "View Rate" permission for any Role that should be allowed to see the user rates in a Project
48
49
h3. Option Two: If you do not have any data from Budget or Billing
50
51
# Follow the Redmine plugin installation steps a [[Plugins]]  Make sure the plugin is installed to @vendor/plugins/redmine_rate@
52
# Run the plugin migrations @rake db:migrate_plugins@ in order to get the new tables for Rates
53
# Restart your Redmine web servers (e.g. mongrel, thin, mod_rails)
54
# Setup the "View Rate" permission for any Role that should be allowed to see the user rates in a Project
55
56
h2. Usage
57
58
h3. Enter new rate for a project
59
60
There are two ways to set rates for a Member of a Project.
61
62
# Browse to the Project Settings page
63
# Select the Members tab
64
# Enter the rate for the Member and click the set Rate
65
66
Alternatively, Rates can be set in the User Administration panel
67
68
# Browse to the Administration panel
69
# Select Users
70
# Select the specific user to add a rate for
71
# Select the Membership tab and enter a rate for each project
72
# Or, select the Rate History and enter a new rate in the form
73
74
h3. Enter default rate for a user
75
76
A default rate is a user's Rate that doesn't correspond to a specific project.  It can be set in the User Administration panel:
77
78
# Browse to the Administration panel
79
# Select Users
80
# Select the specific user to add a rate for
81
# Select the Rate History and enter a new rate in the form, keep the Project field set to Default Rate.
82
83
h3. Lock a Rate
84
85
Currently this feature is only available through the Rate API.  A Rate will become locked once a valid TimeEntry is assigned to the Rate.
86
87
h2. Usage
88
89
To ask a question, just update an issue and select a Member from the question select box right below the issue notes.
90
91
h2. License
92
93
This plugin is licensed under the GNU GPL v2.  See COPYRIGHT.txt and GPL.txt for details.
94
95
h2. Project help
96
97
If you need help you can contact the maintainer at the Bug Tracker.  The bug tracker is located at  https://projects.littlestreamsoftware.com
98
99
h2. News