Record Page Standards


Record page standards provide guidelines for when to create new record pages and how to name them. They also provide guidelines for selecting a template and organizing Lightning components.

Naming standards for record pages use the title case and Pascal case conventions. Learn more about title case and Pascal case in Component Standards.

Creation

Nimble AMS includes at least one record page for every object. Some Nimble AMS objects that use record types also include a record page for each record type.

Nimble AMS record pages are not directly editable, but they can be cloned. Also, custom objects automatically create a default record page. Therefore, the scenarios in which you generally need to create a new record page are:

  • After you create a new record type for a Nimble AMS object and none of the record pages display Lightning components in the desired template or arrangement.
  • After you create a custom object and want to use a different template than the template used by the default record page.

Naming

Since Lightning App Builder is also used to create other types of pages, such as home pages, it is important to distinguish the type of page you are creating within the name. The standard for naming a record page depends on whether the record page is used as a default for all records or if it is assigned to a specific record type.

Default Record Pages

For a record page that is not assigned to a specific record type, enter a name in title case and an API name in Pascal case with the format:

[association acronym] [object name] Record Page

For example, the association acronym for the International Society for the Exceptionally Nimble is ISEN. For a custom Widget object with no record types:

  • Name: ISEN Widget Record Page
  • API Name: ISENWidgetRecordPage

Nimble AMS record pages that are not assigned to a record type are named  Nimble AMS [object name] Record Page with the API name in Pascal case. For example, Order has no record types and therefore has a single record page:

  • Name: Nimble AMS Order Record Page
  • API Name: NimbleAMSOrderRecordPage

Record Type Record Pages

For a record page assigned to a specific record type, enter a name in title case and an API name in Pascal case with the format:

[association acronym] [object name] Record Page - [record type name]

For example, the association acronym for the International Society for the Exceptionally Nimble is ISEN. For a custom Widget object with a record type of "Adjustable:"

  • Name: ISEN Widget Record Page - Adjustable
  • API Name: ISENWidgetRecordPageAdjustable

Nimble AMS record pages assigned to specific record types are named with the format Nimble AMS [object name] Record Page - [record type name] with the API name in Pascal case. For example, the Product record type Donation has a record page assigned to it:

  • Name: Nimble AMS Product Record Page - Donation
  • API Name: NimbleAMSProductRecordPageDonation

Template

Salesforce provides several page template options when creating a new record page.

We recommend two templates to maximize consistency across record pages. The template you select depends on how the record is used:

Template Name Description
Header & Right Sidebar

Staff can view the most important information in the main column and additional information simultaneously in a smaller sidebar on the right. This template is ideal when staff view, interact, and collaborate on different pieces of information simultaneously, such as Chatter, Activities, and multiple related lists. 

Header & One Column

Staff can view all information in the main column. This is ideal when staff do not need to collaborate on records, create activities, nor view related lists simultaneously with record details. This template is also ideal if the information in the main column needs more space to be clearly read.

Header

In the header, place the following Lightning components in this sequence:

  1. The Highlights Panel component. This component displays important data and actions for the record, determined by the record's compact layout and page layout, respectively.
    1. Learn more about Compact Layout Standards and Page Layout Standards.

    If a frequently used action is relegated to the dropdown menu—that is, staff have to click Show More Actions For This Record to access the action—increase the number of Visible Action Buttons so it is immediately available to staff.

  2. The Related List Quick Links component. This component displays multiple related lists in quick succession just by hovering over a link. Learn more (external).

Naming Tabs

When naming a tab, use standard labels whenever possible. Specifically, we recommend the following standard labels:

Tab Standard Label Description
Activity
Displays activities
Build Displays the related list group for configuration objects
Chatter Displays the Chatter publisher and feed
Details Displays record detail
Engagement Displays the related list group for historical objects
Order Displays the related list group for order process objects
Related displays miscellaneous related lists that do not belong in a related list group

Identifying Related List Groups

You can use Lightning record pages to place related lists in any sequence anywhere on the record page. To take advantage of this, we recommend using the Related List - Single Lightning component instead of the Related Lists Lightning component.

Instead of having a single Related tab that contains all related lists for the record, offload object-based related lists—that is, related lists that are not standard such as Files, Notes, and object history—into up to three additional "related list group" tabs. Each related list group tab contains a subset of related lists that share a similar relationship with the record and they reduce page scrolling and loading times.

Most Nimble AMS objects have at least one related list group. We recommend creating a tab for the following related list groups wherever possible:

Rank Related List Group Tab Label Description
1 Build
Build

Related lists used for configuration and setup of functionality.

For example, on an event record, the Build tab displays various related records to set up the event, such as products, event session groups, and event questions.

2 Order Order

Related lists corresponding to the Nimble AMS order process, such as carts, orders, and transactions.

For example, on a donation record, the Order tab displays related order information, such as the order item lines.

3 Engagement Engagement

Related Lists components involving historical/participation records for an account, such as committee memberships, registrations, and memberships.

For example, on a membership type record, the Engagement tab displays related membership records.

If an object includes more than one related list group tab, we recommend placing them in the sequence indicated by their rank. The "Main Column" and "Right Sidebar" sections below provide specific sequence recommendations.

For objects with a lot of related lists or configuration information, you can nest a Tabs Lightning component within another Tabs Lightning component to create sub-tabs. For example, sub-tabs are used on the Nimble AMS Entity Record Page.

Main Column

Place a single Tabs Lightning component in the main column and create applicable tabs—and Lightning components inside each tab—with the following sequence and configuration:

Tab Sequence Tab Label Lightning Component(s) & Sequence
1 Related
  1. Related List - Single: Files
  2. Related List - Single: Notes

    If your org is not configured to use both Files and Notes, use the Notes & Attachments related list instead.

  3. Related List - Single: [object name] History

  4. One or more Related List - Single Lightning components for related lists not included in any of the related list group tabs.

2

Details

  1. Record Detail

3

[related list group, 1st rank]

Only include this tab here if you are not including it in the right sidebar. If this tab contains three or more Related List - Single components, consider placing it in the main column because there is more space.

  1. Related List - Single (one for each related list in the group)
4 [related list group, 2nd rank]
  1. Related List - Single (one for each related list in the group)
5 [related list group, 3rd rank]
  1. Related List - Single (one for each related list in the group)

In the Tabs Lightning component, set Details as the default tab.

Right Sidebar

Place a single Tabs Lightning component in the right sidebar and create applicable tabs—and Lightning components inside each tab—with the following sequence and configuration:

Tab Sequence Tab Label Lightning Component(s) & Sequence
1 [related list group, 1st rank]
  1. Related List - Single (one for each related list in the group)

    Only include this tab here if you are not including it in the main column. If this tab contains more three or more Related List - Single components, consider placing it in the main column because there is more space.

2 Activity
  1. Activities
3 Chatter
  1. Chatter

In the Tabs Lightning component, set the first tab as the default tab.


On This Page

In This Section