TIP: You can type at any time to perform a new search.

Business Requirement

business_requirement · OCA/business-requirement

    Security findings

    Repository
    OCA/business-requirement · module folder · Try on Runboat
    Module version
    Category
    Business Requirements Management
    Folder size
    1.48 MB
    License
    AGPL-3
    Application
    Yes
    Auto-installable
    No
    Website
    https://github.com/OCA/business-requirement
    Last tracking update
    2026-09-28 13:41:36
    Authors
    Odoo Community Association (OCA), Elico Corp, Tecnativa
    Maintainers
    Odoo Community Association (OCA), Elico Corp, Tecnativa
    Committers
    Weblate, OCA-git-bot, oca-ci, szalatyzuzanna
    Odoo dependencies
    odoo/odoo:
    - product
    - base
    - mail
    - base_setup
    - web
    - bus
    - web_tour
    - html_editor
    - uom
    - portal
    - web_editor
    - http_routing
    - auth_signup
    Python dependencies
    None
    System dependencies
    None
    Required by
    business_requirement_crm, business_requirement_deliverable, business_requirement_rice
    Description
    A **Business requirement** (BR) is the expression of a business need by
a customer or internal project user.

A BR contains multiple different parts to explain the stakeholder need
and how to meet his/her requirements:

- **Customer Story**: this is the requirement as expressed by the
  customer
- **Scenario**: How/where the current solution can provide a suitable
  scenario to answer the customer story
- **Gap**: For the uncovered part of the scenario, elaborate the
  gap/need for specific developments/setup
- **Test case**: A set of conditions under which a tester will determine
  whether the application, software system or one of its features is
  working as it was originally established for it to do.
- **Deliverables** to be provided to the customer/user
- **Resources** necessary to achieve the deliverables
- **Additional** information (approval, cost control etc.)

This set of modules was originally designed for the service/IT industry
but the requirement management design has been kept as generic as
possible so that it can apply to many other cases/industries (customer
or internal projects):

- Construction
- Trading (New product development)
- Business Consultancy
- Web or IT development
- R&D projects
- etc.

More information about business requirements management:

- [Wikipedia](https://en.wikipedia.org/wiki/Business_requirements)
- [Six
  Sigma](https://www.isixsigma.com/implementation/project-selection-tracking/business-requirements-document-high-level-review/)

    Code Analysis info_outline

    Views touched (18)
    XML IDNameModelTypeStatus
    br_report br_report ir.ui.view qweb New
    layout_br_report layout_br_report ir.ui.view qweb New
    layout_br_report_body layout_br_report_body ir.ui.view qweb New
    layout_br_report_header layout_br_report_header ir.ui.view qweb New
    portal_br_error Business requirement error/warning display ir.ui.view qweb New
    portal_br_page Business Requirement ir.ui.view qweb New
    portal_br_success Business requirement success display ir.ui.view qweb New
    portal_my_br My Business Requirements ir.ui.view qweb New
    portal_my_home_br Portal My Home : business requirements entries ir.ui.view qweb Inherits portal.portal_my_home
    portal_my_home_menu_br Portal layout : business requirement menu entries ir.ui.view qweb Inherits portal.portal_breadcrumbs
    view_business_requirement_category_form business.requirement.category.form business.requirement.category form New
    view_business_requirement_category_tree business.requirement.category.list business.requirement.category list New
    view_business_requirement_form business.requirement.form business.requirement form New
    view_business_requirement_graph Business requirement business.requirement graph New
    view_business_requirement_kanban_project business.requirement.kanban business.requirement kanban New
    view_business_requirement_pivot Business requirement business.requirement pivot New
    view_business_requirement_search business.requirement.search business.requirement search New
    view_business_requirement_tree business.requirement.list business.requirement list New
    HTTP endpoints (3)
    Route(s)HandlerAuthTypeMethodsFlags
    /my/business_requirement/<int:br_id> CustomerPortal.portal_br_page public http ALL website
    /my/business_requirement/pdf/<int:br_id> CustomerPortal.portal_br_report public http ALL sudo website
    /my/business_requirements, /my/business_requirements/page/<int:page> CustomerPortal.portal_my_br user http ALL sudo website
    Models touched (2)

    New fields (27)
    • approval_date Datetime
      copy=False readonly=True
    • approved_id Many2one → res.users
      comodel_name='res.users' copy=False readonly=True string='Approved by'
    • business_requirement Html
      string='Customer Story'
    • category_ids Many2many → business.requirement.category
      comodel_name='business.requirement.category' relation='business_requirement_category_rel' string='Categories'
    • change_request Boolean
      string='Change Request?'
    • company_id Many2one → res.company
      comodel_name='res.company' default=<expr> required=True string='Company'
    • confirmation_date Datetime
      copy=False readonly=True
    • confirmed_user_id Many2one → res.users
      comodel_name='res.users' copy=False readonly=True string='Confirmed by'
    • date Date
      default=<expr> required=True
    • description Char
      required=True
    • gap Html
    • kanban_state Selection
      default='normal' selection=[('normal', 'In Progress'), ('on_hold', 'On Hold'), ('done', 'Ready for next stage')] tracking=True
    • name Char
      copy=False
    • origin Char
      string='Source'
    • partner_id Many2one → res.partner
      comodel_name='res.partner' copy=False string='Stakeholder'
    • portal_published Boolean
      default=False args: 'In Portal'
    • priority Selection
      default='1' required=True selection=[('0', 'Low'), ('1', 'Normal'), ('2', 'High')]
    • requested_user_id Many2one → res.users
      comodel_name='res.users' default=<expr> required=True string='Requested by'
    • responsible_user_id Many2one → res.users
      comodel_name='res.users' copy=False default=<expr> string='Responsible'
    • reviewer_ids Many2many → res.users
      comodel_name='res.users' copy=False string='Reviewers'
    • scenario Html
    • sequence Char
      copy=False index=True readonly=True
    • state Selection
      copy=False default='draft' group_expand=True selection=[('draft', 'Draft'), ('confirmed', 'Confirmed'), ('approved', 'Approved'), ('in_progress', 'In progress'), ('done', 'Done'), ('cancel', 'Cancel'), ('drop', 'Drop')] tracking=True
    • terms_and_conditions Html
    • test_case Html
    • to_be_reviewed Boolean
    • user_id Many2one → res.users
      comodel_name='res.users' default=<expr> required=True string='Owner' tracking=True
    Public methods (5)
    • create(self, vals_list)
      @api.model_create_multi
    • get_portal_confirmation_action(self)
    • message_post(self, **kwargs)
      @api.returns('mail.message', <expr>)
    • portal_publish_button(self)
    • write(self, vals)

    New fields (2)
    • name Char
      required=True
    • parent_id Many2one → business.requirement.category
      comodel_name='business.requirement.category' ondelete='restrict' string='Parent Category'
    Public methods (0)

    No public methods.

    Loading…

    Loading…

    Loading…

    Loading…

    Loading…

    Loading…

    Loading…

    Loading…

    Loading…

    Status
    Open migration PR — not merged yet for this version
    CI status
    green — ready to merge
    Open since
    73 days ago
    Last activity
    73 days ago
    Repository
    OCA/business-requirement
    Pull request
    [17.0][MIG] business_requirement: Migration to 17.0 (#394)