OCA reporting engine fork for dev and update.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

33 lines
1.3 KiB

  1. Configure KPIs
  2. ~~~~~~~~~~~~~~
  3. #. Access `Dashboards > Configuration > KPI Dashboards > Configure KPI`
  4. #. Create a new KPI specifying the computation method and the kpi type
  5. #. Number: result must contain a `value` and, if needed, a `previous`
  6. #. Meter: result must contain `value`, `min` and `max`
  7. #. Graph: result must contain a list on `graphs` containing `values`, `title` and `key`
  8. #. In order to compute the KPI you can use a predefined function from a model or
  9. use the code to directly compute it.
  10. Using KPI with code
  11. ~~~~~~~~~~~~~~~~~~~
  12. Define the code directly on the code field. You can use `self` and `model` as the kpi element
  13. The script should create a variable called `result` as a dictionary that
  14. will be stored as the value.
  15. For example, we can use::
  16. result = {}
  17. result['value'] = len(model.search([('id', '=', %s)]))
  18. result['previous'] = len(model.search([('id', '!=', %s)]))
  19. Configure dashboards
  20. ~~~~~~~~~~~~~~~~~~~~
  21. #. Access `Dashboards > Configuration > KPI Dashboards > Configure Dashboards`
  22. #. Create a new dashboard and specify all the standard parameters on `Widget configuration`
  23. #. Append elements on KPIs
  24. #. You can preview the element using the dashboard view
  25. #. You can create the menu entry directly using the `Generate menu` button