Project

General

Profile

PluginRate » History » Version 3

dj jones, 2016-08-18 17:39

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 3 dj jones
A more recent fork, possibly supporting up to Redmine 3.3:
28
-  https://github.com/alexandermeindl/redmine_rate
29
30
The original 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
31 1 Eric Davis
32
h2. Installation and Setup
33
34
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.
35
36
h3. Option One: If you have data from a previous version of Budget or Billing
37
38
These installation instructions are very specific because the Rate plugin adjusts data inside the Budget plugin so several data integrity checks are needed.
39
40
# Backup up your data! Backup your data!
41
# Follow the Redmine plugin installation steps a [[Plugins]]  Make sure the plugin is installed to @vendor/plugins/redmine_rate@
42
# Make sure you are running the 0.1.0 version of the Budget plugin and 0.0.1 version of the Billing plugin
43
# Run the pre_install_export to export your current budget and billing data to file @rake rate_plugin:pre_install_export@
44
# Run the plugin migrations @rake db:migrate_plugins@ in order to get the new tables for Rates
45
# Upgrade the budget plugin to 0.2.0 and the billing plugin to 0.3.0
46
# Rerun the plugin migrations @rake db:migrate_plugins@ in order to update to Budget's 0.2.0 schema
47
# Run the post_install_check to check your exported data (from #3 above) against the new Rate data. @rake rate_plugin:post_install_check@
48
# If the script reports no errors, proceed.  If errors are found, please file a bug report and revert to your backups
49
# Restart your Redmine web servers (e.g. mongrel, thin, mod_rails)
50
# Setup the "View Rate" permission for any Role that should be allowed to see the user rates in a Project
51
52
h3. Option Two: If you do not have any data from Budget or Billing
53
54
# Follow the Redmine plugin installation steps a [[Plugins]]  Make sure the plugin is installed to @vendor/plugins/redmine_rate@
55
# Run the plugin migrations @rake db:migrate_plugins@ in order to get the new tables for Rates
56
# Restart your Redmine web servers (e.g. mongrel, thin, mod_rails)
57
# Setup the "View Rate" permission for any Role that should be allowed to see the user rates in a Project
58
59
h2. Usage
60
61
h3. Enter new rate for a project
62
63
There are two ways to set rates for a Member of a Project.
64
65
# Browse to the Project Settings page
66
# Select the Members tab
67
# Enter the rate for the Member and click the set Rate
68
69
Alternatively, Rates can be set in the User Administration panel
70
71
# Browse to the Administration panel
72
# Select Users
73
# Select the specific user to add a rate for
74
# Select the Membership tab and enter a rate for each project
75
# Or, select the Rate History and enter a new rate in the form
76
77
h3. Enter default rate for a user
78
79
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:
80
81
# Browse to the Administration panel
82
# Select Users
83
# Select the specific user to add a rate for
84
# Select the Rate History and enter a new rate in the form, keep the Project field set to Default Rate.
85
86
h3. Lock a Rate
87
88
Currently this feature is only available through the Rate API.  A Rate will become locked once a valid TimeEntry is assigned to the Rate.
89
90
h2. Usage
91
92
To ask a question, just update an issue and select a Member from the question select box right below the issue notes.
93
94
h2. License
95
96
This plugin is licensed under the GNU GPL v2.  See COPYRIGHT.txt and GPL.txt for details.
97
98
h2. Project help
99
100
If you need help you can contact the maintainer at the Bug Tracker.  The bug tracker is located at  https://projects.littlestreamsoftware.com
101
102
h2. News