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 | |||
3 | Budget is a plugin to manage the set of deliverables for each project, automatically calculating key performance indicators. |
||
4 | |||
5 | h2. Features |
||
6 | |||
7 | * Add new deliverable to a project - Fixed bid or Time Based |
||
8 | ** New issues appended using JavaScript to the top of the deliverables list |
||
9 | ** Clearing the New Deliverable form after a successful save using JavaScript |
||
10 | * Listing of deliverables on a project |
||
11 | ** Column sorting by: ID, Score, Subject, Budget, Spent, Due date, Progress |
||
12 | * JavaScript drop down panel for each deliverable displaying |
||
13 | ** Deliverable details |
||
14 | ** Link to edit the deliverable |
||
15 | ** Link to see the issues assigned to the deliverable, using a issue filter |
||
16 | ** Mass assignment of all issues on a specific version to a deliverable |
||
17 | ** Button to Delete the deliverable |
||
18 | * Edit a deliverable on a project |
||
19 | * Automatic calculations for deliverables based on the existing Redmine issue and timelog data |
||
20 | * Calculations for the whole project, based on the deliverables |
||
21 | * Flexible role based permissions using Redmine's permissions and roles system |
||
22 | ** (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 | * Company defaults for: |
||
26 | ** Non billable overhead - in dollars or as a % |
||
27 | ** Materials - in dollars or as a % |
||
28 | ** Deliverable profit - in dollars or as a % |
||
29 | * Ability to add the Deliverable column to the Main Issues list, including sorting and filtering by Deliverable name |
||
30 | * Adding the billable rate to project members on a per project basis |
||
31 | |||
32 | 4 | Eric Davis | h2. Screenshots |
33 | 3 | Eric Davis | |
34 | !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 | |||
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 | |||
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 | Member billing rates in Project Settings. |
||
45 | 3 | Eric Davis | |
46 | 2 | Eric Davis | h2. Getting the plugin |
47 | |||
48 | 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 | |||
50 | 1 | Eric Davis | h2. Install |
51 | |||
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 | # Restart your Redmine web servers (e.g. mongrel, thin, mod_rails) |
||
56 | 1 | Eric Davis | # Login to your Redmine install as an Administrator |
57 | # Enable the permissions for your Roles |
||
58 | # Setup your companies defaults in the Plugins' configuration panel |
||
59 | # Add the "Budget module" to the enabled modules for the projects you want to manage |
||
60 | # The link to the plugin should appear on that project's navigation |
||
61 | |||
62 | h2. Usage |
||
63 | |||
64 | h3. Adding deliverables |
||
65 | |||
66 | # Use the "New Deliverable" link on sidebar of the Budget page to add a new deliverable |
||
67 | # The deliverable can be a Fixed Bid or an Hourly deliverable. The type can be changed later. |
||
68 | # Saving the deliverable will add it to the Deliverable list. |
||
69 | |||
70 | h3. Viewing deliverables |
||
71 | |||
72 | # Clicking the pencil icon will drop down the deliverable details, with summary and calculations about the deliverable. |
||
73 | # Links on the left can be used to edit or delete a deliverable and well as view the issue list for the deliverable. |
||
74 | |||
75 | h3. Assignment of an issue to a deliverable |
||
76 | |||
77 | Edit an issue and select the deliverable from the dropdown |
||
78 | |||
79 | h3. Bulk assignment of issues to a deliverable |
||
80 | |||
81 | # Select multiple issues on the issue list |
||
82 | # Right click and select the edit option |
||
83 | # Select the deliverable from the dropdown and save |
||
84 | |||
85 | h3. Bulk Assignment of issues by Version |
||
86 | |||
87 | Issues can be bulk assigned to a deliverable based on a Version. |
||
88 | |||
89 | # Expand the Deliverable to view it |
||
90 | # Select the Version in the drop down box |
||
91 | # Click the Bulk Assign button |
||
92 | # All issues for that version will now be assigned to that Deliverable |
||
93 | |||
94 | h2. License |
||
95 | |||
96 | This plugin is licensed under the GNU GPL v2. See LICENSE.txt and GPL.txt for details. |
||
97 | |||
98 | h2. Project help |
||
99 | |||
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 | h3. Bug tracker |
||
103 | |||
104 | 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 | |||
107 | h2. News |
||
108 | |||
109 | * "0.2.0 Release Annoucement":http://theadmin.org/articles/2009/4/27/redmine-budget-plugin-v0-2-0-released-finally |