Add project_forecast_line, project_forecast_line_bokeh_chart, web_wid…

…get_bokeh_chart OCA/project#1247 OCA/project#1265
onesteinbv · Nov 15, 2024 · a567f2e · a567f2e
1 parent fd684a3
commit a567f2e
Show file tree

Hide file tree

Showing 84 changed files with 9,603 additions and 0 deletions.
diff --git a/project_forecast_line/README.rst b/project_forecast_line/README.rst
@@ -0,0 +1,174 @@
+======================
+Project Forecast Lines
+======================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:f6a3feb1d9b6593b5322c73cc13b475f38f01898496e691b2b2efc14fe320404
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Alpha
+.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fproject-lightgray.png?logo=github
+    :target: https://github.com/OCA/project/tree/16.0/project_forecast_line
+    :alt: OCA/project
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/project-16-0/project-16-0-project_forecast_line
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/project&target_branch=16.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+This module allows to plan your resources using forecast lines.
+
+For each employee of the company, the module will generate forecast line
+records with a positive capacity based on their working time schedules. Then,
+tasks assigned to employees will generate forecast lines with a negative
+capacity which will "consume" the work time capacity of the employees.
+
+The idea is that you can then see the work capacity and scheduled work of
+people by summing the "forecasts" per time period. If you have more resources
+(positive forecast) than work (negative forecast) you will have a positive net
+sum. Otherwise you are in trouble and need to recruit or reschedule your
+work. Another way to use the report is checking when the work capacity of a
+department becomes positive (or high enough) in order to provide you potential
+customers with an estimate of when a project would be able to start.
+
+Forecast lines also come in two states "forecast" or "confirmed", depending on
+whether the consumption is confirmed or not. For instance, holidays requests
+and sales quotation lines create lines of type "forecast", whereas tasks for
+project which are in a running state create lines with type "confirmed".
+
+To get the best experience using the Forecast application you may want to install:
+
+* project_forecast_line_holidays_public module which takes public holidays into
+  account during forecast lines creation
+
+* project_forecast_line_bokeh_chart module which improves the reports of
+  project_forecast_line module by using the bokeh widget available in OCA/web
+
+.. IMPORTANT::
+   This is an alpha version, the data model and design can change at any time without warning.
+   Only for development or testing purpose, do not use in production.
+   `More details on development status <https://odoo-community.org/page/development-status>`_
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Usage
+=====
+
+Forecast lines have the following data:
+
+* Forecast hours: it is positive for resources (employees) and negative for
+  things which consume time (project tasks, for instance)
+
+* From and To date which are the beginning and ending of the period of the
+  capacity
+
+* Consolidated forecast: this is a computed field, which is computed as follows:
+
+  * for costs (project tasks for instance) we take the absolute value of the
+    forecast hours (so it is a positive number)
+
+  * for resources (employee capacity for a period), we take the capacity and
+    substract all the costs for that employee on the same period. So it will be
+    positive if the employee still has some free time, and negative if he is
+    overloaded with work.
+
+  * this consolidated forecast is currently converted to days to ease
+    readability of the forecast report
+
+
+Objects creating forecast lines:
+
+* employees with a forecast role will create forecast line with a positive
+  capacity and type "confirmed" for each day on which they work. This
+  information comes from their work calendar, and the different roles that are
+  linked to the employee.
+
+* draft sale orders (if enabled in the settings) will create forecast lines of
+  type "forecast" for each sale order line having a product with a forecast
+  role and start and end dates. The forecast hours are negative
+
+* confirmed sale orders don't create forecast lines. This is handled by the
+  tasks created at the confirmation of the sale order
+
+* project tasks create forecast lines if they have a linked role and planned start/end
+  dates. The type of the line will depend on the related project's stage. The
+  `forecast_hours` field is based on the remaining time of the task, which is spread
+  on the work days of the planned start and end date of the task. If the
+  current date is in the middle of the planned duration of the task, it is used
+  as the start date. If the planned end date is in the past the task does not
+  generate forecast lines (and you need to fix your planning). In case multiple
+  employees are assigned to the task the forecast is split equally between
+  them.
+
+* holiday requests create negative forecast lines with type "forecast" when
+  they are pending manager validation.
+
+* Validated holiday requests do not generate forecast lines, as they alter the
+  work calendar of the employee: the employee will not have a positive line
+  associated to his leave days.
+
+The creation of forecast lines is done either in real time when some actions
+are performed by the user (requesting leaves, updating the remaining time on a
+project task, timesheeting) and also via a cron that runs on a daily basis. The
+cron is required to cleanup lines related to dates in the past and to recompute
+the lines related to project tasks by computing the ratio of remaing time on
+the tasks on the remaining days, for tasks which are in progress. So, to start
+using consolidated forecast report you first need to set everything mentioned
+in Usage section. Then, probably run Forecast recomputation cron manually from
+Scheduled Actions or wait till cron creates records.
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/project/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us to smash it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/project/issues/new?body=module:%20project_forecast_line%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+~~~~~~~
+
+* Camptocamp SA
+
+Contributors
+~~~~~~~~~~~~
+
+* Alexandre Fayolle <[email protected]>
+* Maksym Yankin <[email protected]>
+
+Maintainers
+~~~~~~~~~~~
+
+This module is maintained by the OCA.
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+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.
+
+This module is part of the `OCA/project <https://github.com/OCA/project/tree/16.0/project_forecast_line>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
diff --git a/project_forecast_line/__init__.py b/project_forecast_line/__init__.py
@@ -0,0 +1 @@
+from . import models
diff --git a/project_forecast_line/__manifest__.py b/project_forecast_line/__manifest__.py
@@ -0,0 +1,38 @@
+# Copyright 2022 Camptocamp SA
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+{
+    "name": "Project Forecast Lines",
+    "summary": "Project Forecast Lines",
+    "version": "16.0.1.0.0",
+    "author": "Camptocamp SA, Odoo Community Association (OCA)",
+    "license": "AGPL-3",
+    "category": "Project",
+    "website": "https://github.com/OCA/project",
+    "depends": ["sale_timesheet", "sale_project", "hr_holidays"],
+    "data": [
+        "security/forecast_line_security.xml",
+        "security/ir.model.access.csv",
+        "views/sale_order_views.xml",
+        "views/hr_employee_views.xml",
+        "views/forecast_line_views.xml",
+        "views/forecast_role_views.xml",
+        "views/product_views.xml",
+        "views/project_task_views.xml",
+        "views/project_project_stage_views.xml",
+        "views/res_config_settings_views.xml",
+        "data/ir_cron.xml",
+        "data/project_data.xml",
+    ],
+    "demo": [
+        "demo/res_users.xml",
+        "demo/forecast_role.xml",
+        "demo/hr_job.xml",
+        "demo/hr_employee.xml",
+        "demo/product.xml",
+        "demo/project.xml",
+        "demo/sale.xml",
+    ],
+    "installable": True,
+    "development_status": "Alpha",
+    "application": True,
+}
diff --git a/project_forecast_line/data/ir_cron.xml b/project_forecast_line/data/ir_cron.xml
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<odoo>
+    <record id="cron_forecast_lines" model="ir.cron">
+        <field name="name">Forecast recomputation</field>
+        <field name="model_id" ref="project_forecast_line.model_forecast_line" />
+        <field name="user_id" ref="base.user_root" />
+        <field name="state">code</field>
+        <field name="code">model._cron_recompute_all()</field>
+        <field name="interval_number">1</field>
+        <field name="interval_type">days</field>
+        <field name="numbercall">-1</field>
+        <field name="doall" eval="False" />
+    </record>
+</odoo>
diff --git a/project_forecast_line/data/project_data.xml b/project_forecast_line/data/project_data.xml
@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<odoo>
+    <!-- Project Stages -->
+    <record id="project.project_project_stage_0" model="project.project.stage">
+        <field name="forecast_line_type">forecast</field>
+    </record>
+
+    <record id="project.project_project_stage_1" model="project.project.stage">
+        <field name="forecast_line_type">confirmed</field>
+    </record>
+
+    <record id="project.project_project_stage_2" model="project.project.stage">
+        <field name="forecast_line_type" />
+    </record>
+
+    <record id="project.project_project_stage_3" model="project.project.stage">
+        <field name="forecast_line_type" />
+    </record>
+</odoo>
diff --git a/project_forecast_line/demo/forecast_role.xml b/project_forecast_line/demo/forecast_role.xml
@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<odoo>
+    <record id="forecast_role_pm" model="forecast.role">
+        <field name="name">Project Manager</field>
+        <field name="description">Takes care of project management tasks</field>
+    </record>
+    <record id="forecast_role_consultant" model="forecast.role">
+        <field name="name">Consultant</field>
+        <field name="description">Takes care of business analysis</field>
+    </record>
+    <record id="forecast_role_dev" model="forecast.role">
+        <field name="name">Software Development</field>
+        <field name="description">Takes care of writing code and solving bugs</field>
+    </record>
+</odoo>
diff --git a/project_forecast_line/demo/hr_employee.xml b/project_forecast_line/demo/hr_employee.xml
@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<odoo>
+    <record id="role_employee_mit" model="hr.employee.forecast.role">
+        <field name="employee_id" ref="hr.employee_mit" />
+        <field name="role_id" ref="forecast_role_dev" />
+    </record>
+    <record id="role_employee_niv" model="hr.employee.forecast.role">
+        <field name="employee_id" ref="hr.employee_niv" />
+        <field name="role_id" ref="forecast_role_dev" />
+    </record>
+        <record id="role_employee_stw" model="hr.employee.forecast.role">
+        <field name="employee_id" ref="hr.employee_stw" />
+        <field name="role_id" ref="forecast_role_dev" />
+    </record>
+    <record id="role_employee_chs" model="hr.employee.forecast.role">
+        <field name="employee_id" ref="hr.employee_chs" />
+        <field name="role_id" ref="forecast_role_dev" />
+    </record>
+    <record id="role_employee_qdp" model="hr.employee.forecast.role">
+        <field name="employee_id" ref="hr.employee_qdp" />
+        <field name="role_id" ref="forecast_role_dev" />
+    </record>
+    <record id="role_employee_fme" model="hr.employee.forecast.role">
+        <field name="employee_id" ref="hr.employee_fme" />
+        <field name="role_id" ref="forecast_role_dev" />
+    </record>
+    <record id="role_employee_fpi_consultant" model="hr.employee.forecast.role">
+        <field name="employee_id" ref="hr.employee_fpi" />
+        <field name="role_id" ref="forecast_role_consultant" />
+        <field name="rate" eval="60" />
+    </record>
+    <record id="role_employee_fpi_pm" model="hr.employee.forecast.role">
+        <field name="employee_id" ref="hr.employee_fpi" />
+        <field name="role_id" ref="forecast_role_pm" />
+        <field name="rate" eval="40" />
+    </record>
+    <record id="role_employee_jth" model="hr.employee.forecast.role">
+        <field name="employee_id" ref="hr.employee_jth" />
+        <field name="role_id" ref="forecast_role_consultant" />
+    </record>
+    <record id="role_employee_han" model="hr.employee.forecast.role">
+        <field name="employee_id" ref="hr.employee_han" />
+        <field name="role_id" ref="forecast_role_dev" />
+    </record>
+    <record id="role_employee_jve" model="hr.employee.forecast.role">
+        <field name="employee_id" ref="hr.employee_jve" />
+        <field name="role_id" ref="forecast_role_dev" />
+    </record>
+    <record id="role_employee_jep" model="hr.employee.forecast.role">
+        <field name="employee_id" ref="hr.employee_jep" />
+        <field name="role_id" ref="forecast_role_consultant" />
+    </record>
+    <record id="role_employee_jog" model="hr.employee.forecast.role">
+        <field name="employee_id" ref="hr.employee_jog" />
+        <field name="role_id" ref="forecast_role_dev" />
+    </record>
+    <record id="role_employee_jgo" model="hr.employee.forecast.role">
+        <field name="employee_id" ref="hr.employee_jgo" />
+        <field name="role_id" ref="forecast_role_consultant" />
+    </record>
+    <record id="role_employee_hne" model="hr.employee.forecast.role">
+        <field name="employee_id" ref="hr.employee_hne" />
+        <field name="role_id" ref="forecast_role_consultant" />
+    </record>
+
+</odoo>
diff --git a/project_forecast_line/demo/hr_job.xml b/project_forecast_line/demo/hr_job.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<odoo>
+    <record id="hr.job_consultant" model="hr.job">
+        <field name="role_id" ref="forecast_role_consultant" />
+    </record>
+    <record id="hr.job_developer" model="hr.job">
+        <field name="role_id" ref="forecast_role_dev" />
+    </record>
+</odoo>
diff --git a/project_forecast_line/demo/product.xml b/project_forecast_line/demo/product.xml
@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<odoo>
+    <record id="product_product_consultant" model="product.product">
+        <field name="name">Consultant</field>
+        <field name="categ_id" ref="product.product_category_1" />
+        <field name="standard_price">80</field>
+        <field name="list_price">120</field>
+        <field name="detailed_type">service</field>
+        <field name="uom_id" ref="uom.product_uom_hour" />
+        <field name="uom_po_id" ref="uom.product_uom_hour" />
+        <field name="forecast_role_id" ref="forecast_role_consultant" />
+        <field name="service_tracking">task_in_project</field>
+        <field name="service_policy">delivered_timesheet</field>
+    </record>
+    <record id="product_product_pm" model="product.product">
+        <field name="name">Project Manager</field>
+        <field name="categ_id" ref="product.product_category_1" />
+        <field name="standard_price">950</field>
+        <field name="list_price">150</field>
+        <field name="detailed_type">service</field>
+        <field name="uom_id" ref="uom.product_uom_hour" />
+        <field name="uom_po_id" ref="uom.product_uom_hour" />
+        <field name="forecast_role_id" ref="forecast_role_pm" />
+        <field name="service_tracking">task_in_project</field>
+        <field name="service_policy">delivered_timesheet</field>
+    </record>
+    <record id="product_product_dev" model="product.product">
+        <field name="name">Software Developer</field>
+        <field name="categ_id" ref="product.product_category_1" />
+        <field name="standard_price">80</field>
+        <field name="list_price">120</field>
+        <field name="detailed_type">service</field>
+        <field name="uom_id" ref="uom.product_uom_hour" />
+        <field name="uom_po_id" ref="uom.product_uom_hour" />
+        <field name="forecast_role_id" ref="forecast_role_dev" />
+        <field name="service_tracking">task_in_project</field>
+        <field name="service_policy">delivered_timesheet</field>
+    </record>
+
+</odoo>