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

Update readme

pull/264/head
Adrià Gil Sorribes 5 years ago
parent
b2ea95e65b
commit
3544524024
3 changed files with 30 additions and 40 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 32
      bi_sql_editor/README.rst
  2. 2
      bi_sql_editor/readme/INSTALL.rst
  3. 36
      bi_sql_editor/static/description/index.html

32
bi_sql_editor/README.rst
View File

@ -66,11 +66,17 @@ this module is interesting for the following use cases
* 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
**Table of contents**
.. 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
=============
@ -141,25 +147,6 @@ If you spotted it first, help us smashing it by providing a detailed and welcome
Do not contact contributors directly about support or help with technical issues.
Note
====
* If the view is materialized, the name of the action will contain the date
and the time of it last refresh:
.. figure:: /bi_sql_editor/static/description/06_action_datetime_name.png
:width: 800 px
* The syntax of the sql request has the following constrains: the name of the
selectable columns should be prefixed by `x_`
Sample:
.. code-block:: sql
SELECT name as x_name
FROM res_partner
Credits
=======
@ -184,13 +171,6 @@ Contributors
Module: grap/odoo-addons-misc/pos_sale_reporting
link: https://github.com/grap/odoo-addons-misc/tree/7.0/pos_sale_reporting
Funders
~~~~~~~
The development of this module has been financially supported by:
* GRAP, Groupement Régional Alimentaire de Proximité (http://www.grap.coop)
Maintainers
~~~~~~~~~~~

2
bi_sql_editor/readme/INSTALL.rst
View File

@ -0,0 +1,2 @@
* 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.

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

@ -381,19 +381,27 @@ 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="#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>
<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>
</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="#id1">Configuration</a></h2>
<h2><a class="toc-backref" href="#id2">Configuration</a></h2>
<p>To configure this module, you need to:</p>
<ul>
<li><p class="first">Go to Settings / Technical / Database Structure / SQL Views</p>
@ -439,7 +447,7 @@ search view.</p>
</ul>
</div>
<div class="section" id="usage">
<h2><a class="toc-backref" href="#id2">Usage</a></h2>
<h2><a class="toc-backref" href="#id3">Usage</a></h2>
<p>To use this module, you need to:</p>
<ol class="arabic simple">
<li>Go to ‘Reporting’ / ‘Custom Reports’</li>
@ -459,7 +467,7 @@ search view.</p>
</ul>
</div>
<div class="section" id="bug-tracker">
<h2><a class="toc-backref" href="#id3">Bug Tracker</a></h2>
<h2><a class="toc-backref" href="#id4">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
@ -467,15 +475,15 @@ If you spotted it first, help us smashing it by providing a detailed and welcome
<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="#id4">Credits</a></h2>
<h2><a class="toc-backref" href="#id5">Credits</a></h2>
<div class="section" id="authors">
<h3><a class="toc-backref" href="#id5">Authors</a></h3>
<h3><a class="toc-backref" href="#id6">Authors</a></h3>
<ul class="simple">
<li>GRAP</li>
</ul>
</div>
<div class="section" id="contributors">
<h3><a class="toc-backref" href="#id6">Contributors</a></h3>
<h3><a class="toc-backref" href="#id7">Contributors</a></h3>
<ul>
<li><p class="first">Sylvain LE GAL (<a class="reference external" href="https://twitter.com/legalsylvain">https://twitter.com/legalsylvain</a>)</p>
</li>
@ -498,7 +506,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="#id7">Maintainers</a></h3>
<h3><a class="toc-backref" href="#id8">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

Write Preview
Loading…
Cancel
Save