Skip to content

Check Set fields

Reference11 min read

Look up every field of a Record Health Check Set by its Setup label or API name: what it does, its allowed values, its default, and how it changes the record-page card.

Setup valueName
Custom Metadata Type labelRecord Health Check Set
Custom Metadata Type API nameRecord_Health_Check_Set__mdt

A Check Set decides which Salesforce object to check and how the Record Health Check card behaves. Create or review a Check Set in Setup → Custom Metadata Types → Record Health Check Set → Manage Records.

For a guided example that creates both a Check Set and its Checks, start with Create your first Check.

What you want to configureFields
Name the Check Set and choose its Salesforce objectLabel and Developer Name, Object, Active
Choose when the card runsWhen Checks Run, Stop after a system error
Choose how the card looksCard Title, Card Subtitle, Reveal Mode, Run button fields
Choose which result details appearFound/Expected Display, Passed Checks, Skipped Checks, Summary Display
Troubleshoot a Check SetShow Diagnostics
Publish Platform EventsPublish User Run Event, Publish Error Log Event
Setup labelAPI nameRequiredLimitExample
LabelMasterLabelYes40 charactersAccount readiness
Developer NameDeveloperNameYes40 charactersAccount_Readiness

Label identifies the Custom Metadata record in Setup. It is not the title shown on the Lightning card.

Developer Name is the stable name Salesforce creates from the label; Setup shows it as Record Health Check Set Name. Flow and Apex identify a Check Set by its Qualified API Name, which Names and API identities shows how to find:

  • A Check Set created by an administrator in your org might be Account_Readiness.
  • A Check Set included with the installed package might be rhc__Example_Account_Check_Builder_Guide.

Do not add or remove rhc__ yourself.

AttributeValue
TypeText(80), required
DefaultNone
ExampleAccount, Opportunity, or My_Object__c

Enter the exact API name of the Salesforce object this Check Set checks. It must match the object of the record page where the Record Health Check component is placed. For example, an Account Check Set uses Account and belongs on an Account record page.

If the objects do not match, the Check Set does not appear in the Lightning App Builder picker, and a card that is already set to it shows “This Record Health Check isn’t configured for this type of record.” The comparison ignores letter case.

The picker lists only active Check Sets for the page’s object, each as Label (Qualified API Name). When it is empty, confirm Active, compare this Object API name with the record page’s object, confirm that the person editing the page has a Record Health Check permission set such as Record Health Check Card User, and reload Lightning App Builder after the permission or metadata change.

AttributeValue
TypeCheckbox
DefaultSelected (true)

Leave Active selected to allow the Check Set to load and run. Clear it to temporarily disable the entire Check Set without deleting it. The card then shows Record Health Check Needs Setup with the message “This Record Health Check is currently inactive.” instead of running its Checks. Flow and Apex requests for an inactive Check Set are rejected.

Clear Active to stop a Check Set in a way you can reverse. Deleting it instead breaks every record page that selects it and leaves its Checks without a parent, so back up the configuration and remove the Check Set from record pages first.

Required Text(255). This is the main heading users see on the Lightning record page. Use short text that says what the card checks. Example: Account readiness.

Optional Text(255). This explanation appears immediately below Card Title. Use it to say when or why the user should run the Check Set. Example: Review before the weekly pipeline meeting.

Card Heading Display (CardHeadingDisplay__c)

Section titled “Card Heading Display (CardHeadingDisplay__c)”

Optional restricted picklist: TITLE_AND_SUBTITLE (Show title and subtitle, default), TITLE_ONLY (Show title only), or HIDE (Hide). A blank value shows the title and subtitle. Hide removes the complete heading strip, including the Run or Rerun button, so it is valid only when When Checks Run is When the page opens. A Check Set that waits for the user to click Run and hides its heading is invalid: the card shows a setup error, and configuration validation reports it. Card Title remains required because it is still the card’s accessible name for screen readers when the heading is hidden.

Reveal Mode changes how Check rows appear. It does not change which Checks run, their order, or their results.

Setup choiceStored valueWhat the user sees
All at onceALL_AT_ONCEAll applicable Checks appear first as pending; results fill in as the Checks finish.
One by oneONE_BY_ONEA Check appears when Record Health Check reaches it. This is the default.

This is an optional restricted picklist. The default is One by one.

Found/Expected Display (FoundExpectedDisplay__c)

Section titled “Found/Expected Display (FoundExpectedDisplay__c)”

This field controls when the card shows the value found on the record and the value the Check expected.

Setup choiceStored valueWhat the user sees
Show on demandON_DEMANDUsers can expand a Check to see the values; failed Checks also show them inline. This is the default.
Show for failed checksFAILURES_ONLYValues appear only for failed Checks.
Show for every checkALL_ROWSValues appear inline for every Check that provides them.

This setting cannot display a value that the Check did not return. Also review whether a Found or Expected value contains information that should not be shown to every card user.

Setup choiceStored valueWhat the user sees
Show each passed checkSHOW_EACH_CHECKEvery passed Check remains in the list. This is the default.
Show passed count onlySHOW_COUNT_ONLYPassed rows are hidden, but their total remains in the card summary.
Setup choiceStored valueWhat the user sees
Show each skipped checkSHOW_EACH_CHECKEvery skipped Check remains in the list. This is the default.
Show skipped count onlySHOW_COUNT_ONLYSkipped rows are hidden, but their total remains in the card summary.

