This module adds new kinds of dashboards on a specific new type of view.
Table of contents
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, aprevious
- 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
containingvalues
,title
andkey
- Number: result must contain a
- 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. 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.
Do not contact contributors directly about support or help with technical issues.
Credits
Contributors
- Enric Tobella <etobella@creublanca.es>
Maintainers
This module is maintained by the OCA.
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.
Current maintainer:
This module is part of the OCA/reporting-engine project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.