Setting up FinancialForce Alert Cards

This topic describes how to add the FF Alert Card component to a Lightning page that you have cloned from a FinancialForce workspace. For more information about the overall process, see Adding Customizable Lightning Components to FinancialForce Lightning Pages.

Note: You can set up color coding for numerical major KPI values so that an alert card changes color if its major KPI value is outside the default range.

This section provides an example of an alert card that provides project information for a PSA service leader.

The following key performance indicators (KPIs) are displayed in the alert card:

  • Define a major KPI by specifying an appropriate object and list view. You can then select whether you want to display -
    • The count of records in the list view.
    • The count of unique values in the list view
    • Average, count, maximum, minimum, sum or unique count of values for a specific field.
    • The card in a different color to help the user understand the current state of the record.
  • Define up to two minor KPIs by specifying appropriate fields. You can select whether you want to display an average, count, maximum, minimum, sum or unique count of the values.

For more information on the calculation types supported when defining the major and minor KPIs and associated field types, see Calculation Type and Field Type Compatibility Matrix.

The following table displays the values entered to set up the component.

Field Value Details
Object API Name pse__Proj__c The object used to provide information for the KPI (Projects).
List API Name Active_Projects_Forecasting The list view used to provide information for the KPI (Active Projects Status List).
Alert Title [Optional]   Leave the field blank to display the name of the corresponding list view.
Alert Description   Leave blank.
Major KPI Field API Name [Optional]   Leave blank to indicate that you want to display a count of the records in the corresponding list view.
Major KPI Calculation Type Unique

Leave the calculation type as the default value. Sum is not appropriate for the selections provided.
Major KPI Label   Leave blank to display the corresponding object name.
Major KPI Default Threshold Color [Optional] Orange The color that the alert card is displayed in if the major KPI value is within the default range. Gray is used as the default color unless you change it.
Major KPI Greater Than Threshold Value [Optional] 10 If the major KPI value exceeds this threshold value, the alert card is displayed in the color chosen for the Major KPI Greater Than Threshold Color.
Major KPI Greater Than Threshold Color [Optional] Green 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] 5 If the major KPI value is less than this threshold value, the alert card is displayed in the color chosen for the Major KPI Less Than Threshold Color.
Major KPI Less Than Threshold Color [Optional] Red 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 [Optional] pse__Bookings__c The field used to provide information for the KPI.
Minor KPI 1 Calculation Type Unique

Displays the values as per the calculation type for the specified field of the records in the corresponding list view.

Minor KPI 1 Label [Optional] Bookings value A custom description for the KPI.
Minor KPI 2 Field API Name [Optional] pse__Billed__c

The field used to provide information for the KPI.

Minor KPI 2 Calculation Type Unique

Displays the values as per the calculation type for the specified field of the records in the corresponding list view.

Minor KPI 2 Label [Optional] Billed value A custom description for the KPI.

To add a customizable alert card to a Lightning app page:

  1. From Setup, navigate to the Lightning App Builder.
  2. Edit the Lightning app page you want to add the component to.
  3. Click and drag the FF Alert Card component to the relevant part of the Lightning page layout. As you make changes to the component, the Lightning App Builder displays a preview of your updates.
  4. In the properties pane, complete the following information:
    1. Enter the API name of the object that you want to provide information for the component. For custom objects, include the relevant namespace, such as pse__Proj__c.
      Note: When adding a Salesforce object you must check to ensure it is supported. For more information, see Supported Objects in the User Interface API Developer Guide in the Salesforce Developers Help.
    2. Enter the API name of the list view that provides information for the component, such as Active_Projects_Forecasting.

      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 FinancialForce custom object, include the relevant namespace, such as pse__All.
    3. [Optional] Enter a title for the count. If you leave the field blank, the name of the corresponding list view is displayed.
    4. [Optional] Enter a description.
  5. [Optional] Complete the following information for the major KPI:
    1. In the Major KPI field, do one of the following:
      • Leave the field blank to display a count of the records in the corresponding list view.
      • Enter the API name of the field that you want to provide the details for the major KPI, 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.
    2. If you entered a field name, select the major KPI calculation type. Available options are average, count, maximum, minimum, sum or unique.
      Note: The aggregate record or value 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 field types, see FinancialForce Alert Card Field Types.
    3. [Optional] Enter a description. If you leave the field blank, the corresponding object or field label is displayed, depending on your settings.
    4. Select the color used to display the alert card if the major KPI value is within the default range.
    5. [Optional] To make the alert card change color if the major KPI value exceeds a specific value, enter the threshold value in the Major KPI Greater Than Threshold Value field and select the color you want to apply.
    6. [Optional] To make the alert card change color if the major KPI value is less than a specific value, enter the threshold value in the Major KPI Less Than Threshold Value field and select the color you want to apply.
  6. [Optional] Complete the following information for each minor KPI:
    1. Enter the API name of the field that provides the details for the minor KPI. 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 minor KPI. For more information on calculation and field type relationships, see FinancialForce Alert Card Calculation and Field Type Compatibility Matrix.
    2. If you entered a field name, select the minor KPI calculation type. Available options are average, count, maximum, minimum, sum or unique.
      Note: The aggregate record or value 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.
    3. [Optional] Enter a description for the minor KPI. If you leave the field blank, the corresponding field label is displayed.
  7. [Optional] Apply additional filter logic to display the information that meets your specific requirements.

    For more information on controlling component visibility, see the Salesforce Help.

  8. Save the page.