What Record Health Check does
Record Health Check is an open-source Salesforce package that adds a configurable card to Lightning record pages. The card runs read-only Checks against the open record and shows whether the record meets each requirement, what was found, what was expected, and how to fix it.
The card is guidance, not enforcement. Running a Check never changes the record and never prevents a save. Administrators define the requirements in Salesforce Setup as Custom Metadata, so no code is needed for most Checks.
How a Check Set and a Check fit together
Section titled “How a Check Set and a Check fit together”| Term | What it is |
|---|---|
| Check Set | One card. A Check Set names the object it runs on, such as Account, and controls the card title, when the Checks run, and how results are displayed. It is a Record Health Check Set record. |
| Check | One requirement on the card, such as “Account owner is active.” A Check decides what to examine, when it applies, and what message to show. It is a Record Health Check record. |
Both are Custom Metadata records, so they move between orgs with change sets, packages, or the Salesforce CLI, like other Setup configuration. A Check Set can contain up to 25 active Checks.
To show a card, an administrator adds the Record Health Check component to a Lightning record page in Lightning App Builder and selects a Check Set for that object.
Example: an Account before a customer review
Section titled “Example: an Account before a customer review”The package installs an example Check Set named Example: Account Relationship & Risk. On an Account record, its card answers questions such as these:
- Is the Account owner an active user?
- Does an Opportunity on the Account have a reachable Executive Sponsor contact?
- Do the Account’s Contacts have email addresses?
- Has customer activity been logged in the last 60 days?
- Are high-priority Cases still open?
Each answer comes from a different source. The owner’s status is a field on a related User record, the Contact Roles, Contacts, and Cases are related records, and recent activity is calculated by an Apex class included with the package. The card presents all of them the same way, so a user reading the card does not need to know where each answer came from.
What each result means
Section titled “What each result means”| Card label | Result in Flow and Apex | Meaning |
|---|---|---|
| Pass | PASS | The record meets the requirement. |
| Failed, Warning, or Info | FAIL | The record does not meet the requirement. The Check’s Failure Severity (Critical, Warning, or Info) decides which label appears. |
| Skipped | SKIPPED | The Check does not apply to this record, or a prerequisite Check did not pass. |
| Unable to Check | UNABLE_ | Access, configuration, or missing data prevented a reliable answer. |
| System Error | ERROR | An unexpected technical failure stopped the Check. |
A Check that does not apply is never counted as a pass, and a Check that could not run is never
counted as a business failure. FAIL means the record needs attention; it does not mean that
Salesforce or Record Health Check failed.
Record Health Check reads data with the running user’s record and field access. Two users can see different results on the same record when their access differs.
Where a Check finds its answer
Section titled “Where a Check finds its answer”Each Check uses one Evaluation Type. Choose the simplest type that can answer the question.
| The answer depends on | Evaluation Type |
|---|---|
| Fields on the open record or on a parent record, such as the owner | Verify with a formula |
| Related records, such as Contacts, Opportunities, Cases, or Tasks | Verify with a query |
| Two separately calculated values or lists that must agree | Compare two queries |
| Logic that a formula or a query cannot express, written in an Apex class | Verify with Apex |
What the user sees when a record needs attention
Section titled “What the user sees when a record needs attention”A failed Check can show:
- a message that explains why the result matters;
- Found, the value the Check read from the record;
- Expected, the value the requirement calls for;
- fix instructions; and
- an optional link to the page where the user can make the change.
The link only navigates. The user decides whether to change the record.
When to use a different Salesforce tool
Section titled “When to use a different Salesforce tool”Use Record Health Check when people should see guidance while they work and keep control of the next step. Use a Validation Rule, a required field, a Flow, or an Apex trigger when Salesforce must prevent or perform an action. For example, if an Opportunity must never close without an Amount, enforce it with a Validation Rule. If a record should be reviewed for relationship gaps before a quarterly business review, use a Check.
Access the package requires
Section titled “Access the package requires”Record Health Check access comes from packaged Permission Sets. Assign them in Setup → Permission Sets → [Permission Set] → Manage Assignments.
| Permission Set | Grants |
|---|---|
| Record Health Check Card User | Running the record-page card. It does not include Flow, Apex, Agentforce, or REST entry points. |
| Record Health Check User | Running Checks from the card, Flow, Apex, Queueable, Batch, Scheduled Apex, Agentforce, and the REST resource. |
| Record Health Check Admin | Configuring and validating Check Sets, previewing draft Checks, and viewing diagnostic details. |
| Record Health Check Diagnostics Viewer | Viewing diagnostic details, when added to a user who already has Card User or User. Assign it only while troubleshooting. |
None of these Permission Sets grants access to Accounts, Contacts, Opportunities, Cases, or any other business data. Users still need the normal Salesforce access to the records and fields a Check reads. Creating Check Sets and Checks in Setup also requires the Salesforce Customize Application permission.
First troubleshooting steps
Section titled “First troubleshooting steps”- The card does not appear: Confirm that the Lightning page you edited is the page assigned to the user’s app, record type, and profile. Saving a page that the user is not assigned changes nothing they see.
- The card says no Check Set is available: Confirm that the Check Set is active and that its
Object value exactly matches the record page’s object, such as
Account. - A Check shows Unable to Check: Confirm that the user can read every field and related record the Check uses.