|
| 1 | +========================= |
| 2 | +Key Performance Indicator |
| 3 | +========================= |
| 4 | + |
| 5 | +.. |
| 6 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 7 | + !! This file is generated by oca-gen-addon-readme !! |
| 8 | + !! changes will be overwritten. !! |
| 9 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 10 | + !! source digest: sha256:cfa60f307c1347dd86421388daf4ddf0cef49cfe864c034368a4b031d2dc045c |
| 11 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 12 | +
|
| 13 | +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png |
| 14 | + :target: https://odoo-community.org/page/development-status |
| 15 | + :alt: Beta |
| 16 | +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png |
| 17 | + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html |
| 18 | + :alt: License: AGPL-3 |
| 19 | +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github |
| 20 | + :target: https://github.com/OCA/reporting-engine/tree/17.0/kpi |
| 21 | + :alt: OCA/reporting-engine |
| 22 | +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png |
| 23 | + :target: https://translation.odoo-community.org/projects/reporting-engine-17-0/reporting-engine-17-0-kpi |
| 24 | + :alt: Translate me on Weblate |
| 25 | +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png |
| 26 | + :target: https://runboat.odoo-community.org/builds?repo=OCA/reporting-engine&target_branch=17.0 |
| 27 | + :alt: Try me on Runboat |
| 28 | + |
| 29 | +|badge1| |badge2| |badge3| |badge4| |badge5| |
| 30 | + |
| 31 | +This module provides the basis for creating key performance indicators, |
| 32 | +including static and dynamic thresholds (SQL query or Python code), on |
| 33 | +local and remote data sources. |
| 34 | + |
| 35 | +The module also provides the mecanism to update KPIs automatically. A |
| 36 | +scheduler is executed every hour and updates the KPI values, based on |
| 37 | +the periodicity of each KPI. KPI computation can also be done manually. |
| 38 | + |
| 39 | +A threshold is a list of ranges and a range is: |
| 40 | + |
| 41 | +- a name (like Good, Warning, Bad) |
| 42 | +- a minimum value (fixed, sql query or python code) |
| 43 | +- a maximum value (fixed, sql query or python code) |
| 44 | +- color (RGB code like #00FF00 for green, #FFA500 for orange, #FF0000 |
| 45 | + for red) |
| 46 | + |
| 47 | +**Table of contents** |
| 48 | + |
| 49 | +.. contents:: |
| 50 | + :local: |
| 51 | + |
| 52 | +Usage |
| 53 | +===== |
| 54 | + |
| 55 | +Example of usage: https://www.youtube.com/watch?v=OC4-y2klzIk |
| 56 | + |
| 57 | +Bug Tracker |
| 58 | +=========== |
| 59 | + |
| 60 | +Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/issues>`_. |
| 61 | +In case of trouble, please check there if your issue has already been reported. |
| 62 | +If you spotted it first, help us to smash it by providing a detailed and welcomed |
| 63 | +`feedback <https://github.com/OCA/reporting-engine/issues/new?body=module:%20kpi%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_. |
| 64 | + |
| 65 | +Do not contact contributors directly about support or help with technical issues. |
| 66 | + |
| 67 | +Credits |
| 68 | +======= |
| 69 | + |
| 70 | +Authors |
| 71 | +------- |
| 72 | + |
| 73 | +* Savoir-faire Linux |
| 74 | + |
| 75 | +Contributors |
| 76 | +------------ |
| 77 | + |
| 78 | +- Daniel Reis <dreis.pt@hotmail.com> |
| 79 | +- Glen Dromgoole <gdromgoole@tier1engineering.com> |
| 80 | +- Loic Lacroix <loic.lacroix@savoirfairelinux.com> |
| 81 | +- Sandy Carter <sandy.carter@savoirfairelinux.com> |
| 82 | +- Gervais Naoussi <gervaisnaoussi@gmail.com> |
| 83 | +- Iván Todorovich <ivan.todorovich@gmail.com> |
| 84 | +- Adrià Gil <adria.gil@eficent.com> |
| 85 | +- `Guadaltech <https://www.guadaltech.es>`__: |
| 86 | + |
| 87 | + - Fernando La Chica <fernando.lachica@guadaltech.es> |
| 88 | + |
| 89 | +Maintainers |
| 90 | +----------- |
| 91 | + |
| 92 | +This module is maintained by the OCA. |
| 93 | + |
| 94 | +.. image:: https://odoo-community.org/logo.png |
| 95 | + :alt: Odoo Community Association |
| 96 | + :target: https://odoo-community.org |
| 97 | + |
| 98 | +OCA, or the Odoo Community Association, is a nonprofit organization whose |
| 99 | +mission is to support the collaborative development of Odoo features and |
| 100 | +promote its widespread use. |
| 101 | + |
| 102 | +This module is part of the `OCA/reporting-engine <https://github.com/OCA/reporting-engine/tree/17.0/kpi>`_ project on GitHub. |
| 103 | + |
| 104 | +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. |
0 commit comments