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 a FinancialForce Workspace or Lightning App page.

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

The component is configured to include the number of active projects and the associated values for bookings and billed activity.

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

  • The major KPI displays a count of active projects
  • The minor KPIs display:
    • The value that has been billed for those projects so far
    • The total value that will be billed when all projects are completed

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   Leave the field blank to display the name of the corresponding list view.
Alert Description   Leave blank.
Major KPI Field API Name   Leave blank to indicate that you want to display a count of the records in the corresponding list view.
Major KPI Calculation Type Count

Leave the calculation type as the default value. Sum is not appropriate for the selections provided.
Major KPI Description   Leave blank to display the corresponding object name.
Minor KPI 1 Field API Name pse__Bookings__c The field used to provide information for the KPI.
Minor KPI 1 Calculation Sum

Displays the sum of the values in the specified field for the records in the corresponding list view.

Minor KPI 1 Description Bookings value A custom description for the KPI.
Minor KPI 2 Field API Name pse__Billed__c

The field used to provide information for the KPI.

Minor KPI 2 Calculation Type Sum

Displays the sum of the values in the specified field for the records in the corresponding list view.

Minor KPI 2 Description 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 Component 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.
    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. This field must be of type Number or Currency. The value displayed depends on the associated calculation type.
    2. If you entered a field name, specify the major KPI calculation type, either:
      • Count - A count of the records in the corresponding list view that contain a value for the specified field. This option is selected by default.
      • Sum - A sum of the values in the specified field for the records in the corresponding list view.
    3. [Optional] Enter a description. If you leave the field blank, the corresponding object or field label is displayed, depending on your settings.
  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. This field must be of type Number or Currency.
    2. If you entered a minor KPI field API name, specify the calculation type.
    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.