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.

136 lines
5.3 KiB

  1. ==============
  2. BI View Editor
  3. ==============
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github
  15. :target: https://github.com/OCA/reporting-engine/tree/11.0/bi_view_editor
  16. :alt: OCA/reporting-engine
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/reporting-engine-11-0/reporting-engine-11-0-bi_view_editor
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/143/11.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. BI View Editor is a tool integrated in Odoo that allows users define and
  25. execute their own reports without the need to code.
  26. Purpose:
  27. * The BI View Editor is used to create reports not already contained in the
  28. standard Odoo, combining data from existing sources.
  29. * It has been designed to be used by users with little or no knowledge of
  30. the technical architecture of Odoo. Users visually link business objects
  31. and select the fields to visualize.
  32. * The BI View Editor offers users different types of representations,
  33. including tree, graph, pivot views.
  34. **Table of contents**
  35. .. contents::
  36. :local:
  37. Usage
  38. =====
  39. To graphically design your analysis data-set:
  40. - From the Dashboards menu, select "Custom BI Views"
  41. - Browse trough the business objects in the Query tab
  42. - Pick the interesting fields (Drag & Drop)
  43. - For each selected field, right-click on the Options column and select whether it's a row, column or measure; if you want to remove the field from the list view, unflag the checkbox ´List´ in the Options column
  44. - Save and click "Generate BI View"
  45. - Click "Open BI View" to view the result
  46. - If module Dashboard (board) is installed, the standard "Add to My Dashboard" functionality would be available
  47. - Click "Create a menu" to create a new menu item directly linked to your new BI view (this feature is available in developer mode); when the BI view is reset back to draft this menu will be removed, and you will need to re-create the menu entry.
  48. Known issues / Roadmap
  49. ======================
  50. * Non-stored fields and many2many fields are not supported
  51. * Provide graph view for table relations
  52. * Extend the capabilities of the tree views (e.g. add sums)
  53. * Provide a tutorial (eg. a working example of usage)
  54. * Implement a more advanced UI, with possibilities to use LEFT JOIN as default instead of INNER JOIN
  55. * Find better ways to extend the *_auto_init()* without override
  56. * Possibly avoid the monkey patches
  57. * Data the user has no access to (e.g. in a multi company situation) can be viewed by making a view
  58. * Store the JSON data structure in ORM
  59. * Would be nice if models available to select when creating a view are limited to the ones that have intersecting groups (for non technical users)
  60. Bug Tracker
  61. ===========
  62. Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/issues>`_.
  63. In case of trouble, please check there if your issue has already been reported.
  64. If you spotted it first, help us smashing it by providing a detailed and welcomed
  65. `feedback <https://github.com/OCA/reporting-engine/issues/new?body=module:%20bi_view_editor%0Aversion:%2011.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  66. Do not contact contributors directly about support or help with technical issues.
  67. Credits
  68. =======
  69. Authors
  70. ~~~~~~~
  71. * Onestein
  72. Contributors
  73. ~~~~~~~~~~~~
  74. * Simon Janssens <s.janssens@onestein.nl>
  75. * Diego Luis Neto <diegoluis.neto@gmail.com>
  76. * Dennis Sluijk <d.sluijk@onestein.nl>
  77. * Kevin Graveman <k.graveman@onestein.nl>
  78. * Richard Dijkstra <r.dijkstra@onestein.nl>
  79. * Andrea Stirpe <a.stirpe@onestein.nl>
  80. * Antonio Esposito <a.esposito@onestein.nl>
  81. * Jordi Ballester Alomar <jordi.ballester@eficent.com>
  82. Other credits
  83. ~~~~~~~~~~~~~
  84. Images
  85. ------
  86. * Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_.
  87. Funders
  88. -------
  89. The development of this module has been financially supported by:
  90. * IDEAL Connaissances SAS https://www.idealconnaissances.com
  91. Maintainers
  92. ~~~~~~~~~~~
  93. This module is maintained by the OCA.
  94. .. image:: https://odoo-community.org/logo.png
  95. :alt: Odoo Community Association
  96. :target: https://odoo-community.org
  97. OCA, or the Odoo Community Association, is a nonprofit organization whose
  98. mission is to support the collaborative development of Odoo features and
  99. promote its widespread use.
  100. This module is part of the `OCA/reporting-engine <https://github.com/OCA/reporting-engine/tree/11.0/bi_view_editor>`_ project on GitHub.
  101. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.