Skip to content
JodieM edited this page Nov 13, 2022 · 53 revisions

Getting Started with the Indicator Bundle

  • Edit your Lightning Record Page, and add the Indicator Bundle Component by dragging it to the desired location

  • Choose the Indicator Bundle to show on the Page. Ensure it is the correct Bundle to display for that Object

  • Choose the Icon Size and Shape to display for this Bundle

    • Don't forget to Save and Activate the Lightning Page
  • Edit the Settings in CMDT:

    • Navigate to Salesforce Setup > Custom Metadata Types
    • Scroll to Indicator Bundles or Indicator Items and click Manage Records
    • Click Edit next to the Bundle or Item you want
  • Or alternatively:

    • Navigate to the Indicator Settings Tab
    • Click the link on the Bundle or Indicator you want to edit.
    • Click the link on the Object Name to go to the list of Objects and add new Custom Metadata records.

Create the Indicator Bundle

Field Example Value Description Tip
Label Account Bundle Include the Object Name in the Label
Indicator Bundle Name Account_Bundle The API name Make the API Name the same as the Label, but include underscores instead of spaces
Card Title Account Inddicators Shows at top of card
sObject Account Choose the Object that this Bundle will be for
Card Icon standard:account The Icon name from SLDS Icons Use default icons such as standard:account, standard:opportunity
Card Text Key Indicators for Account The text to display below the Card Title
Active true Uncheck Active if you need to quickly remove the Bundle from being visible on the page
Description Shown on the Account page for standard Business Accounts Be an angel and write something useful here, especially if you have more than one bundle for the same Object. Your future self will thank you

Setup Tips

  • When adding the Indicator Bundle to the Lightning Record Page, check the Show Refresh Button Checkbox. That way, as you are building your Indicators, you can quickly refresh the Bundle to see how the changes to the settings will appear on your page.

Design Tips:

  • Titles and Icons are not required on Bundles, but they look best when the Large Icons are shown. a Bundle of small Icons used in a strip (see Examples) can look good with no Title and Icon.
  • If in doubt, just use the standard icon matching that record (eg standard:account)
  • Don't use too many colors or icon styles. Try to stick with the SLDS color pallette

Next Steps

Clone this wiki locally