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

[UPD] README.rst

pull/352/merge
OCA-git-bot 5 years ago
parent
4c5a63f750
commit
77c348a3ab
1 changed files with 60 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. 100
      bi_view_editor/static/description/index.html

100
bi_view_editor/static/description/index.html
View File

@ -3,7 +3,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.14: http://docutils.sourceforge.net/" />
<meta name="generator" content="Docutils 0.15.1: http://docutils.sourceforge.net/" />
<title>BI View Editor</title>
<style type="text/css">
@ -367,7 +367,7 @@ ul.auto-toc {
!! This file is generated by oca-gen-addon-readme !!
!! 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/11.0/bi_view_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-11-0/reporting-engine-11-0-bi_view_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/11.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/12.0/bi_view_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-12-0/reporting-engine-12-0-bi_view_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/12.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>BI View Editor is a tool integrated in Odoo that allows users define and
execute their own reports without the need to code.</p>
<p>Purpose:</p>
@ -383,14 +383,14 @@ including tree, graph, pivot views.</li>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#usage" id="id1">Usage</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id2">Known issues / Roadmap</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="#other-credits" id="id7">Other credits</a><ul>
<li><a class="reference internal" href="#images" id="id8">Images</a></li>
<li><a class="reference internal" href="#installation" id="id1">Installation</a></li>
<li><a class="reference internal" href="#usage" id="id2">Usage</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id3">Known issues / Roadmap</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="#other-credits" id="id8">Other credits</a><ul>
<li><a class="reference internal" href="#funders" id="id9">Funders</a></li>
</ul>
</li>
@ -399,53 +399,79 @@ including tree, graph, pivot views.</li>
</li>
</ul>
</div>
<div class="section" id="installation">
<h1><a class="toc-backref" href="#id1">Installation</a></h1>
<p>In the Odoo configuration file add <tt class="docutils literal">bi_view_editor</tt> in the list
<tt class="docutils literal">server_wide_modules</tt>:</p>
<pre class="code ini literal-block">
<span class="k">[options]</span>
<span class="na">(...)</span>
<span class="na">server_wide_modules</span> <span class="o">=</span> <span class="s">web,bi_view_editor</span>
<span class="na">(...)</span>
</pre>
<p>Alternatively specify <tt class="docutils literal"><span class="pre">--load=bi_view_editor</span></tt> when starting Odoo by command line.</p>
<p>Optionally it is possible to enable the view of the ER Diagram. For this you
need to install <cite>Graphviz</cite>, an open source graph visualization software:</p>
<pre class="code bash literal-block">
<span class="sb">``</span>sudo apt-get install graphviz<span class="sb">``</span>
</pre>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#id1">Usage</a></h1>
<h1><a class="toc-backref" href="#id2">Usage</a></h1>
<p>To graphically design your analysis data-set:</p>
<ul class="simple">
<li>From the Dashboards menu, select “Custom BI Views”</li>
<li>Browse trough the business objects in the Query tab</li>
<li>Browse trough the business objects in the “Query Builder” tab</li>
<li>Pick the interesting fields (Drag &amp; Drop)</li>
<li>For each selected field, right-click on the Options column and select whether it’s a row, column or measure; if you want to remove the field from the list view, unflag the checkbox ´List´ in the Options column</li>
<li>For each selected field, right-click on the Options column and select whether
it’s a row, column or measure; if you want to remove the field from the list
view, unflag the checkbox ´List´ in the Options column</li>
<li>Save and click “Generate BI View”</li>
<li>Click “Open BI View” to view the result</li>
<li>If module Dashboard (board) is installed, the standard “Add to My Dashboard” functionality would be available</li>
<li>Click “Create a menu” to create a new menu item directly linked to your new BI view (this feature is available in developer mode); when the BI view is reset back to draft this menu will be removed, and you will need to re-create the menu entry.</li>
</ul>
<p>To access the created BI View with a dedicated menu:</p>
<ul class="simple">
<li>If module Dashboard (board) is installed, the standard “Add to My Dashboard”
functionality would be available</li>
<li>Click “Create a menu” to create a new menu item directly linked to your new
BI view (this feature is available in developer mode); when the BI view is
reset back to draft this menu will be removed, and you will need to re-create
the menu entry.</li>
</ul>
<p>A more advanced UI is also available under the “Details” tab. It provides extra
possibilities for more advanced users, like to use LEFT JOIN instead of the
default INNER JOIN.</p>
</div>
<div class="section" id="known-issues-roadmap">
<h1><a class="toc-backref" href="#id2">Known issues / Roadmap</a></h1>
<h1><a class="toc-backref" href="#id3">Known issues / Roadmap</a></h1>
<ul class="simple">
<li>Non-stored fields and many2many fields are not supported</li>
<li>Provide graph view for table relations</li>
<li>Extend the capabilities of the tree views (e.g. add sums)</li>
<li>Provide a tutorial (eg. a working example of usage)</li>
<li>Implement a more advanced UI, with possibilities to use LEFT JOIN as default instead of INNER JOIN</li>
<li>Find better ways to extend the <em>_auto_init()</em> without override</li>
<li>Possibly avoid the monkey patches</li>
<li>Data the user has no access to (e.g. in a multi company situation) can be viewed by making a view</li>
<li>Store the JSON data structure in ORM</li>
<li>Would be nice if models available to select when creating a view are limited to the ones that have intersecting groups (for non technical users)</li>
<li>Non-stored fields and many2many fields are not supported.</li>
<li>Provide a tutorial (eg. a working example of usage).</li>
<li>Find better ways to extend the <em>_auto_init()</em> without override.</li>
<li>Possibly avoid the monkey patches.</li>
<li>Data the user has no access to (e.g. in a multi company situation) can be
viewed by making a view. Would be nice if models available to select when
creating a view are limited to the ones that have intersecting groups.</li>
</ul>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id3">Bug Tracker</a></h1>
<h1><a class="toc-backref" href="#id4">Bug Tracker</a></h1>
<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
<a class="reference external" href="https://github.com/OCA/reporting-engine/issues/new?body=module:%20bi_view_editor%0Aversion:%2011.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_view_editor%0Aversion:%2012.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>
</div>
<div class="section" id="credits">
<h1><a class="toc-backref" href="#id4">Credits</a></h1>
<h1><a class="toc-backref" href="#id5">Credits</a></h1>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#id5">Authors</a></h2>
<h2><a class="toc-backref" href="#id6">Authors</a></h2>
<ul class="simple">
<li>Onestein</li>
</ul>
</div>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#id6">Contributors</a></h2>
<h2><a class="toc-backref" href="#id7">Contributors</a></h2>
<ul class="simple">
<li>Simon Janssens &lt;<a class="reference external" href="mailto:s.janssens&#64;onestein.nl">s.janssens&#64;onestein.nl</a>&gt;</li>
<li>Diego Luis Neto &lt;<a class="reference external" href="mailto:diegoluis.neto&#64;gmail.com">diegoluis.neto&#64;gmail.com</a>&gt;</li>
@ -458,16 +484,10 @@ If you spotted it first, help us smashing it by providing a detailed and welcome
</ul>
</div>
<div class="section" id="other-credits">
<h2><a class="toc-backref" href="#id7">Other credits</a></h2>
<div class="section" id="images">
<h3><a class="toc-backref" href="#id8">Images</a></h3>
<ul class="simple">
<li>Odoo Community Association: <a class="reference external" href="https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg">Icon</a>.</li>
</ul>
</div>
<h2><a class="toc-backref" href="#id8">Other credits</a></h2>
<div class="section" id="funders">
<h3><a class="toc-backref" href="#id9">Funders</a></h3>
<p>The development of this module has been financially supported by:</p>
<p>The development of this module for Odoo 11.0 has been financially supported by:</p>
<ul class="simple">
<li>IDEAL Connaissances SAS <a class="reference external" href="https://www.idealconnaissances.com">https://www.idealconnaissances.com</a></li>
</ul>
@ -480,7 +500,7 @@ If you spotted it first, help us smashing it by providing a detailed and welcome
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/reporting-engine/tree/11.0/bi_view_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/12.0/bi_view_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>
</div>
</div>

Write Preview
Loading…
Cancel
Save