How to Create a Related List

Overview

Related Lists allow you to relate multiple records between entities that have existing parent-child or reference relationships to a single record.  After being created, lists will look like the table below, and allow you to enter as many records as needed.

 

Procedure

Step 1. Select the Correct Entity

To begin, you will need to select the entity in which you need to place a related list.  Select the Setup tab, then under Develop, select Entity.  You will be shown a list of existing entities.  Select the entity in which to place the related list.

e.g. If you want the related list to be in the account form, select the ACCOUNT entity.

Once you have the correct entity selected, select Fields to show the list of existing fields.  Select the new button to continue creating the new field.

 

Step 2. Complete the Form

The new field form will look similar to below.  To create a related list, use the following table to complete the form.

Note: You will need to select "RELATED LIST" in the field type drop down in order to see the appropriate fields.

 

Field Description
Field Name Enter a system name for the related list.  This name must only contain XML valid characters.
Display Label Enter a UI friendly label that will be shown on the form.
Description Enter a description for the new related list.
Status Determine if the field will be Active or Deactivated.
Data Type To create a related list, select RELATED LIST here.
Allow Create Checking this will allow you to enter records into the Related List.
Allow Update Checking this will allow you to update records in the Related List.
Related List Entity Select the entity in which you would like to associate records.  If you do not see the entity you want to reference, check the entity and make sure you have Related List selected in the setup AND the entity should have a form of relationship with the current entity. If there is none, create a relationship by creating a parent-child relationship between these two entities or creating a LOOKUP-type field on either entity before attempted to create a related list.
Relation Path This indicates the field on the child entity that will be used to relate it to the parent entity record. When this is left blank, it will be automatically populated by the Id field of the child entity.
Related List Layout This allows the selection of the LIST layout of the child entity that will be used when displaying the child records on the UI of the parent. By default, this is the DEFAULT LIST configured on the child entity. Otherwise, an alternative list can be selected by clicking the pulldown list.
Records Per Page

This indicates the number of records that are displayed on the related list field per page before having to click the list page navigation buttons.

Display After Select the field in which to place the Related List under.
Display Mode Select the conditions where the Related List will display.
Lookup and Related List Filter

You may determine the search criteria that will display when the related list popup displays.  This can help you narrow down the selections if there are many records in the entity. The object reference model can be used here, particularly fields related to the current entity's parent or reference lookups can be used for the conditions.

If this section is not visible, open the new field after the initial save to expose this section. This table will be auto-populated with the parent-child lookup field and additional filters can be added as needed.

Role Permissions Use the table to set what users and see or interact with the Related List.
Cascading Field Rules Controls the visibility and ability to edit of the new field depending on the values of other fields in the entity.
Help System Complete the field to allow the help icon to display and show your help text.

 

Step 3. Save Your Related List

Select the Submit button to save the Related List.

Additional Features

The following features are supported by the related list fields:

  1. Handle multiple related list fields on a single entity.
  2. Handle multiple related list fields on a single entity that are all referring to the same related list entity. Each of these related list fields can use a different layout configured on the reference entity as well as also be configured to use different filter conditions.
  3. if the related list field is added to a child entity, fields on the child's parent entity can be used for filter conditions if the reference entity of the child's related list field is pointed to an entity with a reference relationship with the parent entity.
  4. New child records can be created from the parent entity's UI using the New button. This will display a pop-up that will display the same fields that will be displayed if a new record is created on the actual child entity's UI. Click the Submit button to save the new record.

 

Have more questions? Submit a request

Comments

Powered by Zendesk