diff --git a/kpi/README.rst b/kpi/README.rst index b565b535..3e86f937 100644 --- a/kpi/README.rst +++ b/kpi/README.rst @@ -10,20 +10,20 @@ Key Performance Indicator .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png :target: https://odoo-community.org/page/development-status :alt: Beta -.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png - :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html - :alt: License: LGPL-3 -.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github - :target: https://github.com/OCA/server-tools/tree/11.0/kpi - :alt: OCA/server-tools +.. |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%2Freporting--engine-lightgray.png?logo=github + :target: https://github.com/OCA/reporting-engine/tree/12.0/kpi + :alt: OCA/reporting-engine .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png - :target: https://translation.odoo-community.org/projects/server-tools-11-0/server-tools-11-0-kpi + :target: https://translation.odoo-community.org/projects/reporting-engine-12-0/reporting-engine-12-0-kpi :alt: Translate me on Weblate .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png - :target: https://runbot.odoo-community.org/runbot/253/11.0 + :target: https://runbot.odoo-community.org/runbot/143/12.0 :alt: Try me on Runbot -|badge1| |badge2| |badge3| |badge4| +|badge1| |badge2| |badge3| |badge4| |badge5| This module provides the basis for creating key performance indicators, including static and dynamic thresholds (SQL query or Python code), @@ -41,18 +41,10 @@ A threshold is a list of ranges and a range is: * a maximum value (fixed, sql query or python code) * color (RGB code like #00FF00 for green, #FFA500 for orange, #FF0000 for red) - **Table of contents** .. contents:: - :local: - -Configuration -============= - -Users must be added to the appropriate groups within Odoo as follows: -* Creators: Settings > Users > Groups > Management System / User -* Responsible Persons: Settings > Users > Groups > Management System / Approving User + :local: Usage ===== @@ -60,25 +52,24 @@ Usage Example of usage: https://www.youtube.com/watch?v=OC4-y2klzIk - -Known issues / Roadmap -====================== - -* Use web_widget_color to display color associated to threshold range - Bug Tracker =========== -Bugs are tracked on `GitHub Issues `_. +Bugs are tracked on `GitHub Issues `_. 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 `_. +`feedback `_. Do not contact contributors directly about support or help with technical issues. Credits ======= +Authors +~~~~~~~ + +* Savoir-faire Linux + Contributors ~~~~~~~~~~~~ @@ -88,6 +79,7 @@ Contributors * Sandy Carter * Gervais Naoussi * Iván Todorovich +* Adrià Gil Maintainers ~~~~~~~~~~~ @@ -102,6 +94,6 @@ 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/server-tools `_ project on GitHub. +This module is part of the `OCA/reporting-engine `_ project on GitHub. -You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. \ No newline at end of file +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/kpi/__init__.py b/kpi/__init__.py index 7988aa3f..69f7babd 100644 --- a/kpi/__init__.py +++ b/kpi/__init__.py @@ -1,4 +1,3 @@ -# Copyright 2012 - Now Savoir-faire Linux # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). from . import models diff --git a/kpi/__manifest__.py b/kpi/__manifest__.py index e52019c9..7ebaf1b4 100644 --- a/kpi/__manifest__.py +++ b/kpi/__manifest__.py @@ -3,7 +3,7 @@ { "name": "Key Performance Indicator", - "version": "11.0.1.0.0", + "version": "12.0.1.0.0", "author": "Savoir-faire Linux,Odoo Community Association (OCA)", "website": "http://www.savoirfairelinux.com", "license": "AGPL-3", diff --git a/kpi/models/__init__.py b/kpi/models/__init__.py index 7da5b448..ae1cb465 100644 --- a/kpi/models/__init__.py +++ b/kpi/models/__init__.py @@ -1,4 +1,3 @@ -# Copyright 2012 - Now Savoir-faire Linux # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). from . import kpi_category diff --git a/kpi/models/kpi_threshold_range.py b/kpi/models/kpi_threshold_range.py index d1b2d6b3..fb40b836 100644 --- a/kpi/models/kpi_threshold_range.py +++ b/kpi/models/kpi_threshold_range.py @@ -52,13 +52,14 @@ class KPIThresholdRange(models.Model): ('local', 'SQL - Local DB'), ('external', 'SQL - Externa DB'), ), 'Min Type', required=True) - min_value = fields.Float(string='Minimum', compute="_compute_min_value") - min_fixed_value = fields.Float('Minimum') + min_value = fields.Float(string='Minimum Value', + compute="_compute_min_value") + min_fixed_value = fields.Float('Minimum Fixed Value') min_code = fields.Text('Minimum Computation Code') - min_error = fields.Char('Error', compute="_compute_min_value") + min_error = fields.Char('Minimum Error', compute="_compute_min_value") min_dbsource_id = fields.Many2one( 'base.external.dbsource', - 'External DB Source', + 'External DB Source Minimum', ) max_type = fields.Selection(( ('static', 'Fixed value'), @@ -66,13 +67,14 @@ class KPIThresholdRange(models.Model): ('local', 'SQL - Local DB'), ('external', 'SQL - External DB'), ), 'Max Type', required=True) - max_value = fields.Float(string='Maximum', compute="_compute_max_value") - max_fixed_value = fields.Float('Maximum') + max_value = fields.Float(string='Maximum Value', + compute="_compute_max_value") + max_fixed_value = fields.Float('Maximum Fixed Value') max_code = fields.Text('Maximum Computation Code') - max_error = fields.Char('Error', compute="_compute_max_value") + max_error = fields.Char('Maximum Error', compute="_compute_max_value") max_dbsource_id = fields.Many2one( 'base.external.dbsource', - 'External DB Source', + 'External DB Source Maximum', ) color = fields.Char( diff --git a/kpi/security/ir.model.access.csv b/kpi/security/ir.model.access.csv index a01bf4dc..0d79d817 100644 --- a/kpi/security/ir.model.access.csv +++ b/kpi/security/ir.model.access.csv @@ -5,6 +5,7 @@ "access_kpi_threshold_user","kpi.threshold.user","model_kpi_threshold","base.group_user",1,0,0,0 "access_kpi_threshold_range_user","kpi.threshold.range.user","model_kpi_threshold_range","base.group_user",1,0,0,0 "access_kpi_manager","kpi.manager","model_kpi","kpi.group_kpi_manager",1,1,1,1 +"access_kpi_history_manager","kpi.history.user","model_kpi_history","kpi.group_kpi_manager",1,1,1,1 "access_kpi_category_manager","kpi.category.manager","model_kpi_category","kpi.group_kpi_manager",1,1,1,1 "access_kpi_threshold_manager","kpi.threshold.manager","model_kpi_threshold","kpi.group_kpi_manager",1,1,1,1 "access_kpi_threshold_range_manager","kpi.threshold.range.manager","model_kpi_threshold_range","kpi.group_kpi_manager",1,1,1,1 diff --git a/kpi/security/kpi_security.xml b/kpi/security/kpi_security.xml index 1fe99a28..64a20cca 100755 --- a/kpi/security/kpi_security.xml +++ b/kpi/security/kpi_security.xml @@ -7,7 +7,7 @@ Manage KPI's - + diff --git a/kpi/static/description/index.html b/kpi/static/description/index.html new file mode 100644 index 00000000..98c8501a --- /dev/null +++ b/kpi/static/description/index.html @@ -0,0 +1,422 @@ + + + + + + +Key Performance Indicator + + + +
+

