Step-by-step guide
Go from no installation to a working Record Health Check card on a Salesforce record page. Record Health Check is an open-source package that shows whether a record meets configured requirements without changing the record. Complete each step in a sandbox, and continue only when you see the result in the Done when column.
Get to a first working Check
Section titled “Get to a first working Check”- 01Learn what Record Health Check doesYou can explain the difference between a Check Set and a Check
- 02Install Record Health Check in a sandboxA user with Record Health Check Card User can run an installed example card
- 03Explore the installed examplesYou have run one example Check Set on an Account, Contact, or Opportunity
- 04Create your first CheckYour own Check shows both Pass and a failed result
- 05Add the card to a Lightning record pageThe users who need the card see it on the page their app and profile use
- 06Configure a complete Check SetEvery Check is tested with records and users that represent real use
Test with a user who has the same access as the people who will use the card, not only as a System Administrator. Record Health Check reads data with the running user’s access, so an administrator can see a result that another user cannot. The card needs Record Health Check Card User; Flow, Apex, and agent callers need Record Health Check User. Every user also needs access to the records and fields that the Checks read.
Continue with the next task
Section titled “Continue with the next task”Build more Checks
Section titled “Build more Checks”- Choose an Evaluation Type and copy a similar example.
- Add a fix link when users need to go somewhere to fix the record.
- Look up what each result label means.
Run Checks from a Flow
Section titled “Run Checks from a Flow”- Confirm that the Check Set works on the card first.
- Run a Check or Check Set from Flow.
- Branch on the action’s Success output to handle request errors, and on its Status output
for the health result. A
FAILstatus is a business result, not a Flow fault. - Set Event Publication to
NONEunless another process must receive the result.
Keep results or notify another process
Section titled “Keep results or notify another process”- Decide whether you need Platform Events.
- Save Check Set run summaries when counts per record are enough.
- Save events to an object your organization owns when you need lasting history.
- Test what your subscriber does with a duplicate event and with a failure before you activate it.
Prepare for production
Section titled “Prepare for production”- Back up the configuration.
- Review security and data access.
- Follow the production operations guide.
- Keep the troubleshooting guide available to the people who support the card.
Extend with code or agents
Section titled “Extend with code or agents”The developer guides cover Apex, background jobs, Agentforce, the MCP server, and Pub/Sub API subscribers.
Resolve a problem
Section titled “Resolve a problem”| What you see | Where to look |
|---|---|
| The card is missing or shows the wrong Check Set | Configure the component |
| A result is not what you expected | Troubleshoot with the browser console |
| A status or reason code is unclear | Reason codes |
| A Flow does not branch as expected | Flow action inputs and outputs |
| A Flow that should receive an event receives nothing | Save or send results after a run |