[UPD] README.rst

2025-02-16 16:30:38 +02:00 · 2023-02-17 14:47:52 +00:00
parent 9737650904
commit 3d12050216
2 changed files with 56 additions and 67 deletions
--- a/bi_sql_editor/README.rst
+++ b/bi_sql_editor/README.rst
@@ -14,13 +14,13 @@ BI SQL Editor
    :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/15.0/bi_sql_editor
+    :target: https://github.com/OCA/reporting-engine/tree/16.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-15-0/reporting-engine-15-0-bi_sql_editor
+    :target: https://translation.odoo-community.org/projects/reporting-engine-16-0/reporting-engine-16-0-bi_sql_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/15.0
+    :target: https://runbot.odoo-community.org/runbot/143/16.0
    :alt: Try me on Runbot

 |badge1| |badge2| |badge3| |badge4| |badge5| 
@@ -43,6 +43,7 @@ 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.
@@ -71,40 +72,38 @@ this module is interesting for the following use cases
 .. contents::
   :local:

-Installation
-============
-
-* You must put this module as `server_wide_modules` in your odoo configuration file
-  or add '--load=bi_sql_editor' if you start odoo in command line.
-
 Configuration
 =============

-To configure this module, you need to:
-
-* Go to Settings / Technical / Database Structure / SQL Views
+* Go to Dashboard / Configuration / SQL Views

 * tip your SQL request

-  .. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/15.0/bi_sql_editor/static/description/01_sql_request.png
+  .. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/16.0/bi_sql_editor/static/description/01_sql_request.png
     :width: 800 px

 * Select the group(s) that could have access to the view

-  .. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/15.0/bi_sql_editor/static/description/02_security_access.png
+  .. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/16.0/bi_sql_editor/static/description/02_security_access.png
     :width: 800 px

-* Click on the button 'Clean and Check Request'
+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.

-  .. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/15.0/bi_sql_editor/static/description/03_field_mapping.png
+  .. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/16.0/bi_sql_editor/static/description/03_field_mapping.png
     :width: 800 px

