KPI card configuration
- Andres Repcik
- Alberto Gruarin (Unlicensed)
Custom KPI cards can be configured and enabled via the admin panel starting with version 23.8.
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 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.
Value is the only mandatory result to be returned by the script; when needed, use techSlug to display the best technology associated with the KPI value and percentage to display a trend.
Type
When
Numericis selected as a `Type`, thevalueproperty 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` fieldsWhen
Textis selected as a `Type`, thevalueproperty 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).
Remember to trigger score recalculation in the scores list page after all scores have been created
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.
Attribute | Function |
|---|---|
Name | Displayed as KPI card header in the UI |
Description | Displayed as help text in the UI upon mouse hover on the information icon (optional) |
Sort priority | Defines the order of the KPI cards visualization in the UI. Lower values are displayed first |
Is enabled | Shows/Hides individual KPI cards in the UI |
Type | Defines how the report chart is rendered, choose type = KPI to visualize a report chart as a KPI card |
Report chart scores | Defines which score is visualized in the report chart. Make sure to select only 1 score to create a KPI card |
When configuring a KPI card, `Report` field is left empty; all KPI cards are displayed in the AMPI part detail page, in the Overview section.
The selected score must follow the correct setup and script results structure as described above in KPI card configuration | Configuring a custom KPI score. If not, the report chart is not displayed in the UI.
