mirror of
https://gitlab.com/flectra-community/reporting-engine.git
synced 2024-12-23 04:41:47 +00:00
104 lines
3.8 KiB
ReStructuredText
104 lines
3.8 KiB
ReStructuredText
|
=========================
|
||
|
|
Key Performance Indicator
|
||
|
|
=========================
|
||
|
|
|
||
|
|
..
|
||
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||
|
|
!! This file is generated by oca-gen-addon-readme !!
|
||
|
|
!! changes will be overwritten. !!
|
||
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||
|
|
!! source digest: sha256:bab100c970df23144ddd65ebc17acaebdebf29365a88a0102c8ba9f71f9e4631
|
||
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||
|
|
|
||
|
|
.. |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-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/17.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/reporting-engine-17-0/reporting-engine-17-0-kpi
|
||
|
|
: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/reporting-engine&target_branch=17.0
|
||
|
|
:alt: Try me on Runboat
|
||
|
|
|
||
|
|
|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), 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**
|
||
|
|
|
||
|
|
.. contents::
|
||
|
|
:local:
|
||
|
|
|
||
|
|
Usage
|
||
|
|
=====
|
||
|
|
|
||
|
|
Example of usage: https://www.youtube.com/watch?v=OC4-y2klzIk
|
||
|
|
|
||
|
|
Bug Tracker
|
||
|
|
===========
|
||
|
|
|
||
|
|
Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/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/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**>`_.
|
||
|
|
|
||
|
|
Do not contact contributors directly about support or help with technical issues.
|
||
|
|
|
||
|
|
Credits
|
||
|
|
=======
|
||
|
|
|
||
|
|
Authors
|
||
|
|
-------
|
||
|
|
|
||
|
|
* Savoir-faire Linux
|
||
|
|
|
||
|
|
Contributors
|
||
|
|
------------
|
||
|
|
|
||
|
|
- Daniel Reis <dreis.pt@hotmail.com>
|
||
|
|
- Glen Dromgoole <gdromgoole@tier1engineering.com>
|
||
|
|
- Loic Lacroix <loic.lacroix@savoirfairelinux.com>
|
||
|
|
- Sandy Carter <sandy.carter@savoirfairelinux.com>
|
||
|
|
- Gervais Naoussi <gervaisnaoussi@gmail.com>
|
||
|
|
- Iván Todorovich <ivan.todorovich@gmail.com>
|
||
|
|
- Adrià Gil <adria.gil@eficent.com>
|
||
|
|
- `Guadaltech <https://www.guadaltech.es>`__:
|
||
|
|
|
||
|
|
- Fernando La Chica <fernando.lachica@guadaltech.es>
|
||
|
|
|
||
|
|
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/reporting-engine <https://github.com/OCA/reporting-engine/tree/17.0/kpi>`_ project on GitHub.
|
||
|
|
|
||
|
|
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|