mirror of
https://github.com/OCA/reporting-engine.git
synced 2025-02-16 16:30:38 +02:00
[IMP] bi_sql_editor: pre-commit auto fixes
This commit is contained in:
chien
thien
38
bi_sql_editor/readme/CONFIGURE.md
Normal file
38
bi_sql_editor/readme/CONFIGURE.md
Normal file
@@ -0,0 +1,38 @@
|
||||
- Go to Dashboard / Configuration / SQL Views
|
||||
|
||||
- tip your SQL request
|
||||
|
||||
|
||||
|
||||
- Select the group(s) that could have access to the view
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
- 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)
|
||||
|
||||
|
||||
|
||||
- Finally, click on 'Create UI', to create new menu, action, graph view
|
||||
and search view.
|
||||
@@ -1,42 +0,0 @@
|
||||
* Go to Dashboard / Configuration / SQL Views
|
||||
|
||||
* tip your SQL request
|
||||
|
||||
.. figure:: ../static/description/01_sql_request.png
|
||||
:width: 800 px
|
||||
|
||||
* Select the group(s) that could have access to the view
|
||||
|
||||
.. figure:: ../static/description/02_security_access.png
|
||||
:width: 800 px
|
||||
|
||||
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:: ../static/description/03_field_mapping.png
|
||||
:width: 800 px
|
||||
|
||||
* 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)
|
||||
|
||||
.. figure:: ../static/description/04_materialized_view_setting.png
|
||||
:width: 800 px
|
||||
|
||||
* Finally, click on 'Create UI', to create new menu, action, graph view and
|
||||
search view.
|
||||
17
bi_sql_editor/readme/CONTRIBUTORS.md
Normal file
17
bi_sql_editor/readme/CONTRIBUTORS.md
Normal file
@@ -0,0 +1,17 @@
|
||||
- Sylvain LE GAL (<https://twitter.com/legalsylvain>)
|
||||
|
||||
- Richard deMeester, WilldooIT (<http://www.willdooit.com/>)
|
||||
|
||||
- David James, WilldooIT (<http://www.willdooit.com/>)
|
||||
|
||||
- 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>
|
||||
@@ -1,14 +0,0 @@
|
||||
* Sylvain LE GAL (https://twitter.com/legalsylvain)
|
||||
* Richard deMeester, WilldooIT (http://www.willdooit.com/)
|
||||
* David James, WilldooIT (http://www.willdooit.com/)
|
||||
|
||||
* 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
|
||||
42
bi_sql_editor/readme/DESCRIPTION.md
Normal file
42
bi_sql_editor/readme/DESCRIPTION.md
Normal file
@@ -0,0 +1,42 @@
|
||||
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
|
||||
@@ -1,41 +0,0 @@
|
||||
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
|
||||
8
bi_sql_editor/readme/USAGE.md
Normal file
8
bi_sql_editor/readme/USAGE.md
Normal file
@@ -0,0 +1,8 @@
|
||||
To use this module, you need to:
|
||||
|
||||
1. Go to 'Dashboards \> SQL Reports'
|
||||
2. Select the desired report
|
||||
|
||||
> 
|
||||
|
||||
- You can switch to 'Graph' or 'tree' views as any report.
|
||||
@@ -1,10 +0,0 @@
|
||||
To use this module, you need to:
|
||||
|
||||
#. Go to 'Dashboards > SQL Reports'
|
||||
|
||||
#. Select the desired report
|
||||
|
||||
.. figure:: ../static/description/05_reporting_pivot.png
|
||||
:width: 800 px
|
||||
|
||||
* You can switch to 'Graph' or 'tree' views as any report.
|
||||
Reference in New Issue
Block a user