-* Click on the button 'Create SQL View, Indexes and Models'. (this step could
+* Click on the button 'Create SQL elements'. (this step could
  take a while, if view is materialized)

 * If it's a MATERIALIZED view:
@@ -113,7 +112,7 @@ To configure this module, you need to:
      the view. You can so define the frequency of the refresh.
    * the size of view (and the indexes is displayed)

-  .. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/15.0/bi_sql_editor/static/description/04_materialized_view_setting.png
+  .. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/16.0/bi_sql_editor/static/description/04_materialized_view_setting.png
     :width: 800 px

 * Finally, click on 'Create UI', to create new menu, action, graph view and
@@ -124,17 +123,14 @@ Usage

 To use this module, you need to:

-#. Go to 'Reporting' / 'Custom Reports'
+#. Go to 'Dashboards > SQL Reports'

 #. Select the desired report

-  .. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/15.0/bi_sql_editor/static/description/05_reporting_pivot.png
+  .. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/16.0/bi_sql_editor/static/description/05_reporting_pivot.png
     :width: 800 px

-* You can switch to 'Pie' chart or 'Line Chart' as any report,
-
-  .. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/15.0/bi_sql_editor/static/description/05_reporting_pie.png
-     :width: 800 px
+* You can switch to 'Graph' or 'tree' views as any report.

 Bug Tracker
 ===========
@@ -142,7 +138,7 @@ 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_sql_editor%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+`feedback <https://github.com/OCA/reporting-engine/issues/new?body=module:%20bi_sql_editor%0Aversion:%2016.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.

@@ -193,6 +189,6 @@ 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/15.0/bi_sql_editor>`_ project on GitHub.
+This module is part of the `OCA/reporting-engine <https://github.com/OCA/reporting-engine/tree/16.0/bi_sql_editor>`_ project on GitHub.

 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
--- a/bi_sql_editor/static/description/index.html
+++ b/bi_sql_editor/static/description/index.html
@@ -367,7 +367,7 @@ ul.auto-toc {
 !! This file is generated by oca-gen-addon-readme !!
 !! changes will be overwritten.                   !!
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
-<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/reporting-engine/tree/15.0/bi_sql_editor"><img alt="OCA/reporting-engine" src="https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/reporting-engine-15-0/reporting-engine-15-0-bi_sql_editor"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/143/15.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
+<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/reporting-engine/tree/16.0/bi_sql_editor"><img alt="OCA/reporting-engine" src="https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/reporting-engine-16-0/reporting-engine-16-0-bi_sql_editor"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/143/16.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
 <p>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)</p>
@@ -403,52 +403,49 @@ In that case, MATERIALIZED VIEW will be a good solution to reduce display durati
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
-<li><a class="reference internal" href="#installation" id="id1">Installation</a></li>
-<li><a class="reference internal" href="#configuration" id="id2">Configuration</a></li>
-<li><a class="reference internal" href="#usage" id="id3">Usage</a></li>
-<li><a class="reference internal" href="#bug-tracker" id="id4">Bug Tracker</a></li>
-<li><a class="reference internal" href="#credits" id="id5">Credits</a><ul>
-<li><a class="reference internal" href="#authors" id="id6">Authors</a></li>
-<li><a class="reference internal" href="#contributors" id="id7">Contributors</a></li>
-<li><a class="reference internal" href="#maintainers" id="id8">Maintainers</a></li>
+<li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li>
+<li><a class="reference internal" href="#usage" id="id2">Usage</a></li>
+<li><a class="reference internal" href="#bug-tracker" id="id3">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="id4">Credits</a><ul>
+<li><a class="reference internal" href="#authors" id="id5">Authors</a></li>
+<li><a class="reference internal" href="#contributors" id="id6">Contributors</a></li>
+<li><a class="reference internal" href="#maintainers" id="id7">Maintainers</a></li>
 </ul>
 </li>
 </ul>
 </div>
-<div class="section" id="installation">
-<h2><a class="toc-backref" href="#id1">Installation</a></h2>
-<ul class="simple">
-<li>You must put this module as <cite>server_wide_modules</cite> in your odoo configuration file
-or add ‘–load=bi_sql_editor’ if you start odoo in command line.</li>
-</ul>
-</div>
 <div class="section" id="configuration">
-<h2><a class="toc-backref" href="#id2">Configuration</a></h2>
-<p>To configure this module, you need to:</p>
+<h2><a class="toc-backref" href="#id1">Configuration</a></h2>
 <ul>
-<li><p class="first">Go to Settings / Technical / Database Structure / SQL Views</p>
+<li><p class="first">Go to Dashboard / Configuration / SQL Views</p>
 </li>
 <li><p class="first">tip your SQL request</p>
 <div class="figure">
-<img alt="https://raw.githubusercontent.com/OCA/reporting-engine/15.0/bi_sql_editor/static/description/01_sql_request.png" src="https://raw.githubusercontent.com/OCA/reporting-engine/15.0/bi_sql_editor/static/description/01_sql_request.png" style="width: 800px;" />
+<img alt="https://raw.githubusercontent.com/OCA/reporting-engine/16.0/bi_sql_editor/static/description/01_sql_request.png" src="https://raw.githubusercontent.com/OCA/reporting-engine/16.0/bi_sql_editor/static/description/01_sql_request.png" style="width: 800px;" />
 </div>
 </li>
 <li><p class="first">Select the group(s) that could have access to the view</p>
 <div class="figure">
-<img alt="https://raw.githubusercontent.com/OCA/reporting-engine/15.0/bi_sql_editor/static/description/02_security_access.png" src="https://raw.githubusercontent.com/OCA/reporting-engine/15.0/bi_sql_editor/static/description/02_security_access.png" style="width: 800px;" />
+<img alt="https://raw.githubusercontent.com/OCA/reporting-engine/16.0/bi_sql_editor/static/description/02_security_access.png" src="https://raw.githubusercontent.com/OCA/reporting-engine/16.0/bi_sql_editor/static/description/02_security_access.png" style="width: 800px;" />
 </div>
 </li>
-<li><p class="first">Click on the button ‘Clean and Check Request’</p>
+</ul>
+<p>Optionnaly, you can add a domain.</p>
+<p>A tipical domain in a multi company context is to write
+<tt class="docutils literal"><span class="pre">['|',</span> ('company_id', <span class="pre">'=',</span> False), ('company_id', 'in', company_ids)]</tt>
+to make reporting depending on the current companies of the user.</p>
+<ul>
+<li><p class="first">Click on the button ‘Validate SQL Expression’</p>
 </li>
 <li><p class="first">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.</p>
 <div class="figure">
-<img alt="https://raw.githubusercontent.com/OCA/reporting-engine/15.0/bi_sql_editor/static/description/03_field_mapping.png" src="https://raw.githubusercontent.com/OCA/reporting-engine/15.0/bi_sql_editor/static/description/03_field_mapping.png" style="width: 800px;" />
+<img alt="https://raw.githubusercontent.com/OCA/reporting-engine/16.0/bi_sql_editor/static/description/03_field_mapping.png" src="https://raw.githubusercontent.com/OCA/reporting-engine/16.0/bi_sql_editor/static/description/03_field_mapping.png" style="width: 800px;" />
 </div>
 </li>
-<li><p class="first">Click on the button ‘Create SQL View, Indexes and Models’. (this step could
+<li><p class="first">Click on the button ‘Create SQL elements’. (this step could
 take a while, if view is materialized)</p>
 </li>
 <li><p class="first">If it’s a MATERIALIZED view:</p>
@@ -460,7 +457,7 @@ the view. You can so define the frequency of the refresh.</li>
 </ul>
 </blockquote>
 <div class="figure">
-<img alt="https://raw.githubusercontent.com/OCA/reporting-engine/15.0/bi_sql_editor/static/description/04_materialized_view_setting.png" src="https://raw.githubusercontent.com/OCA/reporting-engine/15.0/bi_sql_editor/static/description/04_materialized_view_setting.png" style="width: 800px;" />
+<img alt="https://raw.githubusercontent.com/OCA/reporting-engine/16.0/bi_sql_editor/static/description/04_materialized_view_setting.png" src="https://raw.githubusercontent.com/OCA/reporting-engine/16.0/bi_sql_editor/static/description/04_materialized_view_setting.png" style="width: 800px;" />
 </div>
 </li>
 <li><p class="first">Finally, click on ‘Create UI’, to create new menu, action, graph view and
@@ -469,43 +466,39 @@ search view.</p>
 </ul>
 </div>
 <div class="section" id="usage">
-<h2><a class="toc-backref" href="#id3">Usage</a></h2>
+<h2><a class="toc-backref" href="#id2">Usage</a></h2>
 <p>To use this module, you need to:</p>
 <ol class="arabic simple">
-<li>Go to ‘Reporting’ / ‘Custom Reports’</li>
+<li>Go to ‘Dashboards &gt; SQL Reports’</li>
 <li>Select the desired report</li>
 </ol>
 <blockquote>
 <div class="figure">
-<img alt="https://raw.githubusercontent.com/OCA/reporting-engine/15.0/bi_sql_editor/static/description/05_reporting_pivot.png" src="https://raw.githubusercontent.com/OCA/reporting-engine/15.0/bi_sql_editor/static/description/05_reporting_pivot.png" style="width: 800px;" />
+<img alt="https://raw.githubusercontent.com/OCA/reporting-engine/16.0/bi_sql_editor/static/description/05_reporting_pivot.png" src="https://raw.githubusercontent.com/OCA/reporting-engine/16.0/bi_sql_editor/static/description/05_reporting_pivot.png" style="width: 800px;" />
 </div>
 </blockquote>
-<ul>
-<li><p class="first">You can switch to ‘Pie’ chart or ‘Line Chart’ as any report,</p>
-<div class="figure">
-<img alt="https://raw.githubusercontent.com/OCA/reporting-engine/15.0/bi_sql_editor/static/description/05_reporting_pie.png" src="https://raw.githubusercontent.com/OCA/reporting-engine/15.0/bi_sql_editor/static/description/05_reporting_pie.png" style="width: 800px;" />
-</div>
-</li>
+<ul class="simple">
+<li>You can switch to ‘Graph’ or ‘tree’ views as any report.</li>
 </ul>
 </div>
 <div class="section" id="bug-tracker">
-<h2><a class="toc-backref" href="#id4">Bug Tracker</a></h2>
+<h2><a class="toc-backref" href="#id3">Bug Tracker</a></h2>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/reporting-engine/issues">GitHub Issues</a>.
 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
-<a class="reference external" href="https://github.com/OCA/reporting-engine/issues/new?body=module:%20bi_sql_editor%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
+<a class="reference external" href="https://github.com/OCA/reporting-engine/issues/new?body=module:%20bi_sql_editor%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
 <p>Do not contact contributors directly about support or help with technical issues.</p>
 </div>
 <div class="section" id="credits">
-<h2><a class="toc-backref" href="#id5">Credits</a></h2>
+<h2><a class="toc-backref" href="#id4">Credits</a></h2>
 <div class="section" id="authors">
-<h3><a class="toc-backref" href="#id6">Authors</a></h3>
+<h3><a class="toc-backref" href="#id5">Authors</a></h3>
 <ul class="simple">
 <li>GRAP</li>
 </ul>
 </div>
 <div class="section" id="contributors">
-<h3><a class="toc-backref" href="#id7">Contributors</a></h3>
+<h3><a class="toc-backref" href="#id6">Contributors</a></h3>
 <ul class="simple">
 <li>Sylvain LE GAL (<a class="reference external" href="https://twitter.com/legalsylvain">https://twitter.com/legalsylvain</a>)</li>
 <li>Richard deMeester, WilldooIT (<a class="reference external" href="http://www.willdooit.com/">http://www.willdooit.com/</a>)</li>
@@ -529,7 +522,7 @@ link: <a class="reference external" href="https://github.com/grap/odoo-addons-mi
 </ul>
 </div>
 <div class="section" id="maintainers">
-<h3><a class="toc-backref" href="#id8">Maintainers</a></h3>
+<h3><a class="toc-backref" href="#id7">Maintainers</a></h3>
 <p>This module is maintained by the OCA.</p>
 <a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
 <p>OCA, or the Odoo Community Association, is a nonprofit organization whose
@@ -537,7 +530,7 @@ mission is to support the collaborative development of Odoo features and
 promote its widespread use.</p>
 <p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
 <p><a class="reference external" href="https://github.com/legalsylvain"><img alt="legalsylvain" src="https://github.com/legalsylvain.png?size=40px" /></a></p>
-<p>This module is part of the <a class="reference external" href="https://github.com/OCA/reporting-engine/tree/15.0/bi_sql_editor">OCA/reporting-engine</a> project on GitHub.</p>
+<p>This module is part of the <a class="reference external" href="https://github.com/OCA/reporting-engine/tree/16.0/bi_sql_editor">OCA/reporting-engine</a> project on GitHub.</p>
 <p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
 </div>
 </div>