[18.0][MIG] bi_sql_editor: Migration to 18.0

bi_sql_editor/README.rst

@@ -0,0 +1,223 @@
+=============
+BI SQL Editor
+=============
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:1acb226c184032febd7db6e48ee618c7e5a6899c4685aa78b5b2e7578ebd9ce9
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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/18.0/bi_sql_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-18-0/reporting-engine-18-0-bi_sql_editor
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/reporting-engine&target_branch=18.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+This module extends the functionality of reporting, to support creation
+of extra custom reports. It allows user to write a custom SQL request.
+(Generally, admin users)
+
+Once written, a new model is generated, and user can map the selected
+field with odoo fields. Then user ends the process, creating new menu,
+action and graph view.
+
+Technically, the module create SQL View (or materialized view, if option
+is checked). Materialized view duplicates datas, but request are
+fastest. If materialized view is enabled, this module will create a cron
+task to refresh the data).
+
+By default, users member of 'SQL Request / User' can see all the views.
+You can specify extra groups that have the right to access to a specific
+view.
+
+Warning
+-------
+
+This module is intended for technician people in a company and for Odoo
+integrators.
+
+It requires the user to know SQL syntax and Odoo models.
+
+If you don't have such skills, do not try to use this module specially
+on a production environment.
+
+Use Cases
+---------
+
+this module is interesting for the following use cases
+
+-  You want to realize technical SQL requests, that Odoo framework
+   doesn't allow (For exemple, UNION with many SELECT) A typical use
+   case is if you want to have Sale Orders and PoS Orders datas in a
+   same table
+-  You want to customize an Odoo report, removing some useless fields
+   and adding some custom ones. In that case, you can simply select the
+   fields of the original report (sale.report model for exemple), and
+   add your custom fields
+-  You have a lot of data, and classical SQL Views have very bad
+   performance. In that case, MATERIALIZED VIEW will be a good solution
+   to reduce display duration
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Configuration
+=============
+
+-  Go to Dashboard / Configuration / SQL Views
+
+-  tip your SQL request
+
+   |image1|
+
+-  Select the group(s) that could have access to the view
+
+   |image2|
+
+Optionnaly, you can add a domain.
+
+A tipical domain in a multi company context is to write
+``['|', ('company_id', '=', False), ('company_id', 'in', company_ids)]``
+to make reporting depending on the current companies of the user.
+
+-  Click on the button 'Validate SQL Expression'
+
+-  Once the sql request checked, the module analyses the column of the
+   view, and propose field mapping. For each field, you can decide to
+   create an index and set if it will be displayed on the pivot graph as
+   a column, a row or a measure.
+
+   |image3|
+
+-  Click on the button 'Create SQL elements'. (this step could take a
+   while, if view is materialized)
+
+-  If it's a MATERIALIZED view:
+
+      -  a cron task is created to refresh the view. You can so define
+         the frequency of the refresh.
+      -  the size of view (and the indexes is displayed)
+
+   |image4|
+
+-  Before applying the final step, you will need to add a specific
+   Parent Menu to use when creating the UI Menu for the report. By
+   default, it will be set with the ``SQL Views`` menu, which can be
+   changed before creating the UI elements in order to have the report
+   accessible from a different place within Odoo.
+
+-  Finally, click on 'Create UI', to create new menu, action, graph view
+   and search view.
+
+.. |image1| image:: https://raw.githubusercontent.com/OCA/reporting-engine/18.0/bi_sql_editor/static/description/01_sql_request.png
+.. |image2| image:: https://raw.githubusercontent.com/OCA/reporting-engine/18.0/bi_sql_editor/static/description/02_security_access.png
+.. |image3| image:: https://raw.githubusercontent.com/OCA/reporting-engine/18.0/bi_sql_editor/static/description/03_field_mapping.png
+.. |image4| image:: https://raw.githubusercontent.com/OCA/reporting-engine/18.0/bi_sql_editor/static/description/04_materialized_view_setting.png
+
+Usage
+=====
+
+To use this module, you need to:
+
+1. Go to 'Dashboards > SQL Reports'
+2. Select the desired report
+
+..
+
+   |usage-image1|
+
+-  You can switch to 'Graph' or 'tree' views as any report.
+
+.. |usage-image1| image:: https://raw.githubusercontent.com/OCA/reporting-engine/18.0/bi_sql_editor/static/description/05_reporting_pivot.png
+
+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 to smash it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/reporting-engine/issues/new?body=module:%20bi_sql_editor%0Aversion:%2018.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
+-------
+
+* GRAP
+
+Contributors
+------------
+
+-  Sylvain LE GAL (https://twitter.com/legalsylvain)
+
+-  Richard deMeester, WilldooIT (http://www.willdooit.com/)
+
+-  David James, WilldooIT (http://www.willdooit.com/)
+
+-  Guillem Casassas [email protected]
+
+-  Thien Vo [email protected]
+
+-  This module is highly inspired by the work of
+
+   -  Onestein: (http://www.onestein.nl/) Module:
+      OCA/server-tools/bi_view_editor. Link:
+      https://github.com/OCA/reporting-engine/tree/9.0/bi_view_editor
+   -  Anybox: (https://anybox.fr/) Module :
+      OCA/server-tools/materialized_sql_view link:
+      https://github.com/OCA/server-tools/pull/110
+   -  GRAP, Groupement Régional Alimentaire de Proximité:
+      (http://www.grap.coop/) Module:
+      grap/odoo-addons-misc/pos_sale_reporting link:
+      https://github.com/grap/odoo-addons-misc/tree/7.0/pos_sale_reporting
+
+Other credits
+-------------
+
+The migration of this module from 17.0 to 18.0 was financially supported
+by Camptocamp.
+
+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.
+
+.. |maintainer-legalsylvain| image:: https://github.com/legalsylvain.png?size=40px
+    :target: https://github.com/legalsylvain
+    :alt: legalsylvain
+
+Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
+
+|maintainer-legalsylvain| 
+
+This module is part of the `OCA/reporting-engine <https://github.com/OCA/reporting-engine/tree/18.0/bi_sql_editor>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

bi_sql_editor/__init__.py

@@ -0,0 +1,4 @@
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+
+from . import models
+from .hooks import uninstall_hook

bi_sql_editor/__manifest__.py

@@ -0,0 +1,25 @@
+# Copyright (C) 2017 - Today: GRAP (http://www.grap.coop)
+# @author: Sylvain LE GAL (https://twitter.com/legalsylvain)
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+
+{
+    "name": "BI SQL Editor",
+    "summary": "BI Views builder, based on Materialized or Normal SQL Views",
+    "version": "18.0.1.0.0",
+    "license": "AGPL-3",
+    "category": "Reporting",
+    "author": "GRAP,Odoo Community Association (OCA)",
+    "website": "https://github.com/OCA/reporting-engine",
+    "depends": [
+        "spreadsheet_dashboard",
+        "sql_request_abstract",
+    ],
+    "data": [
+        "security/ir.model.access.csv",
+        "views/view_bi_sql_view.xml",
+    ],
+    "demo": ["demo/res_groups_demo.xml", "demo/bi_sql_view_demo.xml"],
+    "installable": True,
+    "uninstall_hook": "uninstall_hook",
+    "maintainers": ["legalsylvain"],
+}

bi_sql_editor/demo/bi_sql_view_demo.xml

@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!--
+Copyright (C) 2014 - Today GRAP (http://www.grap.coop)
+@author Sylvain LE GAL (https://twitter.com/legalsylvain)
+License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+-->
+<odoo noupdate="1">
+    <record id="incorrect_sql_view" model="bi.sql.view">
+        <field name="name">Draft Incorrect SQL View</field>
+        <field name="technical_name">incorrect_view</field>
+        <field
+            name="query"
+        ><![CDATA[
+SELECT *
+FROM unexisting_table
+ORDER BY unexisting_field
+]]>
+            </field>
+    </record>
+    <record id="partner_sql_view" model="bi.sql.view">
+        <field name="name">Partners View</field>
+        <field name="technical_name">partners_view</field>
+        <field name="is_materialized" eval="True" />
+        <field
+            name="query"
+        ><![CDATA[
+SELECT
+    name as x_name,
+    street as x_street,
+    company_id as x_company_id
+FROM res_partner
+ORDER BY name
+]]>
+            </field>
+    </record>
+    <record id="module_sql_view" model="bi.sql.view">
+        <field name="name">Modules by Authors</field>
+        <field name="technical_name">modules_view</field>
+        <field name="is_materialized" eval="0" />
+        <field
+            name="query"
+        ><![CDATA[
+SELECT
+    name as x_name,
+    case
+        when author ilike '%OpenERP SA%' THEN 'Odoo SA'
+        when author ilike '%Odoo Community Association (OCA)%' THEN 'OCA'
+        else 'Undefined Author' END as x_author_type
+FROM ir_module_module
+]]>
+            </field>
+    </record>
+</odoo>

bi_sql_editor/demo/res_groups_demo.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!--
+Copyright (C) 2014 - Today GRAP (http://www.grap.coop)
+@author Sylvain LE GAL (https://twitter.com/legalsylvain)
+License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+-->
+<odoo>
+    <record id="base.group_no_one" model="res.groups">
+        <field name="users" eval="[(4, ref('base.user_admin'))]" />
+    </record>
+    <record id="sql_request_abstract.group_sql_request_user" model="res.groups">
+        <field name="users" eval="[(4, ref('base.user_demo'))]" />
+    </record>
+</odoo>

bi_sql_editor/hooks.py

@@ -0,0 +1,8 @@
+# Copyright 2015-2017 Onestein (<http://www.onestein.eu>)
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+
+
+def uninstall_hook(env):
+    recs = env["bi.sql.view"].search([])
+    for rec in recs:
+        rec.button_set_draft()