Skip to main content

Create Dashboards using kpis

Project description

Beta License: AGPL-3 OCA/reporting-engine Translate me on Weblate Try me on Runboat

This module adds new kinds of dashboards on a specific new type of view.

Table of contents

Configuration

Configure KPIs

  1. Access Dashboards > Configuration > KPI Dashboards > Configure KPI

  2. Create a new KPI specifying the computation method and the kpi type

    1. Number: result must contain a value and, if needed, a previous

    2. 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.

    3. Graph: result must contain a list on graphs containing values, title and key

  3. 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

  1. Access Dashboards > Configuration > KPI Dashboards > Configure Dashboards

  2. Create a new dashboard and specify all the standard parameters on Widget configuration

  3. Append elements on KPIs

  4. You can preview the element using the dashboard view

  5. 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

Authors

  • Creu Blanca

Contributors

Maintainers

This module is maintained by the OCA.

Odoo Community Association

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:

etobella

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file odoo14_addon_kpi_dashboard-14.0.1.2.2.dev4-py3-none-any.whl.

File metadata

File hashes

Hashes for odoo14_addon_kpi_dashboard-14.0.1.2.2.dev4-py3-none-any.whl
Algorithm Hash digest
SHA256 20fecb6fd34c4635c04b13b8cb1dc8a7e35ce8ae2efc5e4bb09d409f456b24a2
MD5 e697b7a0920294c05d376082eab2c765
BLAKE2b-256 44cd95d5eb4c4baa7fb23bb4ee5035cdf5f003de5caec5a6b010e8772f9d8288

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page