A Check can be skipped because it does not apply to the record or because a prerequisite Check did not pass. Hiding the row does not change the result.

Setup choiceStored valueWhat the user sees
Show above checksTOPThe result summary appears above the Check rows.
Show below checksBOTTOMThe result summary appears below the Check rows. This is the default.
HideHIDENo summary bar; individual Check results remain visible.

The setting applies to both the overall summary and category-based summaries. When Checks use categories, the grouped category summaries replace the overall totals at the selected position.

Setup choiceStored valueBehavior
When the page opensRUN_ON_LOADThe card checks the record automatically. Afterward, it shows Rerun unless Run Button Display or Card Heading Display is Hide.
When the user clicks RunRUN_ON_REQUESTThe card waits for the user to click Run. This is the default.

This setting controls only the Lightning card. Flow and Apex run when the Flow or Apex code calls Record Health Check.

Stop after a system error (StopOnSystemError__c)

Section titled “Stop after a system error (StopOnSystemError__c)”
AttributeValue
TypeCheckbox
DefaultCleared (false)

Leave this field cleared when independent Checks should continue after one Check encounters an unexpected system error. Select it when later Checks depend on the same technical operation and continuing would likely repeat the error.

This field stops the run only after an ERROR. It does not stop after FAIL, SKIPPED, or UNABLE_TO_EVALUATE. The Checks that had not run yet appear as Skipped with Reason Code STOPPED_AFTER_ERROR.

The field applies only to the record-page card. When it is selected, the card runs one Check at a time instead of several at once, so results can take longer to appear. Flow, Apex, background jobs, Agentforce, and the REST API ignore it and evaluate every Check.

These fields control the Run and Rerun action in the Lightning card header.

Setup choiceStored valueWhat the user sees
Show label and iconLABEL_AND_ICON (default)A button with the icon and the Run or Rerun label
Show label onlyLABEL_ONLYA button with the label and no icon
Show icon onlyICON_ONLYAn icon button. The label is not shown but remains the button’s name for screen readers
HideHIDENo button. Valid only when When Checks Run is When the page opens

Use Hide only when When Checks Run is When the page opens. A Check Set that waits for the user to click Run and hides the button is invalid: the card shows a setup error, and configuration validation reports it.

Optional Text(80). It labels the first Run action. Leave it blank to use Run. In Show icon only mode, this text is still the action’s accessible name. Example: Check now.

Optional Text(80). It labels the action after the first completed run. Leave it blank to use Rerun. In Show icon only mode, this text is still the action’s accessible name. Example: Check again.

Optional Text(80). Enter a Salesforce Lightning Design System icon name in lowercase category:name format, such as utility:refresh or utility:play. Leave it blank to use the card’s built-in play icon; a value in any other format also shows the built-in icon. The same icon is used for Run and Rerun.

AttributeValue
TypeCheckbox
DefaultCleared (false)

Select this field temporarily when an administrator needs technical details on the card and in the browser console. The user sees those details only when both conditions are true:

  1. Show Diagnostics is selected on the Check Set.
  2. The user has a direct, active assignment of the installed Record Health Check Diagnostics Viewer or Record Health Check Admin Permission Set.

Other users continue to see the standard card. Clear this field after troubleshooting because the details can contain object names, field names, formulas, or queries. See Troubleshoot with Show Diagnostics.

Publish User Run Event (PublishUserRunEvent__c)

Section titled “Publish User Run Event (PublishUserRunEvent__c)”
AttributeValue
TypeCheckbox
DefaultCleared (false)

Select this field only when a Platform Event-triggered Flow, Apex trigger, or integration must receive a summary after a person clicks Run or Rerun on the Lightning card.

It does not publish when the card checks a record automatically as the page opens or after a save. It also does not control Flow, Apex, Batch, Queueable, or Scheduled Apex runs, which choose NONE, ACTIONABLE, or ALL when they start. Agentforce actions and the REST endpoint never publish.

Leave it cleared when nothing receives the event. Publication uses your org’s Platform Event allocation. See Record Health Check Set Run Platform Event.

Publish Error Log Event (PublishErrorLogEvent__c)

Section titled “Publish Error Log Event (PublishErrorLogEvent__c)”
AttributeValue
TypeCheckbox
DefaultCleared (false)

Select this field only when restricted administrator or support automation needs technical Record Health Check errors for this Check Set. Assign Record Health Check Error Log Publisher to each running identity first. Leaving it cleared does not turn off Salesforce debug logs.

When Record Health Check cannot identify the Check Set, it publishes nothing. Every Unable to Check and System Error result can publish one Log event, so estimate the volume first. See Record Health Check Log Platform Event before granting access or saving these restricted details.

This Account Check Set waits for a user to request a check, shows all result rows, and does not publish a Set Run Platform Event unless Flow or Apex separately requests publication.

FieldExample value
LabelAccount readiness
Developer NameAccount_Readiness
ObjectAccount
ActiveSelected
Card TitleAccount readiness
Card SubtitleReview before the weekly pipeline meeting.
When Checks RunWhen the user clicks Run
Reveal ModeOne by one
Run Button DisplayShow label and icon
Found/Expected DisplayShow on demand
Passed ChecksShow each passed check
Skipped ChecksShow each skipped check
Summary DisplayShow below checks
Stop after a system errorCleared
Show DiagnosticsCleared
Publish User Run EventCleared
Publish Error Log EventCleared

Flow and Apex identify this Check Set by its Qualified API Name, Account_Readiness; see Names and API identities.