diff --git a/bi_view_editor/README.rst b/bi_view_editor/README.rst index 0b3e6ff7..8d5fcf36 100644 --- a/bi_view_editor/README.rst +++ b/bi_view_editor/README.rst @@ -1,11 +1,30 @@ -.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg - :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html - :alt: License: AGPL-3 - ============== BI View Editor ============== +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! 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/10.0/bi_view_editor + :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-10-0/reporting-engine-10-0-bi_view_editor + :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/10.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + BI View Editor is a tool integrated in Odoo that allows users define and execute their own reports without the need to code. @@ -21,11 +40,14 @@ Purpose: * The BI View Editor offers users different types of representations, including tree, graph, pivot views. +**Table of contents** + +.. contents:: + :local: Usage ===== - To graphically design your analysis data-set: - From the Dashboards menu, select "Custom BI Views" @@ -37,10 +59,6 @@ To graphically design your analysis data-set: - If module Dashboard (board) is installed, the standard "Add to My Dashboard" functionality would be available - 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. -.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas - :alt: Try me on Runbot - :target: https://runbot.odoo-community.org/runbot/143/10.0 - Known issues / Roadmap ====================== @@ -53,21 +71,23 @@ Known issues / Roadmap 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 smash it by providing detailed and welcomed feedback. +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 ======= -Images ------- +Authors +~~~~~~~ -* Odoo Community Association: `Icon `_. +* Onestein Contributors ------------- +~~~~~~~~~~~~ * Simon Janssens * Diego Luis Neto @@ -78,17 +98,19 @@ Contributors * Antonio Esposito * Jordi Ballester Alomar -Maintainer ----------- +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. .. image:: https://odoo-community.org/logo.png :alt: Odoo Community Association :target: https://odoo-community.org -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. -To contribute to this module, please visit https://odoo-community.org. +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. diff --git a/bi_view_editor/static/description/index.html b/bi_view_editor/static/description/index.html new file mode 100644 index 00000000..957c7906 --- /dev/null +++ b/bi_view_editor/static/description/index.html @@ -0,0 +1,463 @@ + + + + + + +BI View Editor + + + +
+

BI View Editor

+ + +

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

+

BI View Editor is a tool integrated in Odoo that allows users define and +execute their own reports without the need to code.

+

Purpose:

+
    +
  • The BI View Editor is used to create reports not already contained in the +standard Odoo, combining data from existing sources.
    • +
  • It has been designed to be used by users with little or no knowledge of +the technical architecture of Odoo. Users visually link business objects +and select the fields to visualize.
    • +
  • The BI View Editor offers users different types of representations, +including tree, graph, pivot views.
    • +
+

Table of contents

+ +
+

Usage

+

To graphically design your analysis data-set:

+
    +
  • From the Dashboards menu, select “Custom BI Views”
    • +
  • Browse trough the business objects in the Query tab
    • +
  • Pick the interesting fields (Drag & Drop)
    • +
  • 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
    • +
  • Save and click “Generate BI View”
    • +
  • Click “Open BI View” to view the result
    • +
  • If module Dashboard (board) is installed, the standard “Add to My Dashboard” functionality would be available
    • +
  • 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.
    • +
+
+
+

Known issues / Roadmap

+
    +
  • Non-stored fields and many2many fields are not supported
    • +
  • Provide graph view for table relations
    • +
  • Extend the capabilities of the tree views (e.g. add sums)
    • +
  • Provide a tutorial (eg. a working example of usage)
    • +
  • Implement a more advanced UI, with possibilities to use LEFT JOIN as default instead of INNER JOIN
    • +
+
+
+

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

+
    +
  • Onestein
    • +
+
+
+

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.

+

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.

+
+
+
+ +