Embedding Engagement Analytics Dashboards

The Engagement Analytics app contains four dashboards that you can embed in the engagement record page. This allows your users to easily view all the relevant analytics data related to the engagement that they are viewing. Foundations contains a template that you can use to build a custom record page. The template uses a predefined layout and placeholder text to help you embed the dashboard in the recommended sections of the page. For more information, see Setting up the Engagement Functionality.

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

Note:

Depending on how you set up your Engagement Analytics app, some dashboards might not be available. In that case, we recommend removing the relevant tab from the Lightning record page.

Dashboards, Recommended Location, and Component Height

Dashboard

Location in the Record Page

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

The Order Management dashboard is included in your Financial Analytics app.

See the sections below for steps on adding the dashboards to the record page.

To add the Engagement Overview dashboard to the header of the record page:

  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. From the Components panel, drag the CRM Analytics Dashboard component and drop it below the placeholder text in the page header area. The component's configuration options display.
  4. Define the following:
    • Dashboard: "Engagement Overview"
    • Height: 75
    • Show Share Icon: deselected
    • Show Title: deselected
    • Show Header: deselected
    • Open Dashboard: "Disable open dashboard feature"
    • Open Links in New Windows: selected
    • Hide on Error: selected
  5. Filter the dashboard by the ID of the engagement. This ensures that the dashboard only displays data for the engagement currently displayed on the record page. To define the filter:
    1. Under Dashboard Filters, click Filter Builder.
    2. Click + Add Dashboard Filter.
    3. Under Dataset, select "Engagements".
    4. Under Dataset Field, select "Engagement ID".
    5. Under Operator, select "Equals".
    6. Under Object Field, click Select.
    7. From the Select Field picklist, select "Record ID".
    8. Click Done.
    9. Click OK. The filter is now defined.
  6. Click the placeholder text.
  7. Click to delete the placeholder text component.
  8. Click Save. The dashboard is now added to your engagement record page.

To add the Engagement Summary dashboard to the Summary 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 Summary tab to open it if it's not already open.
  4. From the Components panel, drag the CRM Analytics Dashboard component and drop it below the placeholder text. The component's configuration options display.
  5. Define the following:
    • Dashboard: "Engagement Summary"
    • Height: 770
    • Show Share Icon: deselected
    • Show Title: deselected
    • Show Header: deselected
    • Open Dashboard: "Disable open dashboard feature"
    • Open Links in New Windows: selected
    • Hide on Error: selected
  6. Filter the dashboard by the ID of the engagement. This ensures that the dashboard only displays data for the engagement currently displayed on the record page. To define the filter:
    1. Under Dashboard Filters, click Filter Builder.
    2. Click + Add Dashboard Filter.
    3. Under Dataset, select "Engagements".
    4. Under Dataset Field, select "Engagement ID".
    5. Under Operator, select "Equals".
    6. Under Object Field, click Select.
    7. From the Select Field picklist, select "Record ID".
    8. Click Done.
    9. Click OK. The filter is now defined.
  7. Click the placeholder text.
  8. Click to delete the placeholder text component.
  9. Click Save. The dashboard is now added to your engagement record page.

To add the Engagement Services dashboard to the Services 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 Services tab to open it.
  4. From the Components panel, drag the CRM Analytics Dashboard component and drop it below the placeholder text. The component's configuration options display.
  5. Define the following:
    • Dashboard: "Engagement Services"
    • Height: 770
    • Show Share Icon: deselected
    • Show Title: deselected
    • Show Header: deselected
    • Open Dashboard: "Disable open dashboard feature"
    • Open Links in New Windows: selected
    • Hide on Error: selected
  6. Filter the dashboard by the ID of the engagement. This ensures that the dashboard only displays data for the engagement currently displayed on the record page. To define the filter:
    1. Under Dashboard Filters, click Filter Builder.
    2. Click + Add Dashboard Filter.
    3. Under Dataset, select "Engagements".
    4. Under Dataset Field, select "Engagement ID".
    5. Under Operator, select "Equals".
    6. Under Object Field, click Select.
    7. From the Select Field picklist, select "Record ID".
    8. Click Done.
    9. Click OK. The filter is now defined.
  7. Click the placeholder text.
  8. Click to delete the placeholder text component.
  9. Click Save. The dashboard is now added to your engagement record page.

To add the Engagement Subscriptions dashboard to the Subscriptions 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 Subscriptions tab to open it.
  4. From the Components panel, drag the CRM Analytics Dashboard component and drop it below the placeholder text. The component's configuration options display.
  5. Define the following:
    • Dashboard: "Engagement Subscriptions"
    • Height: 770
    • Show Share Icon: deselected
    • Show Title: deselected
    • Show Header: deselected
    • Open Dashboard: "Disable open dashboard feature"
    • Open Links in New Windows: selected
    • Hide on Error: selected
  6. Filter the dashboard by the ID of the engagement. This ensures that the dashboard only displays data for the engagement currently displayed on the record page. To define the filter:
    1. Under Dashboard Filters, click Filter Builder.
    2. Click + Add Dashboard Filter.
    3. Under Dataset, select "Engagements".
    4. Under Dataset Field, select "Engagement ID".
    5. Under Operator, select "Equals".
    6. Under Object Field, click Select.
    7. From the Select Field picklist, select "Record ID".
    8. Click Done.
    9. Click OK. The filter is now defined.
  7. Click the placeholder text.
  8. Click to delete the placeholder text component.
  9. Click Save. The dashboard is now added to your engagement record page.

For steps on adding the Order Management dashboard, see Adding the Order Management Dashboard to the Engagement Lightning Record Page.