From 3d12050216b98dc9d3ccd2659952b7be003dbf80 Mon Sep 17 00:00:00 2001 From: OCA-git-bot Date: Fri, 17 Feb 2023 14:47:52 +0000 Subject: [PATCH] [UPD] README.rst --- bi_sql_editor/README.rst | 48 ++++++------- bi_sql_editor/static/description/index.html | 75 ++++++++++----------- 2 files changed, 56 insertions(+), 67 deletions(-) diff --git a/bi_sql_editor/README.rst b/bi_sql_editor/README.rst index 04ee84b20..ebf24d643 100644 --- 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 `_. 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 `_. +`feedback `_. Do not contact contributors directly about support or help with technical issues. @@ -193,6 +189,6 @@ Current `maintainer `__: |maintainer-legalsylvain| -This module is part of the `OCA/reporting-engine `_ project on GitHub. +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_sql_editor/static/description/index.html b/bi_sql_editor/static/description/index.html index b6dc88ba3..1da76674f 100644 --- 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. !! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> -

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

+

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

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)

@@ -403,52 +403,49 @@ In that case, MATERIALIZED VIEW will be a good solution to reduce display durati

Table of contents

-
-

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:

+

Configuration

    -

  • Go to Settings / Technical / Database Structure / SQL Views

    +

  • Go to Dashboard / Configuration / SQL Views

  • tip your SQL request

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

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

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

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

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

  • 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:

    @@ -460,7 +457,7 @@ the view. You can so define the frequency of the refresh.
-https://raw.githubusercontent.com/OCA/reporting-engine/15.0/bi_sql_editor/static/description/04_materialized_view_setting.png +https://raw.githubusercontent.com/OCA/reporting-engine/16.0/bi_sql_editor/static/description/04_materialized_view_setting.png

  • Finally, click on ‘Create UI’, to create new menu, action, graph view and @@ -469,43 +466,39 @@ search view.

    • -

    Usage

    +

    Usage

    To use this module, you need to:

      -
    1. Go to ‘Reporting’ / ‘Custom Reports’
      2. +
    2. Go to ‘Dashboards > SQL Reports’
    3. Select the desired report
    -https://raw.githubusercontent.com/OCA/reporting-engine/15.0/bi_sql_editor/static/description/05_reporting_pivot.png +https://raw.githubusercontent.com/OCA/reporting-engine/16.0/bi_sql_editor/static/description/05_reporting_pivot.png
    -
      -

    • You can switch to ‘Pie’ chart or ‘Line Chart’ as any report,

      -
      -https://raw.githubusercontent.com/OCA/reporting-engine/15.0/bi_sql_editor/static/description/05_reporting_pie.png -
      -
      • +
        +
      • You can switch to ‘Graph’ or ‘tree’ views as any report.
    -

    Bug Tracker

    +

    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.

    +feedback.

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

    -

    Credits

    +

    Credits

    -

    Authors

    +

    Authors

    • GRAP
    -

    Contributors

    +

    Contributors