Record Health Check

Make informed decisions before taking action on Salesforce data.

Think of Record Health Check as a coach sitting on the record page. It checks the record against rules your organization defines, explains what looks good and what needs attention, and tells users what they can do next.

It provides guidance, not enforcement. It never changes your data and never prevents someone from saving a record.

Free and open source. Distributed as a namespaced Salesforce 2GP unlocked package.

How it works

Check Sets and Checks are defined in Custom Metadata. When the card runs, Record Health Check combines the record context with the business rules your organization defines to evaluate what is true now. That context can include the current record, related records, aggregate results, and data that existed before the Checks were created. It does all of this without writing to the record.

Every Check returns Pass, Fail, Skipped, Unable to Check, or System Error. For a Fail result, the row is labeled Failed, Warning, or Info based on its severity.

When a record needs attention, the card explains what was Found, what was Expected, why it matters, and how to resolve it. It can also provide an optional read-only action link.

Get started

Documentation · Install and verify in your org · Deploy to a demo scratch org · Examples

See it in action

Example: Account Relationship & Risk Health Check An account team can review relationship strength, ownership, engagement, revenue coverage, and customer risk without leaving the record page. Review the whole relationship. Checks evaluate the Account together with Opportunity Contact Roles, Contacts, Opportunities, Cases, Activities, ownership, and parent-account context. Understand why. Found and Expected values explain results such as three reachable Executive Sponsors, six contacts missing email, four high-priority Cases, and a dynamically calculated 75% revenue-coverage target. Know what to do next. Remediation guidance directs the account team toward the ownership, relationship, pipeline, or service action that closes the gap. Administrators control the experience Each check shown on the card is a Check in the selected Check Set. Custom Metadata defines what each Check evaluates, when it applies, and whether the card runs when the page opens or when the user selects Run. The same component can be configured for any Salesforce object with a record page.

What this demo shows

• Formula Checks evaluate fields on the current Account, such as whether the owner is still an active user.
• Query Checks measure related records and aggregates. Found and Expected values explain results such as reachable Executive Sponsors, contacts missing email, open pipeline against a 75% revenue target, and high-priority Cases.
• Custom Apex evaluates recent Tasks and Events within a configurable 60-day window to confirm customer engagement is current.
• Applicability conditions skip Checks that do not apply to this Account. Channel-partner governance is skipped for a direct Customer, and the card explains why.

Framework capabilities

Capability	What it provides
Custom Metadata configuration	Version, review, and deploy Check Sets and Checks with the rest of your Salesforce metadata
Evaluation methods	Evaluate current-record fields, related records, aggregate results, comparisons, or custom Apex logic
Applicability conditions	Skip Checks that do not apply and explain why, such as a partner-only Check on a customer Account
Display and run controls	Run Checks when the card loads or on demand, and control how passed and skipped Checks appear
Automation and diagnostics	Use Apex and Flow entry points, optional Platform Events, and permission-controlled diagnostics for automation, integration, and troubleshooting

What's included

This inventory describes the current source checkout. See version availability for differences from the published package.

Area	Details
Package	Salesforce 2GP unlocked package with the rhc namespace
Apex	224 classes, including 114 @IsTest classes and 1 global contract-test support class · size breakdown · 99.64% namespaced package coverage · 99.57% subscriber-style coverage
LWC	1 Lightning Web Component · 258 Jest tests · 98.59% line coverage · 91.94% branch coverage
Packaged examples	4 active Example Check Set records containing 50 Check records; 49 Checks are active
Permission sets	Card User, User, Admin, MCP Integration, Diagnostics Viewer, and Error Log Publisher
Custom permissions	Record Health Check Run and Record Health Check View Diagnostics
Custom Metadata Types	Record Health Check Set (18 fields) and Record Health Check (44 fields)
Platform Events	Record Health Check Log (14 fields), Record Health Check Result (13 fields), and Record Health Check Set Run (18 fields)
Documentation	135 maintained pages, including 19 documented Check examples

Contributing

See the contribution guide for local checks, testing requirements, and pull request guidance.

Questions and feedback

Questions and feedback can be shared in a GitHub discussion. To report a bug or request a feature, open an issue. You can also join the community on Slack. Already a member? Open Slack. Prefer email? Reach out at feedback@recordhealthcheck.com.

License

Licensed under the Apache License, Version 2.0. See NOTICE for attribution.