Setting up Certinia KPI Cards
This topic describes how to add and configure an FDN KPI Card component on a Lightning app page or record page. For more information about the overall process, see Adding Customizable Lightning Components to Certinia Lightning Pages.
The card displays a KPI value that is calculated from the list view, and optionally a field for an object. You can set thresholds that determine the color of the card. If you don't set a threshold the card uses a default color.
To add and configure a KPI card:
- Edit the page you want to add the component to. The Lightning App Builder is displayed.
- From the custom components list, drag the FDN KPI Card component on to the page.
- In the component properties, add the following details, as needed:
- On an app page, enter the API name of the object that contains the information for the component. For custom objects, include the relevant namespace, such as pse__.
- Depending on the page type, enter or select the name of the list that provides information for the card:
- On an app page, enter the API name of the list view.Find a List View API Name
To identify the API name of a list view, navigate to the list view and select the option to rename it. The API name for the list view is displayed. For more information, see the Salesforce Help.
To specify the standard All list view for a custom object, include the relevant namespace, such as pse__All.
- On a record page, select the name of the related list.
This picklist can include related lists that are defined, but not assigned to the record. If you select an unassigned related list, an error is displayed on the card.
- On an app page, enter the API name of the list view.
- [Optional] Enter a title for the card. If you leave the field blank:
- On a record page, the plural name of the object is used.
- On an app page, the list view name is used.
- Enter a description for the card. We recommend that you add a description.
- [Optional] Enter the API name of the field used to calculate the KPI. If blank, the total number of records in the selected list view is used. Enter a field name to display the value of the field for all records in the list view.
- Select the calculation type for the field name. If you have not entered a field API name, the default calculation type is Count.
- [Optional] Enter a label for the card. If you leave the field blank:
- On a record page, the field API name is used. If the Field API Name field is blank, the object in the Related List Name is used.
- On an app page, the field API name is used. If the Field API Name field is blank, the object in the Object API Name field is used.
- [Optional] Select a default color for the card when the thresholds are not applied, or when the card's value is within the thresholds.
- [Optional] Enter a value between 0 and 100 for the higher threshold. Card values higher than this are highlighted with the color defined in the Greater Than Threshold Color field.
- [Optional] Select a color for the card when its value is higher than the value in the Greater Than Threshold Value field.
- [Optional] Enter a value between 0 and 100 for the lower threshold. Card values lower than this are highlighted with the color defined in the Less Than Threshold Color field.
- [Optional] Select a color for the card when its value is lower than the value in the Less Than Threshold Value field.
- Click Save.
For more information on controlling component visibility, see the Salesforce Help.