Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[15.0][MIG] bi_view_editor: Migration to 15.0 #730

Merged
merged 25 commits into from
Mar 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
9f81196
Initial commit bi_view_editor V9
astirpe Mar 6, 2017
788b16e
[MIG+IMP] bi_view_editor: Migration to v10 + enhancements
astirpe Mar 6, 2017
7f51fde
OCA Transbot updated translations from Transifex
oca-transbot Jan 27, 2018
212eeb6
[MIG] bi_view_editor: Migration to 11.0
tarteo Mar 22, 2018
1c7aadb
[FIX] bi_view_editor: Apostrophe + migration script
SimoRubi Aug 14, 2018
36b6be0
Remove logger warnings during update all
astirpe Aug 29, 2018
7b50c1f
[FIX] Field widget, new readme + Make enabled in list view default true
tarteo Sep 4, 2018
821bf99
Drop bi views when uninstalling module
astirpe Sep 7, 2018
b0f4a10
[UPD] README.rst
OCA-git-bot Nov 27, 2018
98104d5
[UPD] Update bi_view_editor.pot
oca-travis Nov 27, 2018
f4fc6ab
[12.0][MIG] bi_view_editor
astirpe Jun 6, 2019
f66840a
Add extra functionalities
astirpe Jun 18, 2019
6e9e305
[UPD] Update bi_view_editor.pot
oca-travis Nov 29, 2019
17424f2
[UPD] README.rst
OCA-git-bot Nov 29, 2019
a489aaf
Update translation files
oca-transbot Jan 9, 2020
5fd29d1
bi_view_editor: window functions without ORDER BY clause do not have …
SimoRubi Apr 23, 2020
fb696f0
bi_view_editor: Better error message if the query is not correct
SimoRubi May 7, 2020
f491cf2
pre-commit
astirpe Sep 9, 2020
b5f53e2
[13.0][MIG] bi_view_editor
astirpe Sep 9, 2020
6f089af
[14.0][MIG] bi_view_editor
astirpe Oct 20, 2020
34206a4
[UPD] Update bi_view_editor.pot
oca-travis Apr 21, 2021
ca86ebd
[UPD] README.rst
OCA-git-bot Apr 21, 2021
eab9ae1
bi_view_editor: add deb external dependencies
sbidoul Feb 21, 2022
1eb14ec
Translated using Weblate (Italian)
francesco-ooops Jul 6, 2022
6ea92d7
[MIG] bi_view_editor: Migration to 15.0
Mar 8, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
169 changes: 169 additions & 0 deletions bi_view_editor/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,169 @@
==============
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/14.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-14-0/reporting-engine-14-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/14.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.

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

.. contents::
:local:

Installation
============

In the Odoo configuration file add ``bi_view_editor`` in the list
``server_wide_modules``:

.. code-block:: ini

[options]
(...)
server_wide_modules = web,bi_view_editor
(...)

Alternatively specify ``--load=bi_view_editor`` when starting Odoo by command line.

Optionally it is possible to enable the view of the ER Diagram. For this you
need to install `Graphviz`, an open source graph visualization software:

.. code-block:: bash

``sudo apt-get install graphviz``

Usage
=====

To graphically design your analysis data-set:

- From the Dashboards menu, select "Custom BI Views"
- Browse trough the business objects in the "Query Builder" 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

To access the created BI View with a dedicated menu:

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

A more advanced UI is also available under the "Details" tab. It provides extra
possibilities for more advanced users, like to use LEFT JOIN instead of the
default INNER JOIN.

It also possible to improve the IDs generation for new views by adding an
`Over Condition` in the "SQL" tab, see https://www.postgresql.org/docs/current/sql-expressions.html#SYNTAX-WINDOW-FUNCTIONS
for further details.
For instance, an ORDER BY clause helps preventing unreliable behavior when
filtering the generated views.

Known issues / Roadmap
======================

* Non-stored fields and many2many fields are not supported.
* Provide a tutorial (eg. a working example of usage).
* Find better ways to extend the *_auto_init()* without override.
* Possibly avoid the monkey patches.
* Data the user has no access to (e.g. in a multi company situation) can be
viewed by making a view. Would be nice if models available to select when
creating a view are limited to the ones that have intersecting groups.

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/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 <https://github.com/OCA/reporting-engine/issues/new?body=module:%20bi_view_editor%0Aversion:%2014.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
~~~~~~~

* Onestein

Contributors
~~~~~~~~~~~~

* Simon Janssens <[email protected]>
* Diego Luis Neto <[email protected]>
* Dennis Sluijk <[email protected]>
* Kevin Graveman <[email protected]>
* Richard Dijkstra <[email protected]>
* Andrea Stirpe <[email protected]>
* Antonio Esposito <[email protected]>
* Jordi Ballester Alomar <[email protected]>

Other credits
~~~~~~~~~~~~~

Funders
-------

The development of this module for Odoo 11.0 has been financially supported by:

* IDEAL Connaissances SAS https://www.idealconnaissances.com

Maintainers
~~~~~~~~~~~

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org

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 <https://github.com/OCA/reporting-engine/tree/14.0/bi_view_editor>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
5 changes: 5 additions & 0 deletions bi_view_editor/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).

from . import models
from . import wizard
from .hooks import uninstall_hook
37 changes: 37 additions & 0 deletions bi_view_editor/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Copyright 2015-2020 Onestein (<https://www.onestein.eu>)
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).

{
"name": "BI View Editor",
"summary": "Graphical BI views builder for Odoo",
"images": ["static/description/main_screenshot.png"],
"author": "Onestein,Odoo Community Association (OCA)",
"license": "AGPL-3",
"website": "https://github.com/OCA/reporting-engine",
"category": "Productivity",
"version": "15.0.1.0.0",
"development_status": "Beta",
"depends": ["web"],
"external_dependencies": {
"deb": ["graphviz"],
},
"data": [
"security/ir.model.access.csv",
"security/rules.xml",
"views/bve_view.xml",
],
"assets": {
"web.assets_backend": [
"bi_view_editor/static/src/css/bve.css",
"bi_view_editor/static/src/js/bi_view_editor.js",
"bi_view_editor/static/src/js/bi_view_editor.JoinNodeDialog.js",
"bi_view_editor/static/src/js/bi_view_editor.ModelList.js",
"bi_view_editor/static/src/js/bi_view_editor.FieldList.js",
],
"web.assets_qweb": [
"bi_view_editor/static/src/xml/bi_view_editor.xml",
],
},
"uninstall_hook": "uninstall_hook",
"installable": True,
}
28 changes: 28 additions & 0 deletions bi_view_editor/hooks.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Copyright 2015-2019 Onestein (<https://www.onestein.eu>)
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).


def uninstall_hook(cr, registry):
# delete dirty data that could cause problems
# while re-installing the module
cr.execute(
"""
delete from ir_model where model like 'x_bve.%'
"""
)
cr.execute(
"""
delete from bve_view where model_name like 'x_bve.%'
"""
)
cr.execute(
"""
SELECT 'DROP VIEW ' || table_name
FROM information_schema.views
WHERE table_schema NOT IN ('pg_catalog', 'information_schema')
AND table_name like 'x_bve_%'
"""
)
results = list(cr.fetchall())
for result in results:
cr.execute(result[0])
Loading