BI Kpis

Business Intelligence KPI

Product line

Standard

|

Expert

Operating mode

CLOUD ABO

|

ON-PREMISES

Modules

Services & CRM

Budget & Phases

Purchases

Resource Planning

Business Intelligence

Created: 22.04.2020
Updated: 03.10.2023 | Screenshots updated with new BI module icon.

The different types of values available in the Business Intelligence module are referred to as BI Kpi:

The Kpi are configured in the folder Settings > Business Intelligence > BI Kpis. Each Kpis has the following properties:

designation
The designation is shown in the BI view and should therefore be as clear and meaningful as possible, so that it is clear what is shown:

This is an MLString field.

Active

Only active KPI is saved pre-calculated, so if you never need a standard Kpi, you can deactivate it.

However, if you want to calculate a Kpi but not show it (for example, because you only need it for a calculation – see Calculated Kpi below – but not for display), uncheck the Visible checkbox below.

Internal name

The internal name must be unique because the Kpis is identified by the generator by this name.

Calculated Kpi
If a KPI is marked as a calculated Kpi, the metric is not calculated by the generator, but by other Kpi. In this case, a field for calculation is shown instead of the Generator field:

Here, the calculation is defined by the internal name of the corresponding Kpi. In the example, an hourly rate chargeable (external fee / internal minutes).

The dimensions result from the underlying Kpi and cannot be defined separately here.

Currently, only divisions are supported.

Generator

The Kpi are calculated using generators, unless it is a calculated Kpi (see Computed Kpis attribute).

Unit
The following units are available:
  • Amount: numerical values, displayed according to country settings
  • Hours: Minute values, displayed according to system settings Display Minutes
  • Percent: Percentages, represented by %. The values are interpreted as 1 based quotients, so a value of 1 is represented as 100%.
  • quantity: quantity, with two decimal places
  • Hourly rate, display according to country settings
Visible

Controls whether a Kpi can be shown in the BI view. This is especially useful if you need a Kpi to calculate another Kpi (see Calculated Kpi above) but don’t want to show it yourself.

You can also deactivate standard KPI that you do not need at all (see checkbox Active above).

Record date value

Each Kpis has a temporal characteristic: It either refers to the selected period or is a reference date value. These are always valid at the end of the month.

Reporting date values are only displayed in the following BI views:

  • Evaluation for 1 month (date range in BI view)
  • Display as a time series (grouped by month in the BI display)
Dimensions
 
Classes 1 – 5,
Roles

Specifies on which classes (dimensions) the Kpis are available. These must be calculated in the specified generator.

Additionally, a role label can be specified for each dimension. The role label can be used to specify the context of the Kpis for that dimension.

For example, when calculating the incoming order, the project leader of the project is also returned. If we simply see the “incoming order” in a list of editors, the context is not clear: Is it the Salesperson, is it their own services? Here, for example, the Role can be specified:

The Role is then shown with the Kpis in the BI view:

Help text

Here a help text can be entered, for example to explain to the user how the Kpis is calculated.

If a Kpi has a help text, a small i symbol appears in the view. If you place the mouse pointer over it, the help text in appears as a tooltip:

The ad is truncated after 19 rows. When entering, care must be taken to ensure that the text fits into the ad.

This is an MLString field.

Standard BI KPI

Vertec provides the following key Kpi as standard (the code parts are equivalent):

Designation / Int. Name Significance Available on (Dimension)
Work started

FeesCommenced

Fee externally for the services of productive projects which are not on an invoice at the end of the month or whose invoice was not charged until later.
if not total.invoice or total.invoice.valuedate > enddate:
    rentsum.valueExtOpen + rentsum.valueExtCalculated
  • project
Working hours

WorkingTime

Working hours

->getWorking time(start date, end date)
  • user
external hours

MinutesExt

external hours

total.minutesExtOpen + total.minutesExtBilled
  • project
  • user
  • phase
  • service type
internal hours

MinutesInt

internal hours

total.minutesIntOpen + total.minutesIntBilled
  • project
  • user
  • phase
  • service type
Inventory downpayments

Advances

Net amount of all downpayments – downpayments paid on invoices cleared up to the end of the month (value date).

