PluginRate » History » Version 5

Alex G, 2021-11-19 16:12

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