Customizing the Engagement Lightning Record Page

Foundations provides a managed Lightning record page for the Engagement object. The managed page is a template that you can use to create a custom record page. It contains tabs and sections with placeholders to indicate where we recommend that you put various components.

Before customizing the page, ensure that you have performed the following:

  • Enabled the Engagement feature in Feature Console. For more information, see Enabling the Engagement Feature.
  • If Business Analytics is installed in your org and you plan on using Engagement Analytics dashboards, created an Engagement Analytics app. For more information, see Engagement Analytics Permission Sets.
  • If Revenue Management is installed in your org and you plan on using engagements in the revenue recognition process, performed the required setup. For more information, see Setting up Revenue Management for Engagements.
  • Created at least one engagement record. Otherwise, you might receive a warning and the Lightning record page might not display properly.

To create a new Engagement record page from the template:

  1. From Setup, click Object Manager | Engagement | Lightning Record Pages.
  2. Click Engagement Lightning Page Template, then click Clone. The Lightning App Builder displays.
  3. Change the label of the page so that you can identify it easily. For example, enter Engagement Record Page.
  4. [Optional] Change the description of the page. For example, enter Default record page for the Engagement object.
  5. Click Save. You are prompted to activate the new page.
  6. Click Activate. If you are not prompted to activate the page, click Activation...
  7. Click Assign as Org Default.
  8. Select Desktop and phone, then click Next.
  9. Click Save. Your new page is now saved as the org default.

The Engagement Timeline component uses your Engagement Analytics dataset to create a timeline view of the engagement sources. After creating an Engagement Analytics app, you must configure the timeline component to use the correct dataset. To do this, you must first retrieve the API name of the Engagements dataset.

To retrieve the API name of the Engagements dataset:

  1. Open Analytics Studio.
  2. Open your Engagement Analytics app.
  3. Click the Datasets tab to open it.
  4. Next to Engagements, click .
  5. Click Edit. The dataset's details display, including its API name.

To configure the Engagements dataset for the Timeline component:

  1. From Setup, click Object Manager | Engagement | Lightning Record Pages.
  2. Click the label of your custom record page to open it, then click Edit. The Lightning App Builder displays.
  3. Click the FDN Engagement Timeline component to view its configuration.
  4. Under Engagements Dataset API Name, enter the API name of the Engagements dataset from your Engagement Analytics app.
  5. Click Save.

Your Business Analytics apps contain five dashboards that you can embed in the Engagement record page. The record page template contains placeholders with instructions for adding each dashboard.

The following table lists the dashboards, their recommended location within the record page, and the suggested height of the Analytics Dashboard component.

Dashboards, Recommended Location and Component Height

Dashboard

Location in the Record Page

Component Height
Engagement Overview Page header, below the compact layout 75
Engagement Summary Summary tab 770
Engagement Services Services tab 770
Engagement Subscriptions Subscriptions tab 770
Order Management Order Management tab 840

If you don't plan on using a specific dashboard, we recommend that you remove the relevant tab from the record page. For example, if you don't use Billing Central and don't have the Engagement Subscriptions dashboard, remove the Subscriptions tab.

For steps on how to embed the dashboards, see Embedding Engagement Analytics Dashboards and Embedding the Order Management Dashboard.

For more information about embedding dashboards in Lightning pages, see the Salesforce Help.

To configure the Revenue Recognition tab:

  1. From Setup, click Object Manager | Engagement | Lightning Record Pages.
  2. Click the label of your custom record page to open it, then click Edit. The Lightning App Builder displays.
  3. Click the Revenue Recognition tab.
    Note:

    If you created your custom record page prior to Fall 2021, the Revenue Recognition tab is not available. In that case, add a new tab with the custom label Revenue Recognition.

  4. From the Components panel, drag the Related List - Single component and drop it below the placeholder text.
  5. Define the following:
    • Related List: "Revenue Contract"
    • Related List Type: "Enhanced"
  6. From the Components panel, drag another Related List - Single component and drop it below the Revenue Contract related list.
  7. Define the following:
    • Related List: "Revenue Schedule Lines"
    • Related List Type: "Enhanced"
  8. Click the placeholder text.
  9. Click to delete the placeholder text component.
  10. Click Save.