advances += advance.net amount
if invoice.settled and invoice.settled <= enddate:
    advances -= invoice.advorschussEffekt
  • project
Gross margin (DB)

MarginContributed

Fee charged externally – Cost charged

leistsum.valueExtCalculated – leistsum.valueCostCalculated
  • project
  • user
  • phase
  • service type
vacation balance

VacationBalance

Vacation balance at the end of the month

->getHolidayBalance(end date)
  • user
Vacation balance delimited

VacationBalanceDelimited

Deferred vacation balance at end of month

->getHolidayBalanceDelimited(End date)
  • user
External fee

FeesExt

External fee

rentsum.valueExtOpen + rentsum.valueExtCalculated
  • project
  • Project user (as project leader)
  • user
  • phase
  • service type
Fees written off externally

FeesExtWrittenoff

Fee charged internally – Fee charged externally

total.valueIntCalculated – total.valueExtCalculated
  • project
  • Project user (as project leader)
  • user
  • phase
  • service type
Fee externally open

FeesExtOpen

Fee externally open

sum.valueExtOpen
  • project
  • Project user (as project leader)
  • user
  • phase
  • service type
Fees charged externally

FeesExtCharged

Fees charged externally

sum.valueExtCalculated
  • project
  • Project user (as project leader)
  • user
  • phase
  • service type
Internal fee

FeesInt

Internal fee

lump sum.valueIntOpen + lump sum.valueIntBilled
  • project
  • Project user (as project leader)
  • user
  • phase
  • service type
Costs

Costs

Costs

costsum.valueCostOpen + costsum.valueCostsBilled
  • project
  • Project user (as project leader)
  • user
  • phase
  • service type
standard hours

SetTime

standard hours

->gettarget time(start date, end date)
  • user
Hourly rate chargeable

RateChargeable

External fee / Internal hours

(Calculation see the key Kpi of this name)

  • user
Overtime balance

OvertimeBalance

Overtime balance at end of month

->Overtime balance(end date)
  • user
Turnover outlays

TurnoverOutlays

Outlays charged (value date of invoice)

Invoice.expensesExt
  • project
  • user

Only available if Module Purchases is licensed.

Turnover services

TurnoverServices

Total charged after discount (invoice value date)

Invoice.ServiceValueExtAfterDiscount
  • project
  • user
Turnover expenses

TurnoverExpenses

Expenses charged (value date of invoice)

Invoice.ExpensesExt
  • project
  • user
Full-time positions

FTE

employment level

->getEmployment rate(end date)
  • user

Additional (inactive) Kpi for the Budget & Phase module

In addition, the following key Kpi are supplied as inactive by default. To be able to use the Budget & Phases module, Line Expert module and precise budget planning are prerequisites.

Designation / Int. Name

Significance

Available on
Order backlog Fee

FeesOrderbacklog

Budget Fees – cumulative fee externally. Only granted and not yet completed phases.

bdgvalue('planVertExt’, end date, -1) –
powerSum.valueExtOpen + powerSum.valueExtCalculated
  • project
  • user
  • phase
Order intake Fee

FeesOrder Intake

Budget Fee of the newly issued phases or changes to this budget value during that month.

bdgvalue('planVertExt’, end date, -1) –
bdgvalue('planVertExt’, (start date-1 day), -1)
  • project
  • user
  • phase
Hours Budget Rest

MinutesBudgetRest

Hours Budget Total – Hours Actual

(Calculation see the key Kpi of this name)

  • project
  • user
  • phase
Hours Budget Total

MinutesBudgetTotal

Budget hours of granted and not yet completed phases.

bdgvalue('planMinutesInt’, end date, -1)
  • project
  • user
  • phase
Hours Actual

MinutesCumulated

Cumulative internal hours of granted and not yet completed phases.

totalSum.minutesIntOpen + totalSum.minutesIntBilled
  • project
  • user
  • phase
Degree of completion

PercentageOfCompletion

Hours Actual / Hours Budget Total

(Calculation see the key Kpi of this name)

  • project
  • user
  • phase
Bitte wählen Sie Ihren Standort