# Kpi Dashboard

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

Table of contents

- Configuration
  - Configure KPIs
  - Using KPI with code
  - Configure dashboards
- Bug Tracker
- Credits
  - Authors
  - Contributors
  - Maintainers

# 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: result must contain value, min and max
   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 smashing 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

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