OCA
/
reporting-engine
5
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Browse Source

[UPD] README.rst

14.0-report-py3o-pr-506
OCA-git-bot 3 years ago
parent
6871a10b51
commit
03832febed
2 changed files with 24 additions and 20 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 24
      bi_sql_editor/README.rst
  2. 20
      bi_sql_editor/static/description/index.html

24
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 :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3 :alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github
:target: https://github.com/OCA/reporting-engine/tree/13.0/bi_sql_editor
:target: https://github.com/OCA/reporting-engine/tree/14.0/bi_sql_editor
:alt: OCA/reporting-engine :alt: OCA/reporting-engine
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/reporting-engine-13-0/reporting-engine-13-0-bi_sql_editor
:target: https://translation.odoo-community.org/projects/reporting-engine-14-0/reporting-engine-14-0-bi_sql_editor
:alt: Translate me on Weblate :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
:target: https://runbot.odoo-community.org/runbot/143/13.0
:target: https://runbot.odoo-community.org/runbot/143/14.0
:alt: Try me on Runbot :alt: Try me on Runbot
|badge1| |badge2| |badge3| |badge4| |badge5| |badge1| |badge2| |badge3| |badge4| |badge5|
@ -86,12 +86,12 @@ To configure this module, you need to:
* tip your SQL request * tip your SQL request
.. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/13.0/bi_sql_editor/static/description/01_sql_request.png
.. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/14.0/bi_sql_editor/static/description/01_sql_request.png
:width: 800 px :width: 800 px
* Select the group(s) that could have access to the view * Select the group(s) that could have access to the view
.. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/13.0/bi_sql_editor/static/description/02_security_access.png
.. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/14.0/bi_sql_editor/static/description/02_security_access.png
:width: 800 px :width: 800 px
* Click on the button 'Clean and Check Request' * Click on the button 'Clean and Check Request'
@ -101,7 +101,7 @@ To configure this module, you need to:
and set if it will be displayed on the pivot graph as a column, a row or a and set if it will be displayed on the pivot graph as a column, a row or a
measure. measure.
.. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/13.0/bi_sql_editor/static/description/03_field_mapping.png
.. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/14.0/bi_sql_editor/static/description/03_field_mapping.png
:width: 800 px :width: 800 px
* Click on the button 'Create SQL View, Indexes and Models'. (this step could * Click on the button 'Create SQL View, Indexes and Models'. (this step could
@ -113,7 +113,7 @@ To configure this module, you need to:
the view. You can so define the frequency of the refresh. the view. You can so define the frequency of the refresh.
* the size of view (and the indexes is displayed) * the size of view (and the indexes is displayed)
.. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/13.0/bi_sql_editor/static/description/04_materialized_view_setting.png
.. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/14.0/bi_sql_editor/static/description/04_materialized_view_setting.png
:width: 800 px :width: 800 px
* Finally, click on 'Create UI', to create new menu, action, graph view and * Finally, click on 'Create UI', to create new menu, action, graph view and
@ -128,12 +128,12 @@ To use this module, you need to:
#. Select the desired report #. Select the desired report
.. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/13.0/bi_sql_editor/static/description/05_reporting_pivot.png
.. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/14.0/bi_sql_editor/static/description/05_reporting_pivot.png
:width: 800 px :width: 800 px
* You can switch to 'Pie' chart or 'Line Chart' as any report, * You can switch to 'Pie' chart or 'Line Chart' as any report,
.. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/13.0/bi_sql_editor/static/description/05_reporting_pie.png
.. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/14.0/bi_sql_editor/static/description/05_reporting_pie.png
:width: 800 px :width: 800 px
Bug Tracker Bug Tracker
@ -142,7 +142,7 @@ Bug Tracker
Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/issues>`_. 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. 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 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:%2013.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:%2014.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. Do not contact contributors directly about support or help with technical issues.
@ -158,6 +158,8 @@ Contributors
~~~~~~~~~~~~ ~~~~~~~~~~~~
* Sylvain LE GAL (https://twitter.com/legalsylvain) * 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 * This module is highly inspired by the work of
* Onestein: (http://www.onestein.nl/) * Onestein: (http://www.onestein.nl/)
@ -183,6 +185,6 @@ OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and mission is to support the collaborative development of Odoo features and
promote its widespread use. promote its widespread use.
This module is part of the `OCA/reporting-engine <https://github.com/OCA/reporting-engine/tree/13.0/bi_sql_editor>`_ project on GitHub.
This module is part of the `OCA/reporting-engine <https://github.com/OCA/reporting-engine/tree/14.0/bi_sql_editor>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

20
bi_sql_editor/static/description/index.html
View File

@ -367,7 +367,7 @@ ul.auto-toc {
!! This file is generated by oca-gen-addon-readme !! !! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !! !! 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/13.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-13-0/reporting-engine-13-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/13.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/14.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-14-0/reporting-engine-14-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/14.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 <p>This module extends the functionality of reporting, to support creation
of extra custom reports. of extra custom reports.
It allows user to write a custom SQL request. (Generally, admin users)</p> It allows user to write a custom SQL request. (Generally, admin users)</p>
@ -430,12 +430,12 @@ or add ‘–load=bi_sql_editor’ if you start odoo in command line.</li>
</li> </li>
<li><p class="first">tip your SQL request</p> <li><p class="first">tip your SQL request</p>
<div class="figure"> <div class="figure">
<img alt="https://raw.githubusercontent.com/OCA/reporting-engine/13.0/bi_sql_editor/static/description/01_sql_request.png" src="https://raw.githubusercontent.com/OCA/reporting-engine/13.0/bi_sql_editor/static/description/01_sql_request.png" style="width: 800px;" />
<img alt="https://raw.githubusercontent.com/OCA/reporting-engine/14.0/bi_sql_editor/static/description/01_sql_request.png" src="https://raw.githubusercontent.com/OCA/reporting-engine/14.0/bi_sql_editor/static/description/01_sql_request.png" style="width: 800px;" />
</div> </div>
</li> </li>
<li><p class="first">Select the group(s) that could have access to the view</p> <li><p class="first">Select the group(s) that could have access to the view</p>
<div class="figure"> <div class="figure">
<img alt="https://raw.githubusercontent.com/OCA/reporting-engine/13.0/bi_sql_editor/static/description/02_security_access.png" src="https://raw.githubusercontent.com/OCA/reporting-engine/13.0/bi_sql_editor/static/description/02_security_access.png" style="width: 800px;" />
<img alt="https://raw.githubusercontent.com/OCA/reporting-engine/14.0/bi_sql_editor/static/description/02_security_access.png" src="https://raw.githubusercontent.com/OCA/reporting-engine/14.0/bi_sql_editor/static/description/02_security_access.png" style="width: 800px;" />
</div> </div>
</li> </li>
<li><p class="first">Click on the button ‘Clean and Check Request’</p> <li><p class="first">Click on the button ‘Clean and Check Request’</p>
@ -445,7 +445,7 @@ 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 and set if it will be displayed on the pivot graph as a column, a row or a
measure.</p> measure.</p>
<div class="figure"> <div class="figure">
<img alt="https://raw.githubusercontent.com/OCA/reporting-engine/13.0/bi_sql_editor/static/description/03_field_mapping.png" src="https://raw.githubusercontent.com/OCA/reporting-engine/13.0/bi_sql_editor/static/description/03_field_mapping.png" style="width: 800px;" />
<img alt="https://raw.githubusercontent.com/OCA/reporting-engine/14.0/bi_sql_editor/static/description/03_field_mapping.png" src="https://raw.githubusercontent.com/OCA/reporting-engine/14.0/bi_sql_editor/static/description/03_field_mapping.png" style="width: 800px;" />
</div> </div>
</li> </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 View, Indexes and Models’. (this step could
@ -460,7 +460,7 @@ the view. You can so define the frequency of the refresh.</li>
</ul> </ul>
</blockquote> </blockquote>
<div class="figure"> <div class="figure">
<img alt="https://raw.githubusercontent.com/OCA/reporting-engine/13.0/bi_sql_editor/static/description/04_materialized_view_setting.png" src="https://raw.githubusercontent.com/OCA/reporting-engine/13.0/bi_sql_editor/static/description/04_materialized_view_setting.png" style="width: 800px;" />
<img alt="https://raw.githubusercontent.com/OCA/reporting-engine/14.0/bi_sql_editor/static/description/04_materialized_view_setting.png" src="https://raw.githubusercontent.com/OCA/reporting-engine/14.0/bi_sql_editor/static/description/04_materialized_view_setting.png" style="width: 800px;" />
</div> </div>
</li> </li>
<li><p class="first">Finally, click on ‘Create UI’, to create new menu, action, graph view and <li><p class="first">Finally, click on ‘Create UI’, to create new menu, action, graph view and
@ -477,13 +477,13 @@ search view.</p>
</ol> </ol>
<blockquote> <blockquote>
<div class="figure"> <div class="figure">
<img alt="https://raw.githubusercontent.com/OCA/reporting-engine/13.0/bi_sql_editor/static/description/05_reporting_pivot.png" src="https://raw.githubusercontent.com/OCA/reporting-engine/13.0/bi_sql_editor/static/description/05_reporting_pivot.png" style="width: 800px;" />
<img alt="https://raw.githubusercontent.com/OCA/reporting-engine/14.0/bi_sql_editor/static/description/05_reporting_pivot.png" src="https://raw.githubusercontent.com/OCA/reporting-engine/14.0/bi_sql_editor/static/description/05_reporting_pivot.png" style="width: 800px;" />
</div> </div>
</blockquote> </blockquote>
<ul> <ul>
<li><p class="first">You can switch to ‘Pie’ chart or ‘Line Chart’ as any report,</p> <li><p class="first">You can switch to ‘Pie’ chart or ‘Line Chart’ as any report,</p>
<div class="figure"> <div class="figure">
<img alt="https://raw.githubusercontent.com/OCA/reporting-engine/13.0/bi_sql_editor/static/description/05_reporting_pie.png" src="https://raw.githubusercontent.com/OCA/reporting-engine/13.0/bi_sql_editor/static/description/05_reporting_pie.png" style="width: 800px;" />
<img alt="https://raw.githubusercontent.com/OCA/reporting-engine/14.0/bi_sql_editor/static/description/05_reporting_pie.png" src="https://raw.githubusercontent.com/OCA/reporting-engine/14.0/bi_sql_editor/static/description/05_reporting_pie.png" style="width: 800px;" />
</div> </div>
</li> </li>
</ul> </ul>
@ -493,7 +493,7 @@ search view.</p>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/reporting-engine/issues">GitHub Issues</a>. <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. 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 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:%2013.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:%2014.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> <p>Do not contact contributors directly about support or help with technical issues.</p>
</div> </div>
<div class="section" id="credits"> <div class="section" id="credits">
@ -508,6 +508,8 @@ If you spotted it first, help us smashing it by providing a detailed and welcome
<h3><a class="toc-backref" href="#id7">Contributors</a></h3> <h3><a class="toc-backref" href="#id7">Contributors</a></h3>
<ul class="simple"> <ul class="simple">
<li>Sylvain LE GAL (<a class="reference external" href="https://twitter.com/legalsylvain">https://twitter.com/legalsylvain</a>)</li> <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>
<li>David James, WilldooIT (<a class="reference external" href="http://www.willdooit.com/">http://www.willdooit.com/</a>)</li>
<li><dl class="first docutils"> <li><dl class="first docutils">
<dt>This module is highly inspired by the work of</dt> <dt>This module is highly inspired by the work of</dt>
<dd><ul class="first last"> <dd><ul class="first last">
@ -533,7 +535,7 @@ link: <a class="reference external" href="https://github.com/grap/odoo-addons-mi
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose <p>OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and mission is to support the collaborative development of Odoo features and
promote its widespread use.</p> promote its widespread use.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/reporting-engine/tree/13.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/14.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> <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>
</div> </div>

Write Preview
Loading…
Cancel
Save