Key Performance Indicator

+ + +

Beta License: AGPL-3 OCA/reporting-engine Translate me on Weblate Try me on Runbot

+

This module provides the basis for creating key performance indicators, +including static and dynamic thresholds (SQL query or Python code), +on local and remote data sources.

+

The module also provides the mecanism to update KPIs automatically. +A scheduler is executed every hour and updates the KPI values, based +on the periodicity of each KPI. KPI computation can also be done +manually.

+

A threshold is a list of ranges and a range is:

+
    +
  • a name (like Good, Warning, Bad)
    • +
  • a minimum value (fixed, sql query or python code)
    • +
  • a maximum value (fixed, sql query or python code)
    • +
  • color (RGB code like #00FF00 for green, #FFA500 for orange, #FF0000 for red)
    • +
+

Table of contents

+ + +
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +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.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Savoir-faire Linux
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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/reporting-engine project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/kpi/views/kpi_threshold_range_views.xml b/kpi/views/kpi_threshold_range_views.xml index b230c7e7..958cb77f 100644 --- a/kpi/views/kpi_threshold_range_views.xml +++ b/kpi/views/kpi_threshold_range_views.xml @@ -27,7 +27,7 @@ - + diff --git a/kpi/views/kpi_views.xml b/kpi/views/kpi_views.xml index a2f56f85..b8283b64 100644 --- a/kpi/views/kpi_views.xml +++ b/kpi/views/kpi_views.xml @@ -63,8 +63,8 @@ - - + +