Saturday, May 30, 2020

CMTD Enhanced Related List

In Summer 19 release, Salesforce introduces Enhanced Related Lists. Enhanced List offers more features compared to the older Basic List or Tile option.

Enhanced Related Lists features:
  • Set the number of records to display in the related list
  • Show list view action bar
  • Refresh button
  • Wrap text in the column
  • Resize and sort columns
  • More than 4 fields on the related list (compare to the Basic List)


Basic List

Enhanced List

But, to filter related list, you have to click "View All" at the bottom of the related list, then click the Filter icon, from there, you can add quick filters to the related list with Filter icon. Related list quick filters act similarly to list view filters except they aren’t saved, persist only throughout your current session, and can’t be shared.

CMTD Enhanced Related List is a “Custom Metadata Type Driven” custom lightning component that provides enhanced features to display related list records in Lightning App.

The component supports configurable filter, sort, and fields to group relevant records together. It supports List and Tile mode with the Lightning look and feels. Use Badge UI Override to highlight important fields to the user.

Use and configure these components on any child objects and boost your lightning implementation. Configure the Filter, Sort, and Fields on this reusable component on any lookup records to group relevant records in a single page (eg: Open and Closed Cases).

First, you need to install this component from AppExchange, as per the Lightning component requirements, you need to enable my domain.

Below is the 3-step process to start using this component:
1. Create configuration data records in the Custom Metadata Type
2. Drag and drop the component in the App Builder
3. Configure component attributes to suit your design

1. Create configuration data records in the Custom Metadata Type

- From the setup menu, go to Custom Metadata Type 
- Click "Manage Records" on Custom Metadata Type created as part of CMDT installed package.
- Click the New button and enter the info, see sample below:

All the above fields will be shown in the CMDT Lightning component. here is the basic explanation:
- Enhanced Related List Name: imagine this as API field name, so not really use in layout
- Label: this would be header label in the table
- Related List Name: this should match with Related List Name in the component
- Field API Name: this is to match values to retrieve from this field
- Order: from left to right
- Target API Name: add value here will allow the user to click and open the record

2. Drag and drop the component in the App Builder
Edit the lightning page and looks for the "CMDT Enhanced Related List" component under Custom - Managed.

3. Configure component attributes to suit your design
Once the component added, click the component to configure it.

In the sample screenshot above, the component added to the Account lightning page:
- Related List Name: this is the same value configured in the Custom Metadata Type 
- Filter is configured in the component, not in Custom Metadata Type 
- Record sort also configured in the component, not in Custom Metadata Type 

Here is the final result:

Type: Managed Package; AppExchange

Paid/Free: free

Publisher: Salesforce Labs

Version: 2.6.0

Blog last updated: 30 May 2020


  1. Please make the screenshots bigger, cant see any details

    1. thanks for the feedback, it was originally big, blogger make it smaller, blogger change something recently.

  2. I really needed this functionality and this post was a great help! Thank you for the nice instructions!

    1. good to hear it, let me know if you have issues if you use this prod, like any performance issue?

  3. Hi WonJeung,

    Thank you very much for your post. I finally figured out how to set it up. I saw your "Enhanced List" example screenshot and wondering "CMTD Enhanced List" still doesn't allow us to set up the resort button appearing on the each header?