KPI Balanced Scorecard

Preparing the basis for KPIs’ calculation is not a simple task. The good news is that such a job should be done only once, while results are used forever

KPI Settings assume 3 levels of precision: (1) basic measurements – (2) KPI variables and constants – (3) KPI drag and drop formulas

Basic measurement is the core object used for retrieving actual KPI values from the Odoo database, while KPI variables specify those. For example, ‘total number of sales orders’ should be a basic measurement, while narrower ‘number of quotations of the sales team Europe’ is recommended to be a precision of that basic measurement

Each basic measurement might have an unlimited number of linked KPI variables. KPI formulas might combine any number of variables, constants, and other KPIs with mathematical operators.

‘Python code’ is a special type of basic measurement. This type requires technical knowledge but lets you compute any sort of figures based on any Odoo data without restrictions

Such measurement might be any Python basic script with the possibility of SQL queries (through using ‘env.cr’)

In calculations you may rely upon the special variables: ‘period_start’ (the first date of the period), ‘period_end’ (the last date of the period), ‘period_company_id’ – res.company object for which Odoo makes calculations at the moment (according to a KPI period under consideration)

Correct Python code assumes saving the value into the special variable ‘result’.

Basic measurements are not used for formulas, but they define how Odoo data should be calculated: count of records, sum, average, and pure Python code. Basic measurements assume a number of settings

Model – an Odoo document type with which data set you to work (‘Sales Order’, ‘Task’, etc.). Here you can rely on standard or custom objects (including those created in the Odoo studio), Odoo reports

Date fields – define whether a document relates to a KPI period. For example, for tasks, you might use ‘create date’. It is possible to apply a few date fields (e.g. ‘Opportunities opened and won in January 2021’) or no date fields at all for global calculations

Filters – allow restrict set of records. Used for low-level filtering and then specified in KPI variables

Measure field – is required for calculation types ‘Average’ and ‘Sum’. It defines which figure you use for calculations. For example, ‘total amount’ of Sales Analysis Report or ‘work hours of tasks’

Company field – would be used to restrict calculation for a KPI period target company. Take into account that records without a company will be used for all companies’ KPI calculations.

The key idea to distinguishing KPI variables from basic measurements is to simplify data preparation. You define ‘total sales’ once, and then unlimitedly use it for ‘sales Europe’, ‘sales John Brown’, ‘website sales’, etc.

Specify basic measurements through the Odoo built-in domain constructor, which lets filter by any storable attributes. For instance, filter sale orders by state (only ‘done’), the salesperson (‘John Brown or Mike Green’), sales team, etc.

KPI constants are the special type of KPI variables used when data can not be retrieved from modules and/or when figures remain the same during the whole period. For example, ‘total investments’ or ‘number of employees’ are often frozen for a specific period

In a multi-company environment, KPI variables are applied globally or for each company. In the former case, that variable is available for any company KPI formulas, while in the latter – only for a specific one

Basic measurements of the type ‘Execute Python code’ can’t be any more specified, since they do not relate to any records. Such measurements should have a single KPI variable linked.