Search 1.9 billion lines of Odoo code on GitHub

business_requirement_project

Author: Elico Corp, Odoo Community Association (OCA)
License: AGPL-3
Branch: gap_analysis_project_8.0
Repository: xie8899/project
Dependencies: business_requirement, business_requirement_deliverable, and project
Languages: Python (466, 89.1%), and XML (57, 10.9%)

<a class="reference external image-reference" href="https://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.svg"> </a> <a name="business-requirement-project"></a> <h2>Business Requirement - Project</h2> <a name="introduction"></a> <h3>Introduction</h3> <p>This module is part of a set (&quot;Business Requirement&quot;) and provides the basic models for business requirement management and project time/cost estimation.</p> <p><img alt="Business Requirement List view" src="static/img/bus_req_tree.png" style="width: 800px;" /></p> <p>The set comprises of multiple modules that can be used independently or not:</p> <table class="docutils"> <colgroup> <col width="54%" /> <col width="46%" /> </colgroup> <thead valign="bottom"> <tr><th class="head">Module</th> <th class="head">Description</th> </tr> </thead> <tbody valign="top"> <tr><td>business_requirement</td> <td>Basic models and functions</td> </tr> <tr><td>business_requirement_project</td> <td>Wizard to create project/tasks from BR/resource lines</td> </tr> <tr><td>business_requirement_crm</td> <td>Wizard to create/update Sales Quotation based on deliverables</td> </tr> <tr><td>business_requirement_deliverable</td> <td>Adds deliverables and resources lines</td> </tr> <tr><td>business_requirement_deliverable_report</td> <td>Adds printout to send BR and deliverables to the customer</td> </tr> <tr><td>business_requirement_deliverable_default</td> <td>Adds default resource lines for deliverable products</td> </tr> <tr><td>business_requirement_deliverable_cost</td> <td>Add sales and cost price for estimation and profit control</td> </tr> <tr><td>business_requirement_deliverable_categ</td> <td>Adds the possibility to have tasks category in resources</td> </tr> </tbody> </table> <p>Many other modules (business_requirement_*) complete this basic list.</p> <a name="what-is-a-business-requirement"></a> <h3>What is a Business Requirement?</h3> <p>A Business requirement (BR) is the expression of a business need by a customer or internal project user. A BR can contain multiple different parts depending on the company needs:</p> <ul class="simple"> <li>Customer Story: this is the requirement as expressed by the customer</li> <li>Scenario: How/where the current solution can provide a suitable scenario to answer the customer story</li> <li>Gap: For the uncovered part of the scenario, elaborate the gap/need for specific developments/setup</li> <li>Deliverables to be provided to the customer/user</li> <li>Resources necessary to achieve the deliverables</li> <li>Additional information (approval, cost control etc.)</li> </ul> <p>These modules were originally design for the service/IT industry but the requirement management is generic and can apply to many cases/industries (customer or internal projects):</p> <ul class="simple"> <li>Construction</li> <li>Trading (New product development)</li> <li>Business Consultancy</li> <li>IT development</li> </ul> <p>What is the difference between a BR and CRM lead?</p> <ul class="simple"> <li>CRM leads are sales oriented</li> <li>BR are project and workload estimation oriented</li> </ul> <a name="how-to-use-this-module"></a> <h3>How to use this module?</h3> <p>This module contains 2 main wizards to create projects/tasks:</p> <ul class="simple"> <li>Generate Project in the master project view</li> <li>Generate Project in the Business requirement view</li> </ul> <p>This module depends on:</p> <ul class="simple"> <li><strong>business_requirement</strong>: definition of business requirements</li> <li><strong>business_requirement_deliverable</strong>: definition of deliverable and resources lines, necessary to create the project information</li> </ul> <p>Based on the information from business requirement and the resource lines the wizard will create:</p> <ul class="simple"> <li>Projects and sub project based on BR and deliverable (optional)</li> <li>Tasks based on the resources lines set as tasks</li> </ul> <p><img alt="Business Requirement Project Wizard" src="static/img/bus_req_project.png" style="width: 800px;" /></p> <a name="installation"></a> <h4>Installation</h4> <p>No specific steps required</p> <a name="configuration"></a> <h4>Configuration</h4> <a name="users"></a> <h3>Users</h3> <p>Only Project Manager can have access to the wizard button.</p> <a name="master-project"></a> <h3>Master project</h3> <p>You can define a master project linked to the business requirement.</p> <p>The master project will be the parent of any project created via the wizard.</p> <a name="usage"></a> <h4>Usage</h4> <a name="procedure"></a> <h3>Procedure</h3> <ol class="arabic simple"> <li>Create multiple BR linked to one or several master projects</li> <li>fill in the deliverables lines and corresponding resources lines (RL)</li> <li>Properly define your RL description, time and assignee (used for task creation)</li> <li>Confirm and Approve the Business Requirements</li> <li>At that stage you can either</li> </ol> <blockquote> <ol class="arabic simple"> <li>Create the project in each business requirement via corresponding button</li> <li>Go to the master project and create the projects for all BR related to the master project</li> </ol> </blockquote> <ol class="arabic simple"> <li>The wizard is triggered and you can select the following option regarding the hierarchy of projects</li> </ol> <blockquote> <ol class="arabic simple"> <li>Parent project for creation</li> <li>Create sub-projects for Business requirements</li> <li>Create sub-projects for Deliverables</li> <li>Create sub-projects for Child Business requirements</li> </ol> </blockquote> <a name="example"></a> <h3>Example</h3> <p>eg: if a master project contains the following BR: * BR1 with Deliverable Line 1 (DL) containing 2 Resource Lines (RL): RL1 and RL2 * BR2 with DL2 and DL3 containing each 2 RL: RL3 and RL4, RL5 and RL6 * BR3 with DL4 and one RL: RL7 (Sub BR of BR2)</p> <p>If no option is selected:</p> <ul class="simple"> <li>No sub project created</li> <li>7 tasks are created in the master project (for RL1~RL7)</li> </ul> <p>If option 1 is selected:</p> <ul class="simple"> <li>3 sub projects (parent is Master project), one per BR</li> <li>7 tasks are created for * BR1 (2 tasks for RL1 and RL2), * BR2 (4 tasks for RL3~6), * BR3 (1 task for RL7)</li> </ul> <p>If option 2 is selected:</p> <ul class="simple"> <li>4 sub projects (parent is Master project), one per DL</li> <li>7 tasks are created for * DL1 (2 tasks for RL1 and RL2), * DL2 (2 tasks for RL3~4), * DL3 (2 tasks for RL5~6) and * DL4 (1 task for RL7)</li> </ul> <p>If option 1+2 are selected:</p> <ul class="simple"> <li>7 sub projects (parent is Master project), one per BR and one per DL</li> <li>BR1 sub-project contains DL1 sub-project,</li> <li>BR2 sub-project contains DL2 and DL3 sub-projects,</li> <li>BR3 sub-project contains DL4 sub-project</li> <li>7 tasks are created for * DL1 (2 tasks for RL1 and RL2), * DL2 (2 tasks for RL3~4), * DL3 (2 tasks for RL5~6) and * DL4 (1 task for RL7)</li> </ul> <p>If option 1+3 are selected:</p> <ul class="simple"> <li>7 sub projects (parent is Master project), one per BR and one per DL</li> <li>BR1 sub-project</li> <li>BR2 sub-project contains BR3 sub-projects,</li> <li>7 tasks are created for * BR1 (2 tasks for RL1 and RL2), * BR2 (4 tasks for RL3~6), * BR3 (1 task for RL7)</li> </ul> <p>If option 1+2+3 are selected: * BR1 sub-project contains DL1 sub-project, * BR2 sub-project contains BR2, DL2 and DL3 sub-projects, * BR3 sub-project contains DL4 sub-project * 7 tasks are created for</p> <blockquote> <ul class="simple"> <li>DL1 (2 tasks for RL1 and RL2),</li> <li>DL2 (2 tasks for RL3~4),</li> <li>DL3 (2 tasks for RL5~6) and</li> <li>DL4 (1 task for RL7)</li> </ul> </blockquote> <a class="reference external image-reference" href="https://runbot.odoo-community.org/runbot/140/8.0"><img alt="Try me on Runbot" src="https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas" /></a> <a name="bug-tracker"></a> <h4>Bug Tracker</h4> <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/project/issues">GitHub Issues</a>. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback <a class="reference external" href="https://github.com/OCA/project/issues/new?body=module:%20business_requirement_project%0Aversion:%208.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">here</a>.</p> <a name="credits"></a> <h4>Credits</h4> <a name="images"></a> <h5>Images</h5> <ul class="simple"> <li>Odoo Community Association: <a class="reference external" href="https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg">Icon</a>.</li> </ul> <a name="contributors"></a> <h5>Contributors</h5> <ul class="simple"> <li>Eric Caudal&lt;<a class="reference external" href="mailto:eric.caudal&#64;elico-corp.com">eric.caudal&#64;elico-corp.com</a>&gt;</li> <li>Alex Duan&lt;<a class="reference external" href="mailto:alex.duan&#64;elico-corp.com">alex.duan&#64;elico-corp.com</a>&gt;</li> <li>Xie XiaoPeng&lt;<a class="reference external" href="mailto:xie.xiaopeng&#64;elico-corp.com">xie.xiaopeng&#64;elico-corp.com</a>&gt;</li> <li>Victor M. Martin &lt;<a class="reference external" href="mailto:victor.martin&#64;elico-corp.com">victor.martin&#64;elico-corp.com</a>&gt;</li> </ul> <a name="maintainer"></a> <h5>Maintainer</h5> <a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a> <p>This module is maintained by the OCA.</p> <p>OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.</p> <p>To contribute to this module, please visit <a class="reference external" href="https://odoo-community.org">https://odoo-community.org</a>.</p>