PluginBudget » History » Version 7

Neil McFarlane, 2011-01-17 14:33
Added wiki-link to rate plug-in

1 1 Eric Davis
h1. Budget Plugin
2 1 Eric Davis
3 1 Eric Davis
Budget is a plugin to manage the set of deliverables for each project, automatically calculating key performance indicators.
4 1 Eric Davis
5 1 Eric Davis
h2. Features
6 1 Eric Davis
7 1 Eric Davis
* Add new deliverable to a project - Fixed bid or Time Based
8 1 Eric Davis
** New issues appended using JavaScript to the top of the deliverables list
9 1 Eric Davis
** Clearing the New Deliverable form after a successful save using JavaScript
10 1 Eric Davis
* Listing of deliverables on a project
11 1 Eric Davis
** Column sorting by: ID, Score, Subject, Budget, Spent, Due date, Progress
12 1 Eric Davis
* JavaScript drop down panel for each deliverable displaying
13 1 Eric Davis
** Deliverable details
14 1 Eric Davis
** Link to edit the deliverable
15 1 Eric Davis
** Link to see the issues assigned to the deliverable, using a issue filter
16 1 Eric Davis
** Mass assignment of all issues on a specific version to a deliverable
17 1 Eric Davis
** Button to Delete the deliverable
18 1 Eric Davis
* Edit a deliverable on a project
19 1 Eric Davis
* Automatic calculations for deliverables based on the existing Redmine issue and timelog data
20 1 Eric Davis
* Calculations for the whole project, based on the deliverables
21 1 Eric Davis
* Flexible role based permissions using Redmine's permissions and roles system
22 1 Eric Davis
** (none) - Can assign issues to a deliverable and filter on them. 
23 5 Mischa The Evil
** View - Can see the Budget tab and specific deliverable data: name, dates, progress (based on the %done against the estimated hours), total budget 
24 1 Eric Davis
** Manage - Can do everything 
25 1 Eric Davis
* Company defaults for:
26 1 Eric Davis
** Non billable overhead - in dollars or as a %
27 1 Eric Davis
** Materials - in dollars or as a %
28 1 Eric Davis
** Deliverable profit - in dollars or as a %
29 1 Eric Davis
* Ability to add the Deliverable column to the Main Issues list, including sorting and filtering by Deliverable name
30 1 Eric Davis
* Adding the billable rate to project members on a per project basis
31 1 Eric Davis
32 4 Eric Davis
h2. Screenshots
33 3 Eric Davis
34 3 Eric Davis
!budget_plugin-budget_screen_thumb.png!:/attachments/download/924/budget_plugin-budget_screen.png
35 1 Eric Davis
36 4 Eric Davis
Main Budget screen.
37 4 Eric Davis
38 3 Eric Davis
!budget_plugin-issues_list_thumb.png!:/attachments/download/925/budget_plugin-issues_list.png
39 1 Eric Davis
40 4 Eric Davis
Issue list filtered by a Deliverable.
41 4 Eric Davis
42 1 Eric Davis
!budget_plugin-member_billing_rates_thumb.png!:/attachments/download/926/budget_plugin-member_billing_rates.png
43 4 Eric Davis
44 4 Eric Davis
Member billing rates in Project Settings.
45 3 Eric Davis
46 2 Eric Davis
h2. Getting the plugin
47 2 Eric Davis
48 2 Eric Davis
A copy of the plugin can be found in the "downloads":https://projects.littlestreamsoftware.com/projects/list_files/redmine-budget at Little Stream Software and also on "GitHub":http://github.com/edavis10/redmine-budget-plugin/tree/master.
49 2 Eric Davis
50 1 Eric Davis
h2. Install
51 1 Eric Davis
52 6 Eric Davis
# Follow the Redmine plugin installation steps at: http://www.redmine.org/wiki/redmine/Plugins  Make sure the plugin is installed to Make sure you install the plugin to @vendor/plugins/budget_plugin@.
53 7 Neil McFarlane
# The [[pluginRate|Rate plugin]] is required also, install it from "Little Stream Software":https://projects.littlestreamsoftware.com/projects/redmine-rate/files
54 6 Eric Davis
# Run the plugin migrations @rake db:migrate_plugins@
55 6 Eric Davis
# Restart your Redmine web servers (e.g. mongrel, thin, mod_rails)
56 1 Eric Davis
# Login to your Redmine install as an Administrator
57 1 Eric Davis
# Enable the permissions for your Roles
58 1 Eric Davis
# Setup your companies defaults in the Plugins' configuration panel
59 1 Eric Davis
# Add the "Budget module" to the enabled modules for the projects you want to manage
60 1 Eric Davis
# The link to the plugin should appear on that project's navigation
61 1 Eric Davis
62 1 Eric Davis
h2. Usage
63 1 Eric Davis
64 1 Eric Davis
h3.  Adding deliverables
65 1 Eric Davis
66 1 Eric Davis
# Use the "New Deliverable" link on sidebar of the Budget page to add a new deliverable
67 1 Eric Davis
# The deliverable can be a Fixed Bid or an Hourly deliverable.  The type can be changed later.
68 1 Eric Davis
# Saving the deliverable will add it to the Deliverable list.
69 1 Eric Davis
70 1 Eric Davis
h3.  Viewing deliverables
71 1 Eric Davis
72 1 Eric Davis
# Clicking the pencil icon will drop down the deliverable details, with summary and calculations about the deliverable.
73 1 Eric Davis
# Links on the left can be used to edit or delete a deliverable and well as view the issue list for the deliverable.
74 1 Eric Davis
75 1 Eric Davis
h3.  Assignment of an issue to a deliverable
76 1 Eric Davis
77 1 Eric Davis
Edit an issue and select the deliverable from the dropdown
78 1 Eric Davis
79 1 Eric Davis
h3.  Bulk assignment of issues to a deliverable
80 1 Eric Davis
81 1 Eric Davis
# Select multiple issues on the issue list
82 1 Eric Davis
# Right click and select the edit option
83 1 Eric Davis
# Select the deliverable from the dropdown and save
84 1 Eric Davis
85 1 Eric Davis
h3.  Bulk Assignment of issues by Version
86 1 Eric Davis
87 1 Eric Davis
Issues can be bulk assigned to a deliverable based on a Version.
88 1 Eric Davis
89 1 Eric Davis
# Expand the Deliverable to view it
90 1 Eric Davis
# Select the Version in the drop down box
91 1 Eric Davis
# Click the Bulk Assign button
92 1 Eric Davis
# All issues for that version will now be assigned to that Deliverable
93 1 Eric Davis
94 1 Eric Davis
h2. License
95 1 Eric Davis
96 1 Eric Davis
This plugin is licensed under the GNU GPL v2.  See LICENSE.txt and GPL.txt for details.
97 1 Eric Davis
98 1 Eric Davis
h2. Project help
99 1 Eric Davis
100 6 Eric Davis
If you need help you can contact the maintainer on the bug tracker at https://projects.littlestreamsoftware.com/projects/redmine-budget
101 1 Eric Davis
102 1 Eric Davis
h3.  Bug tracker
103 1 Eric Davis
104 1 Eric Davis
If you would like to report a bug or request a new feature the bug tracker is located at https://projects.littlestreamsoftware.com/projects/show/redmine-budget
105 6 Eric Davis
106 6 Eric Davis
107 6 Eric Davis
h2. News
108 6 Eric Davis
109 6 Eric Davis
* "0.2.0 Release Annoucement":http://theadmin.org/articles/2009/4/27/redmine-budget-plugin-v0-2-0-released-finally