mirror of
https://github.com/OCA/reporting-engine.git
synced 2025-02-16 16:30:38 +02:00
[UPD] README.rst
This commit is contained in:
@@ -42,7 +42,7 @@ Configure KPIs
|
|||||||
#. Create a new KPI specifying the computation method and the kpi type
|
#. Create a new KPI specifying the computation method and the kpi type
|
||||||
|
|
||||||
#. Number: result must contain a `value` and, if needed, a `previous`
|
#. Number: result must contain a `value` and, if needed, a `previous`
|
||||||
#. Meter: result must contain `value`, `min` and `max`
|
#. Meter: To show a percentage value, result must contain `value`. `value` must be a positive integer between 0 to 100. Meter is implemented with GaugeMeter (https://github.com/Mictronics/GaugeMeter). It can be customized by setting parameters for GaugeMeter in result. See https://github.com/Mictronics/GaugeMeter#parameter-definitions for details.
|
||||||
#. Graph: result must contain a list on `graphs` containing `values`, `title` and `key`
|
#. Graph: result must contain a list on `graphs` containing `values`, `title` and `key`
|
||||||
|
|
||||||
#. In order to compute the KPI you can use a predefined function from a model or
|
#. In order to compute the KPI you can use a predefined function from a model or
|
||||||
|
|||||||
@@ -395,7 +395,7 @@ ul.auto-toc {
|
|||||||
<li>Access <cite>Dashboards > Configuration > KPI Dashboards > Configure KPI</cite></li>
|
<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>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>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>Meter: To show a percentage value, result must contain <cite>value</cite>. <cite>value</cite> must be a positive integer between 0 to 100. Meter is implemented with GaugeMeter (<a class="reference external" href="https://github.com/Mictronics/GaugeMeter">https://github.com/Mictronics/GaugeMeter</a>). It can be customized by setting parameters for GaugeMeter in result. See <a class="reference external" href="https://github.com/Mictronics/GaugeMeter#parameter-definitions">https://github.com/Mictronics/GaugeMeter#parameter-definitions</a> for details.</li>
|
||||||
<li>Graph: result must contain a list on <cite>graphs</cite> containing <cite>values</cite>, <cite>title</cite> and <cite>key</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>
|
</ol>
|
||||||
</li>
|
</li>
|
||||||
|
|||||||
Reference in New Issue
Block a user