mirror of
https://gitlab.com/flectra-community/reporting-engine.git
synced 2024-11-25 07:32:04 +00:00
118 lines
4.1 KiB
ReStructuredText
118 lines
4.1 KiB
ReStructuredText
|
=============
|
||
|
|
Kpi Dashboard
|
||
|
|
=============
|
||
|
|
|
||
|
|
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||
|
|
!! This file is generated by oca-gen-addon-readme !!
|
||
|
|
!! changes will be overwritten. !!
|
||
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||
|
|
|
||
|
|
.. |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/runbot-Try%20me-875A7B.png
|
||
|
|
:target: https://runbot.odoo-community.org/runbot/143/14.0
|
||
|
|
:alt: Try me on Runbot
|
||
|
|
|
||
|
|
|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: result must contain `value`, `min` and `max`
|
||
|
|
#. 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 smashing 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.
|