You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

78 lines
2.3 KiB

  1. .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
  2. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  3. :alt: License: AGPL-3
  4. ===
  5. KPI
  6. ===
  7. This module provides the basis for creating key performance indicators,
  8. including static and dynamic thresholds (SQL query or Python code),
  9. on local and remote data sources.
  10. The module also provides the mecanism to update KPIs automatically.
  11. A scheduler is executed every hour and updates the KPI values, based
  12. on the periodicity of each KPI. KPI computation can also be done
  13. manually.
  14. A threshold is a list of ranges and a range is:
  15. * a name (like Good, Warning, Bad)
  16. * a minimum value (fixed, sql query or python code)
  17. * a maximum value (fixed, sql query or python code)
  18. * color (RGB code like #00FF00 for green, #FFA500 for orange, #FF0000 for red)
  19. Configuration
  20. =============
  21. Users must be added to the appropriate groups within Odoo as follows:
  22. * Creators: Settings > Users > Groups > Management System / User
  23. * Responsible Persons: Settings > Users > Groups > Management System / Approving User
  24. Usage
  25. =====
  26. https://www.youtube.com/watch?v=OC4-y2klzIk
  27. .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
  28. :alt: Try me on Runbot
  29. :target: https://runbot.odoo-community.org/runbot/128/9.0
  30. Known issues / Roadmap
  31. ======================
  32. * Use web_widget_color to display color associated to threshold range
  33. Bug Tracker
  34. ===========
  35. Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
  36. In case of trouble, please check there if your issue has already been reported.
  37. Credits
  38. =======
  39. Contributors
  40. ------------
  41. * Daniel Reis <dreis.pt@hotmail.com>
  42. * Glen Dromgoole <gdromgoole@tier1engineering.com>
  43. * Loic Lacroix <loic.lacroix@savoirfairelinux.com>
  44. * Sandy Carter <sandy.carter@savoirfairelinux.com>
  45. * Gervais Naoussi <gervaisnaoussi@gmail.com>
  46. * Iván Todorovich <ivan.todorovich@gmail.com>
  47. Maintainer
  48. ----------
  49. .. image:: https://odoo-community.org/logo.png
  50. :alt: Odoo Community Association
  51. :target: https://odoo-community.org
  52. This module is maintained by the OCA.
  53. OCA, or the Odoo Community Association, is a nonprofit organization whose
  54. mission is to support the collaborative development of Odoo features and
  55. promote its widespread use.
  56. To contribute to this module, please visit https://odoo-community.org.