Author: |
Creu Blanca,Odoo Community Association (OCA) |
License: |
AGPL-3 |
Branch: |
13.0-report_qweb_element_page_visibility |
Repository: |
acsone/reporting-engine |
Dependencies: |
base,
base_sparse_field,
board,
bus,
and
web |
Other branches: |
12.0,
12.0-ref_report_py3o_python_3.9-mle,
12.0-report_substitute_generate_email-qgr,
13.0,
13.0-imp_report_qweb_signer_allowed_reports_tbi,
13.0-ref_report_py3o_python_3.11_tbi,
13.0-slg_master,
14.0,
14.0-imp_report_qweb_signer_allowed_reports_tbi,
14.0-mig-report_py3o,
14.0-mig-report_py3o_fusion_server,
14.0-update-dotfiles-sbi,
add-report_py3o_signer-lco,
and
imp-temp-remove-java-in-manifest-lco |
Other repositories: |
001101/reporting-engine,
AITIC/reporting-engine,
Aabcrow/reporting-engine,
Change2improve/reporting-engine,
Comunitea/reporting-engine,
DamonLiu0814/reporting-engine,
Darknroses/reporting-engine,
Digital5-Odoo/reporting-engine,
Dobtor-OCA/reporting-engine,
EBII/reporting-engine,
ERPLibre/reporting-engine,
ForgeFlow/reporting-engine,
Gabinete-Digital/reporting-engine,
Ingeos/reporting-engine,
Jarsa/reporting-engine,
NeatNerdPrime/reporting-engine,
NextERP-Romania/reporting-engine,
Nubeo-be/reporting-engine,
OCA-MUK/reporting-engine,
OCA/reporting-engine,
Rad0van/reporting-engine,
SeuMarco/reporting-engine,
SimoRubi/reporting-engine,
StefanRijnhart/reporting-engine,
Studio73/reporting-engine,
Syci-Consulting/reporting-engine,
TRESCLOUD/reporting-engine,
Tecnativa/reporting-engine,
Vauxoo/reporting-engine,
WilldooIT/reporting-engine,
aaltinisik/reporting-engine,
akretion/reporting-engine,
andhit-r/reporting-engine,
anhvu-sg/reporting-engine,
aurestic/reporting-engine,
blooparksystems/reporting-engine,
bmya/reporting-engine-1,
brain-tec/reporting-engine,
budisentosa/reporting-engine,
camptocamp/reporting-engine,
coopiteasy/reporting-engine,
dcorio/reporting-engine,
druidoo-dev/reporting-engine,
ecosoft-odoo/reporting-engine,
flachica/reporting-engine,
gbertolani/reporting-engine,
goyugo/reporting-engine,
gurneyalex/reporting-engine,
ilyasProgrammer/reporting-engine,
initOS/reporting-engine,
johnbendi/reporting-engine,
kmee/reporting-engine,
leemannd/reporting-engine,
legalsylvain/reporting-engine,
lideritjnma/reporting-engine,
luc-demeyer/reporting-engine,
lweiming/reporting-engine,
multidadosti-erp/reporting-engine,
myonnet/oca-reporting-engine,
oondeo/reporting-engine,
praxigento/oca-reporting-engine,
robertsvx27/reporting-engine,
sacostaylara/reporting-engine,
sanube/reporting-engine,
sendalpegat/reporting-engine,
sergiocorato/reporting-engine,
sgheller/reporting-engine,
sunflowerit/reporting-engine,
suwatuanp/reporting-engine,
syci/reporting-engine,
takinobori/oca-reporting-engine,
tbaden/reporting-engine,
tegin/reporting-engine,
tirma-sa/reporting-engine,
unitek-solusi/OCA-reporting-engine,
ursais/reporting-engine,
versada/reporting-engine,
vikichavada/reporting-engine,
wahello/reporting-engine,
xcgd/reporting-engine,
and
zhaohuaw/reporting-engine |
<h1 class="title">Kpi Dashboard</h1>
<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/kpi_dashboard"><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-kpi_dashboard"><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>This module adds new kinds of dashboards on a specific new type of view.</p>
<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><ul>
<li><a class="reference internal" href="#configure-kpis" id="id2">Configure KPIs</a></li>
<li><a class="reference internal" href="#using-kpi-with-code" id="id3">Using KPI with code</a></li>
<li><a class="reference internal" href="#configure-dashboards" id="id4">Configure dashboards</a></li>
</ul>
</li>
<li><a class="reference internal" href="#bug-tracker" id="id5">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id6">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id7">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id8">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id9">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<a name="configuration"></a>
<h2><a class="toc-backref" href="#id1">Configuration</a></h2>
<a name="configure-kpis"></a>
<h3><a class="toc-backref" href="#id2">Configure KPIs</a></h3>
<ol class="arabic simple">
<li>Access <cite>Dashboards > Configuration > KPI Dashboards > Configure KPI</cite></li>
<li>Create a new KPI specifying the computation method and the kpi type<ol class="arabic">
<li>Number: result must contain a <cite>value</cite> and, if needed, a <cite>previous</cite></li>
<li>Meter: result must contain <cite>value</cite>, <cite>min</cite> and <cite>max</cite></li>
<li>Graph: result must contain a list on <cite>graphs</cite> containing <cite>values</cite>, <cite>title</cite> and <cite>key</cite></li>
</ol>
</li>
<li>In order to compute the KPI you can use a predefined function from a model or
use the code to directly compute it.</li>
</ol>
<a name="using-kpi-with-code"></a>
<h3><a class="toc-backref" href="#id3">Using KPI with code</a></h3>
<p>Define the code directly on the code field. You can use <cite>self</cite> and <cite>model</cite> as the kpi element
The script should create a variable called <cite>result</cite> as a dictionary that
will be stored as the value.
For example, we can use:</p>
<pre>
<code>result = {}
result['value'] = len(model.search([('id', '=', %s)]))
result['previous'] = len(model.search([('id', '!=', %s)]))</code>
</pre>
<a name="configure-dashboards"></a>
<h3><a class="toc-backref" href="#id4">Configure dashboards</a></h3>
<ol class="arabic simple">
<li>Access <cite>Dashboards > Configuration > KPI Dashboards > Configure Dashboards</cite></li>
<li>Create a new dashboard and specify all the standard parameters on <cite>Widget configuration</cite></li>
<li>Append elements on KPIs</li>
<li>You can preview the element using the dashboard view</li>
<li>You can create the menu entry directly using the <cite>Generate menu</cite> button</li>
</ol>
<a name="bug-tracker"></a>
<h2><a class="toc-backref" href="#id5">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
<a class="reference external" href="https://github.com/OCA/reporting-engine/issues/new?body=module:%20kpi_dashboard%0Aversion:%2013.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>
<a name="credits"></a>
<h2><a class="toc-backref" href="#id6">Credits</a></h2>
<a name="authors"></a>
<h3><a class="toc-backref" href="#id7">Authors</a></h3>
<ul class="simple">
<li>Creu Blanca</li>
</ul>
<a name="contributors"></a>
<h3><a class="toc-backref" href="#id8">Contributors</a></h3>
<ul class="simple">
<li>Enric Tobella <<a class="reference external" href="mailto:etobella@creublanca.es">etobella@creublanca.es</a>></li>
</ul>
<a name="maintainers"></a>
<h3><a class="toc-backref" href="#id9">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
mission is to support the collaborative development of Odoo features and
promote its widespread use.</p>
<p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
<p><a class="reference external" href="https://github.com/etobella"><img alt="etobella" src="https://github.com/etobella.png?size=40px" /></a></p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/reporting-engine/tree/13.0/kpi_dashboard">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>