AdvoLogix Help

How do I add an enhanced list to a lightning page?

Updated on

The Enhanced List is available from the component palette in the lightning page editor and is suitable for deployment to any lightning page.

Supported Display Modes

Enhanced Lists support three display modes, which are made available based on your deployment use case.  The supported display modes are:

  1. Enhanced List [Can only be used on a home page, app page, or the utility bar]
    This mode is displayed in a list view format with the ability to display a list of records for the chosen object in the component options. This mode supports the ability to retrieve a list of records based on specific filters and sort those records. It optionally allows inline editing of the records as well as the ability to quickly add new records.

  2. Related List [Can only be used on an object record page]
    This mode is displayed in a related list format and is available only when the component is placed in the context of an object's record page. This provides a simple way to view any Related List on the record with all the other abilities of enhanced lists.

  3. Batch Entry [Can be used on an object record page, home page, app page, or the utility bar]
    This mode is displayed in a batch entry interface where users can enter multiple data records all at once, for any object or related lists. This mode is available on all lightning pages and provides a quicker way to add data records.

1. Deployment Use Cases

Enhanced Lists are designed for use with any object in your organization and within all lightning pages.  The different use cases for the component include placing the component:

  • ...within the context of a given record as a related list or as a batch entry interface to quickly add multiple records or
  • ...on a home page as a dedicated enhanced list of records for any object or as a batch entry interface as well or
  • ...in the utility bar.

2. Deployment Options

Enhanced Lists are available under the Custom - Managed section of the page designer's component palette. There are multiple options available for this component: 

  • Identifier - Use a unique identifier to identify this component on the lightning page. The enhanced list can be deployed multiple times on the same page layout. This option provides each instance of the component a unique set of run-time options.
  • Header Title - Optionally display a title above the enhanced list.
  • Object - This option is available when the enhanced list is placed on a home page or utility bar.  Select from the list of available objects to render the enhanced list. 
  • Parent Relationship - This option is available when the enhanced list is placed on any object's record page.  The parent record you select will allow users to display the relationship records of the parent record instead of the relationship records of the current record.

    For example: When using the component on the matter page, choosing Parent Record as Primary Account would allow rendering of relationship records of the Primary Account set on the current matter record.

  • Relationship Name - This option is available when the enhanced list is placed on any object's record page. Use this option to include a related list for the record in your lightning page.

    For example: When using the component on the matter page, choosing expenses would render the enhanced list for the expenses which are related to the underlying matter.
    Note: The Relationship Name must always be chosen from the same parent record.

  • Display Mode - Use this to render the enhanced list in a specific display format.
  • Fields to Show - Provide a comma-separated list of field API names to display as columns.  The fields set here (by the system administrator) will be what the enhanced list always defaults back to once the local browser cache has been cleared or the user changes browsers altogether.
  • Sort By - Provide SOQL compliant sort phrase to display a sorted list of records.
    For example, CreatedDate DESC (applicable to enhanced list and related list display modes only)
  • Filter - Provide SOQL compliant filter phrase to retrieve a filtered list of records.
    For example, Type = 'Government' (applicable to enhanced list and related list display modes only)
  • Number of Rows to Display - Defaults the number of rows to show in the list.
  • List API Name - Use this to provide and select a list from the object. The provided list will display columns and records based on the configured filters (applicable to Enhanced List display mode only).  

    Tip: Follow these steps to retrieve the List API Name from the object's list view.
    Note: Selecting a list view empowers the enhanced list display columns and filters only.

  • Enable List Selection - The ability to quickly change list views, available for the object, from within the enhanced list interface.
  • Enable Quick Add - The ability to quickly add new records from within the list interface.
  • Enable Delete - The ability to delete a record from within the list interface.
  • Enable Inline Edit - The ability to quickly edit records from within the list interface.
  • Hide Action Bar - Enable this to hide the action bar displaying the new button in the list interface.
  • Hide Search - Enable this to hide the input to search within the list interface.
  • Hide List Builder - Enable this to hide the list builder option from the list interface.
  • Disable Previous Row Copy - Enable this to disable the feature of copying of data from previous row when user clicks a text input field in current row.
  • Display Icon - Optionally display the object's icon in the component header of the enhanced list.
  • Custom Icon - Provide SLDS compliant icon for the enhanced list. When left empty, we'll try to detect the tab style of the selected object and display the associated icon.  For example, standard:account

The following configuration properties are visible only when the enhanced list component is being deployed within the digital experience (community). 

  • Record Id - This value must always be set to {!recordId}. (For community record pages this is required, otherwise it can be left empty.)
  • Object Name - This value should be equivalent to the Object API Name for the value selected in the object property.
How to Find the List API Name
  1. From the App Launcher in the navigation bar, find and open the tab for the object.
  2. Select the list that you would want to use within the Enhanced List.
  3. Under List View Controls, select Rename action item that will display the current list view information in a modal dialog.
  4. Select and copy the List API Name field value from here.

 

 

Filter string supports a system defined variable CURRENT_USER_ID which can be used to filter data records by currently logged-in user's context.
(This variable can be used against any User based lookup field on the object)
For example, if we want to load records which are owned by logged in user, then your Filter may be defined as OwnerId = CURRENT_USER_ID

Previous Article Introduction to Enhanced Lists
Next Article Using an Enhanced List
Still need help? Click here!
AdvoLogix® is a registered trademark of AdvoLogix.com LLC a Texas Limited Liability Company. All references to other trademarks belonging to third parties that appear on this website, documentation, or other materials shall be understood to refer to those registered trademarks owned by others, and not to any trademark belonging to AdvoLogix. Otherwise, all material herein is the copyright of AdvoLogix.com LLC. All Rights Reserved.