OCA reporting engine fork for dev and update.
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.

96 lines
3.4 KiB

  1. =============
  2. Kpi Dashboard
  3. =============
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github
  15. :target: https://github.com/OCA/reporting-engine/tree/12.0/kpi_dashboard
  16. :alt: OCA/reporting-engine
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/reporting-engine-12-0/reporting-engine-12-0-kpi_dashboard
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/143/12.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. This module adds new kinds of dashboards on a specific new type of view.
  25. **Table of contents**
  26. .. contents::
  27. :local:
  28. Configuration
  29. =============
  30. Configure KPIs
  31. ~~~~~~~~~~~~~~
  32. #. Access `Dashboards > Configuration > KPI Dashboards > Configure KPI`
  33. #. Create a new KPI specifying the computation method and the kpi type
  34. #. Number: result must contain a `value` and, if needed, a `previous`
  35. #. Meter: result must contain `value`, `min` and `max`
  36. #. Graph: result must contain a list on `graphs` containing `values`, `title` and `key`
  37. Configure dashboards
  38. ~~~~~~~~~~~~~~~~~~~~
  39. #. Access `Dashboards > Configuration > KPI Dashboards > Configure Dashboards`
  40. #. Create a new dashboard and specify all the standard parameters on `Widget configuration`
  41. #. Append elements on KPIs
  42. #. You can preview the element using the dashboard view
  43. #. You can create the menu entry directly using the `Generate menu` button
  44. Bug Tracker
  45. ===========
  46. Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/issues>`_.
  47. In case of trouble, please check there if your issue has already been reported.
  48. If you spotted it first, help us smashing it by providing a detailed and welcomed
  49. `feedback <https://github.com/OCA/reporting-engine/issues/new?body=module:%20kpi_dashboard%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  50. Do not contact contributors directly about support or help with technical issues.
  51. Credits
  52. =======
  53. Authors
  54. ~~~~~~~
  55. * Creu Blanca
  56. Contributors
  57. ~~~~~~~~~~~~
  58. * Enric Tobella <etobella@creublanca.es>
  59. Maintainers
  60. ~~~~~~~~~~~
  61. This module is maintained by the OCA.
  62. .. image:: https://odoo-community.org/logo.png
  63. :alt: Odoo Community Association
  64. :target: https://odoo-community.org
  65. OCA, or the Odoo Community Association, is a nonprofit organization whose
  66. mission is to support the collaborative development of Odoo features and
  67. promote its widespread use.
  68. This module is part of the `OCA/reporting-engine <https://github.com/OCA/reporting-engine/tree/12.0/kpi_dashboard>`_ project on GitHub.
  69. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.