Step-by-step guide

Follow this sequence from installation to a working Check. Complete each step in a sandbox and move on after confirming the expected result.

First working Check

Step	Do this	Stop when…
1	Understand what the framework does	You can explain the difference between a Check Set and a Check
2	Install and verify it in a sandbox	A normal user can see the Record Health Check card
3	Explore the installed examples	One installed Check Set runs on a record page
4	Create your first Check	Your own Check shows both a passing and an attention state
5	Add and activate the card	The intended app users can open and run it
6	Configure a complete Check Set	Every Check has been tested with representative users and records

Do not test only as a System Administrator. A card-only tester needs Record Health Check Card User; an automation user needs the permission set for the way it runs checks. Every runner also needs access to the records and fields the Check reads.

Choose your next path

Build more Checks

1. Choose the Evaluation Type.
2. Copy the closest Formula, Query, Compare Two Queries, or Apex example.
3. Add a safe fix link when users need a next action.
4. Understand result labels and statuses.

Run from Flow

1. Prove the Check Set on the card first.
2. Run it from Flow.
3. Use Success for request handling and Status for the health decision. FAIL is not a Flow fault.
4. Leave event publication as NONE unless a separate process must receive the result.

Save history or notify another process

1. Decide whether you need Platform Events.
2. Start with Check Set run summaries when counts are enough.
3. Save events to an organization-owned object if you need lasting history.
4. Test duplicate delivery and failure handling before activation.

Go to production

1. Back up the configuration.
2. Review security and data access.
3. Follow the production operations checklist.
4. Keep troubleshooting available to support owners.

Extend with code or agents

Start in Developer guides. Administrators can skip that folder unless they are handing an Apex, background-job, Agentforce, MCP, or external event task to a developer.

Resolve a problem

What you see	Start here
The card is missing or has the wrong Check Set	Add the card to a record page
A result is unexpected	Troubleshoot Record Health Check
A status or Reason Code is unclear	Look up exact behavior
Flow does not branch as expected	Flow action inputs and outputs
A receiving Flow gets no event	Save or send results after a run

Related

• Documentation home
• Start here