mirror of
https://github.com/OCA/reporting-engine.git
synced 2025-02-16 16:30:38 +02:00
7d8dd8877c
Meter widget is implemented with GaugeMeter (https://github.com/Mictronics/GaugeMeter). GaugeMeter provides a number of parameters to customize its display. See https://github.com/Mictronics/GaugeMeter#parameter-definitions for details. Allow user to customize GaugeMeter by setting the customization parameters in the result. This mechanism can be used to show actual values instead of percentages by setting total, used & showvalue parameter in the result. Fixes #428
122 lines
4.6 KiB
ReStructuredText
122 lines
4.6 KiB
ReStructuredText
=============
|
|
Kpi Dashboard
|
|
=============
|
|
|
|
..
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! This file is generated by oca-gen-addon-readme !!
|
|
!! changes will be overwritten. !!
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! source digest: sha256:3f7c1c23f7a3a6d0be24a8c1fdfd24dbca96ce6215e852d52674f9cf90f6c96f
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
|
|
.. |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/14.0/kpi_dashboard
|
|
: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-14-0/reporting-engine-14-0-kpi_dashboard
|
|
: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=14.0
|
|
:alt: Try me on Runboat
|
|
|
|
|badge1| |badge2| |badge3| |badge4| |badge5|
|
|
|
|
This module adds new kinds of dashboards on a specific new type of view.
|
|
|
|
**Table of contents**
|
|
|
|
.. contents::
|
|
:local:
|
|
|
|
Configuration
|
|
=============
|
|
|
|
Configure KPIs
|
|
~~~~~~~~~~~~~~
|
|
|
|
#. Access `Dashboards > Configuration > KPI Dashboards > Configure KPI`
|
|
#. Create a new KPI specifying the computation method and the kpi type
|
|
|
|
#. Number: result must contain a `value` and, if needed, a `previous`
|
|
#. Meter: To show a percentage value, result must contain `value`. `value` must be a positive integer between 0 to 100. Meter is implemented with GaugeMeter (https://github.com/Mictronics/GaugeMeter). It can be customized by setting parameters for GaugeMeter in result. See https://github.com/Mictronics/GaugeMeter#parameter-definitions for details.
|
|
#. Graph: result must contain a list on `graphs` containing `values`, `title` and `key`
|
|
|
|
#. In order to compute the KPI you can use a predefined function from a model or
|
|
use the code to directly compute it.
|
|
|
|
Using KPI with code
|
|
~~~~~~~~~~~~~~~~~~~
|
|
|
|
Define the code directly on the code field. You can use `self` and `model` as the kpi element
|
|
The script should create a variable called `result` as a dictionary that
|
|
will be stored as the value.
|
|
For example, we can use::
|
|
|
|
result = {}
|
|
result['value'] = len(model.search([('id', '=', %s)]))
|
|
result['previous'] = len(model.search([('id', '!=', %s)]))
|
|
|
|
Configure dashboards
|
|
~~~~~~~~~~~~~~~~~~~~
|
|
|
|
#. Access `Dashboards > Configuration > KPI Dashboards > Configure Dashboards`
|
|
#. Create a new dashboard and specify all the standard parameters on `Widget configuration`
|
|
#. Append elements on KPIs
|
|
#. You can preview the element using the dashboard view
|
|
#. You can create the menu entry directly using the `Generate menu` button
|
|
|
|
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_dashboard%0Aversion:%2014.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
|
|
~~~~~~~
|
|
|
|
* Creu Blanca
|
|
|
|
Contributors
|
|
~~~~~~~~~~~~
|
|
|
|
* Enric Tobella <etobella@creublanca.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.
|
|
|
|
.. |maintainer-etobella| image:: https://github.com/etobella.png?size=40px
|
|
:target: https://github.com/etobella
|
|
:alt: etobella
|
|
|
|
Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
|
|
|
|
|maintainer-etobella|
|
|
|
|
This module is part of the `OCA/reporting-engine <https://github.com/OCA/reporting-engine/tree/14.0/kpi_dashboard>`_ project on GitHub.
|
|
|
|
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|