Skip to content
Suggest a correction

See Record Health Check in action

Getting started3 min read

The Record Health Check card sits on a Salesforce Lightning record page and lists the results of read-only Checks for the open record. Learn how to read each part of the card before you configure one.

Record Health Check card on an Account record page. Three Checks passed, two failed, one shows a warning, one shows Info, and one was skipped. Failed rows show a message, a fix link, fix instructions, and Found and Expected values. A summary bar at the bottom counts each result.

The image shows the Example: Account Relationship & Risk Check Set that installs with the package, run on a sample Account. It was captured before release 2.0.11, so one message reads differently on your card: in 2.0.11 the No high-priority customer issues message is “Acme Corporation has 4 open high-priority cases requiring immediate attention.” Messages and values on your own cards come from your Check configuration and data.

PartWhat it shows
Title and subtitleThe name of the review and what it covers. The Check Set’s Card Title and Card Subtitle fields set them.
Run or Rerun buttonStarts the Checks, or runs them again with the current record data and configuration. The Check Set controls the button label, icon, and whether it appears.
Check rowOne Check’s title and its result icon. Hover over or focus the title to see the Check’s description, when one is configured.
MessageWhy the result matters. It appears for every result except Pass.
Action linkAn optional link to the page where the user can fix the problem, such as the record’s edit page or a related list. The link only navigates; it never changes data.
Fix instructionsWhat to do next, written by the administrator.
Found and ExpectedThe value the Check read and the value the requirement calls for. With the default display setting, Failed, Warning, and Info rows show them, and on a passing row you select the arrow next to the title to show them.
SummaryA count of each result, such as 3 Passed and 2 Failed. When Checks have a Category, the card shows one group of counts per category, and you can hover over or focus a count to see the names of those Checks.
Card labelMeaning
PassThe record meets the requirement.
FailedThe record does not meet a requirement whose Failure Severity is Critical.
WarningThe record does not meet a requirement whose Failure Severity is Warning.
InfoThe record does not meet a requirement whose Failure Severity is Info.
SkippedThe Check does not apply to this record, or a prerequisite Check did not pass. The message explains which.
Unable to CheckAccess, configuration, or missing data prevented a reliable answer.
System ErrorAn unexpected technical failure stopped the Check.

Failed, Warning, and Info are the same result, FAIL, shown at three levels of importance. Flow, Apex, and Platform Events report the result as FAIL and the importance as CRITICAL, WARNING, or INFO.

The card reads data with the current user’s Salesforce access. If a user cannot read a field or a related record that a Check needs, the card shows Unable to Check for that user instead of guessing.

The Check Set controls the whole card: its object, title, subtitle, whether the Checks run when the page opens or when the user selects Run, the summary position, whether passed and skipped Checks are listed, and when Found and Expected appear.

Each Check controls one row: the requirement, its title and description, its severity, the messages for each result, the Found and Expected text, and the optional action link.

Neither one changes the record or blocks a save. A user can save a record whose Checks fail.