FF Alert Card Fields

This topic describes the fields that are available when customizing the FF Alert Card component in the Lightning App Builder.

Tip:

We recommend that you use these cards on clones of FinancialForce workspaces, which are Lightning app pages.

Key: * – Mandatory field

FF Alert Card Component Fields
Field		Description
Object API Name	*	The API name of the object that provides information for the component. For custom objects, include the relevant namespace, such as pse__Proj__c.
List API Name	*	The API name of the list view that provides information for the component, such as Active_Projects_Forecasting. To specify the standard All list view for a FinancialForce custom object, include the relevant namespace, such as pse__All.
Alert Title [Optional]		A custom title for the alert. If you leave the field blank, the name of the corresponding list view is displayed.
Alert Description		A custom description that is displayed below the card title. We recommend that you add a description.
Major KPI Field API Name [Optional]		When blank, this indicates that you want the component to display a count of the records in the corresponding list view. When you specify a field, the major KPI area of the component displays details relating to a specific field on the corresponding object. For custom fields, include the relevant namespace, such as pse__Billed__c . The field type of this field must support the calculation type selected for the major KPI. For more information on calculation and field type relationships, see FinancialForce Alert Card Calculation and Field Type Compatibility Matrix.
Major KPI Calculation Type		The option that determines the value displayed for the associated major KPI either as average, count, maximum, minimum, sum or unique. To find out more about the calculation types, see FinancialForce Alert Card Calculation Types. Note: The aggregate record or values or calculation output displayed of each list view might vary as the calculation performed is based on each calculation type and the corresponding selected field types. For more information on supported field types, see FinancialForce Alert Card Field Types.
Major KPI Label		A custom description for the KPI. If you leave the field blank, the corresponding object or field label is displayed, depending on your settings.
Major KPI Default Threshold Color [Optional]		The color used to display the alert card if no threshold ranges are defined or if the major KPI value is within the default range.
Major KPI Greater Than Threshold Value [Optional]		The threshold at which the alert card changes color if the major KPI value exceeds this value.
Major KPI Greater Than Threshold Color [Optional]		The color used to display the alert card if the major KPI value exceeds the Major KPI Greater Than Threshold Value.
Major KPI Less Than Threshold Value [Optional]		The threshold at which the alert card changes color if the major KPI value is less than this value.
Major KPI Less Than Threshold Color [Optional]		The color used to display the alert card if the major KPI value is less than the Major KPI Less Than Threshold Value.
Minor KPI 1 Field API Name		When you specify a field, the minor KPI 1 area of the component displays details relating to a specific field on the corresponding object. For custom fields, include the relevant namespace, such as pse__Billed__c. The field type of this field must support the calculation type selected for the major KPI. For more information on calculation and field type relationships, see FinancialForce Alert Card Calculation and Field Type Compatibility Matrix.
Minor KPI 1 Calculation Type		The option that determines the value displayed for the associated major KPI either as average, count, maximum, minimum, sum or unique. To find out more about the calculation types, see FinancialForce Alert Card Calculation Types. Note: The aggregate record or values or calculation output displayed of each list view might vary as the calculation performed is based on each calculation type and the corresponding selected field types. For more information on supported field types, see FinancialForce Alert Card Field Types.
Minor KPI 1 Label		A custom description for the KPI. If you leave the field blank, the corresponding field label is displayed.
Minor KPI 2 Field API Name		When you specify a field, the minor KPI 2 area of the component displays details relating to a specific field on the corresponding object. For custom fields, include the relevant namespace, such as pse__Bookings__c. The field type of this field must support the calculation type selected for the major KPI. For more information on calculation and field types relationship, see FinancialForce Alert Card Calculation and Field Type Compatibility Matrix.
Minor KPI 2 Calculation Type		The option that determines the value displayed for the associated major KPI either as average, count, maximum, minimum, sum or unique. To find out more about the calculation types, see FinancialForce Alert Card Calculation Types. Note: The aggregate record or values or calculation output displayed of each list view might vary as the calculation performed is based on each calculation type and the corresponding selected field types. For more information on supported field types, see FinancialForce Alert Card Field Types.
Minor KPI 2 Label		A custom description for the KPI. If you leave the field blank, the corresponding field label is displayed.