KPI card configuration

KPI cards are visualised in the report of a part detail page in AMPI. They can be used to highlight important values resulting from the part assessment, to provide the user with a clear overview at a glance when they access the report.

Configuring a custom KPI score

KPI cards can be used to highlight the result of a single score on the part detail page in AMPI. A KPI score can be created and setup in Admin panel > AMPI > Scores as follows.

• For the general setup of a score, refer to https://3yourmind.atlassian.net/wiki/spaces/PD/pages/1373765633/Calculation+Logic#Scores .

• For a KPI score, the following fields are more specifically setup as described.

Script

To configure a correct KPI card to visualize in the UI, it’s important that the structure of the returned results is as follows:

return {
	result: {
		techSlug: 'fdm',
		value: 100.20, 
		percentage: 1,
	},
}

The provided example script above has hardcoded values for techSlug, value and percentage , whereas in real setups the value and percentage can come from other calculations based on other scores or helper functions.

The values of techSlug, value and percentage are then visualized in specific locations of the KPI card.

Type

1. When Numeric is selected as a `Type`, the value property on the script is a simple number (integer or floating). The unit of the value is defined by either the `Unit of measurement` or `Is currency` fields

2. When Text is selected as a `Type`, the value property on the script needs to be a string within 2 ' characters (e.g. value: 'a string'). `Unit of measurement`, `FE Multiplier`, `Decimal places` and `Is currency` are ignored.

Schema: Kpi

Select KPI to create a score that can be selected and visualized as a KPI card in the UI. Other schema options are not compatible with a report chart of `Type` = KPI (see below for more information).

Configuring a custom KPI card

After the configuration of the desired score, a report chart of type KPI needs to be created to bundle the score results into a KPI card.

Go to Admin panel > AMPI > Report Charts and add a new report chart as follows.