mirror of
https://github.com/OCA/reporting-engine.git
synced 2025-02-16 16:30:38 +02:00
e14f77b618
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
34 lines
1.6 KiB
ReStructuredText
34 lines
1.6 KiB
ReStructuredText
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
|