audrius/reporting-engine
1
0
Fork 1
mirror of https://github.com/OCA/reporting-engine.git synced 2025-02-16 16:30:38 +02:00
Code Issues Packages Projects Releases Wiki Activity

[UPD] README.rst

Browse Source
This commit is contained in:
OCA-git-bot
2023-02-17 14:47:52 +00:00
parent 9737650904
commit 3d12050216
2 changed files with 56 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
bi_sql_editor/README.rst
View File

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