Check Set fields
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 value | Name |
|---|---|
| Custom Metadata Type label | Record Health Check Set |
| Custom Metadata Type API name | Record_ |
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.
Choose the fields you need
Section titled “Choose the fields you need”| What you want to configure | Fields |
|---|---|
| Name the Check Set and choose its Salesforce object | Label and Developer Name, Object, Active |
| Choose when the card runs | When Checks Run, Stop after a system error |
| Choose how the card looks | Card Title, Card Subtitle, Reveal Mode, Run button fields |
| Choose which result details appear | Found/Expected Display, Passed Checks, Skipped Checks, Summary Display |
| Troubleshoot a Check Set | Show Diagnostics |
| Publish Platform Events | Publish User Run Event, Publish Error Log Event |
Identity and Salesforce object
Section titled “Identity and Salesforce object”Label and Developer Name
Section titled “Label and Developer Name”| Setup label | API name | Required | Limit | Example |
|---|---|---|---|---|
| Label | MasterLabel | Yes | 40 characters | Account readiness |
| Developer Name | DeveloperName | Yes | 40 characters | Account_ |
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.
Object (ObjectApiName__c )
Section titled “Object (ObjectApiName__c)”| Attribute | Value |
|---|---|
| Type | Text(80), required |
| Default | None |
| Example | Account, Opportunity, or My_ |
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.
Active (IsActive__c )
Section titled “Active (IsActive__c)”| Attribute | Value |
|---|---|
| Type | Checkbox |
| Default | Selected (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.
Card text and display
Section titled “Card text and display”Card Title (CardTitle__c )
Section titled “Card Title (CardTitle__c)”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.
Card Subtitle (CardSubtitle__c )
Section titled “Card Subtitle (CardSubtitle__c)”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 (CardRevealMode__c )
Section titled “Reveal Mode (CardRevealMode__c)”Reveal Mode changes how Check rows appear. It does not change which Checks run, their order, or their results.
| Setup choice | Stored value | What the user sees |
|---|---|---|
| All at once | ALL_ | All applicable Checks appear first as pending; results fill in as the Checks finish. |
| One by one | ONE_ | A 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 choice | Stored value | What the user sees |
|---|---|---|
| Show on demand | ON_ | Users can expand a Check to see the values; failed Checks also show them inline. This is the default. |
| Show for failed checks | FAILURES_ | Values appear only for failed Checks. |
| Show for every check | ALL_ | Values 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.
Passed Checks (PassedChecksDisplay__c )
Section titled “Passed Checks (PassedChecksDisplay__c)”| Setup choice | Stored value | What the user sees |
|---|---|---|
| Show each passed check | SHOW_ | Every passed Check remains in the list. This is the default. |
| Show passed count only | SHOW_ | Passed rows are hidden, but their total remains in the card summary. |
Skipped Checks (SkippedChecksDisplay__c )
Section titled “Skipped Checks (SkippedChecksDisplay__c)”| Setup choice | Stored value | What the user sees |
|---|---|---|
| Show each skipped check | SHOW_ | Every skipped Check remains in the list. This is the default. |
| Show skipped count only | SHOW_ | Skipped 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.
Summary Display (SummaryDisplay__c )
Section titled “Summary Display (SummaryDisplay__c)”| Setup choice | Stored value | What the user sees |
|---|---|---|
| Show above checks | TOP | The result summary appears above the Check rows. |
| Show below checks | BOTTOM | The result summary appears below the Check rows. This is the default. |
| Hide | HIDE | No 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.
When Checks run
Section titled “When Checks run”When Checks Run (CardRunMode__c )
Section titled “When Checks Run (CardRunMode__c)”| Setup choice | Stored value | Behavior |
|---|---|---|
| When the page opens | RUN_ | The card checks the record automatically. Afterward, it shows Rerun unless Run Button Display or Card Heading Display is Hide. |
| When the user clicks Run | RUN_ | The 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)”| Attribute | Value |
|---|---|
| Type | Checkbox |
| Default | Cleared (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.
Run button fields
Section titled “Run button fields”These fields control the Run and Rerun action in the Lightning card header.
Run Button Display (RunButtonDisplay__c )
Section titled “Run Button Display (RunButtonDisplay__c)”| Setup choice | Stored value | What the user sees |
|---|---|---|
| Show label and icon | LABEL_ (default) | A button with the icon and the Run or Rerun label |
| Show label only | LABEL_ | A button with the label and no icon |
| Show icon only | ICON_ | An icon button. The label is not shown but remains the button’s name for screen readers |
| Hide | HIDE | No 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.
Run Button Label (RunButtonLabel__c )
Section titled “Run Button Label (RunButtonLabel__c)”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.
Rerun Button Label (RerunButtonLabel__c )
Section titled “Rerun Button Label (RerunButtonLabel__c)”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.
Run Button Icon (RunButtonIcon__c )
Section titled “Run Button Icon (RunButtonIcon__c)”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.
Troubleshooting
Section titled “Troubleshooting”Show Diagnostics (ShowDiagnostics__c )
Section titled “Show Diagnostics (ShowDiagnostics__c)”| Attribute | Value |
|---|---|
| Type | Checkbox |
| Default | Cleared (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:
- Show Diagnostics is selected on the Check Set.
- 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.
Platform Events
Section titled “Platform Events”Publish User Run Event (PublishUserRunEvent__c )
Section titled “Publish User Run Event (PublishUserRunEvent__c)”| Attribute | Value |
|---|---|
| Type | Checkbox |
| Default | Cleared (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)”| Attribute | Value |
|---|---|
| Type | Checkbox |
| Default | Cleared (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.
Quick configuration example
Section titled “Quick configuration example”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.
| Field | Example value |
|---|---|
| Label | Account readiness |
| Developer Name | Account_ |
| Object | Account |
| Active | Selected |
| Card Title | Account readiness |
| Card Subtitle | Review before the weekly pipeline meeting. |
| When Checks Run | When the user clicks Run |
| Reveal Mode | One by one |
| Run Button Display | Show label and icon |
| Found/Expected Display | Show on demand |
| Passed Checks | Show each passed check |
| Skipped Checks | Show each skipped check |
| Summary Display | Show below checks |
| Stop after a system error | Cleared |
| Show Diagnostics | Cleared |
| Publish User Run Event | Cleared |
| Publish Error Log Event | Cleared |
Flow and Apex identify this Check Set by its Qualified API Name, Account_Readiness; see
Names and API identities.