...
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.
...
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 followfollows.
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.
...
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 |
After configuration of the desired score, a report chart of type KPI needs to be created to bundle the score results into a KPI card. To do so:
...
Go to Admin panel > AMPI > Report Charts
Add a new chart, fill the following and save:
...
`Name`, `Description`, `Sort priority`
...
Make sure to check `Is enabled` and do not select anything in `Report`
...
`Type`: KPI
...
Report chart scores | Defines which score is visualized in the report chart. Make sure to select only 1 score to create a KPI card |
| Info |
|---|
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. |
| Note |
|---|
The selected score must follow the correct setup and script results structure as described above in https://3yourmind.atlassian.net/wiki/spaces/PD/pages/1881342011/KPI+card+configuration#Configuring-a-custom-KPI-score. If not, the report chart is not displayed in the UI. |
...