Search 1.9 billion lines of Odoo code on GitHub
business_requirement_deliverable_report
<a class="reference external image-reference" href="http://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-report-docx-module"></a>
<h2>Business Requirement Report Docx Module</h2>
<a name="introduction"></a>
<h3>Introduction</h3>
<p>This module is part of a set ("Business Requirement").
The Business Requirements features start as independent entities, and can be
used as standalone.</p>
<p>Additional modules integrate them with other business areas, such as Sales,
Procurement, Project or Analytic Accounting. For example:</p>
<ul class="simple">
<li>Sales Quotation can have an estimation supported by a BR analysis</li>
<li>Project Tasks can be related to the BRs they implement or support</li>
<li>Procurement and purchase can be generated out of the BR</li>
</ul>
<p><img alt="Business Requirement List view" src="business_requirement_deliverable_report/static/img/bus_req_tree.png" style="width: 800px;" /></p>
<p>The following diagram gives a simplified view of the universe:</p>
<p><img alt="Business Requirement modules diagram" src="business_requirement_deliverable_report/static/img/bus_req_module_diag.png" style="width: 800px;" /></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 designed 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 adds multiple printouts to the deliverable modules:</p>
<ul class="simple">
<li>Basic Business requirement printout: including header, Customer story,
scenario and gap analysis</li>
</ul>
<p><img alt="Basic Business requirement printout" src="business_requirement_deliverable_report/static/img/bus_req_report1.png" style="width: 800px;" /></p>
<ul class="simple">
<li>Deliverable printout: above printout including the deliverable lines at
sales price</li>
</ul>
<p><img alt="Deliverable printout (details)" src="business_requirement_deliverable_report/static/img/bus_req_report2.png" style="width: 800px;" /></p>
<ul class="simple">
<li>Resource Printout: above printout including the resource lines with
expected quantity</li>
</ul>
<p><img alt="Resource Printout (details)" src="business_requirement_deliverable_report/static/img/bus_req_report3.png" style="width: 800px;" /></p>
<a name="installation"></a>
<h4>Installation</h4>
<p>Install the module base_report_docx, required as a dependency (some external
dependencies like html2txt, docxtpl, pypdf or reportlab might be required).</p>
<p>Make sure to set up the wkhtml2pdf in system properties (add a key webkit_path
with value /path_to_file/wkhtml2pdf).</p>
<a name="configuration"></a>
<h4>Configuration</h4>
<p>No specific configuration required</p>
<a name="usage"></a>
<h4>Usage</h4>
<p>Select the BR and print desired report</p>
<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="known-issues-roadmap"></a>
<h4>Known issues / Roadmap</h4>
<ul class="simple">
<li>Current rendering engine does not allow to print images and formatting from
html field (either improve the current base_report_docx or change to Qweb)</li>
<li>add currency and multiple formatting improvements (page break between
deliverables for example)</li>
</ul>
<a name="bug-tracker"></a>
<h4>Bug Tracker</h4>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/business-requirement/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.</p>
<a name="credits"></a>
<h4>Credits</h4>
<a name="contributors"></a>
<h5>Contributors</h5>
<ul class="simple">
<li>Eric Caudal <<a class="reference external" href="mailto:eric.caudal@elico-corp.com">eric.caudal@elico-corp.com</a>></li>
<li>Siyuan Gu <<a class="reference external" href="mailto:gu.siyuan@elico-corp.com">gu.siyuan@elico-corp.com</a>></li>
<li>Victor M. Martin <<a class="reference external" href="mailto:victor.martin@elico-corp.com">victor.martin@elico-corp.com</a>></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>