Find your way around the configuration forms
Learn which sections of the Record Health Check Setup forms to complete and which to leave at their defaults. Record Health Check stores its configuration in two Custom Metadata Types, and each has a Setup form with numbered sections in the order you fill them in.
To open the forms, go to Setup → Custom Metadata Types, select Manage Records next to Record Health Check Set or Record Health Check, and select New or Edit.
Record Health Check Set form
Section titled “Record Health Check Set form”A Check Set defines one card for one object.
| Section | Fields | What to do |
|---|---|---|
| 1. Name the review and choose its object | Label, Object, Record Health Check Set Name, Active | Required. Enter the object’s API name, such as Account. Leave Active cleared until the configuration is validated. |
| 2. Describe the card to users | Card Heading Display, Card Title, Card Subtitle | Card Title is required, even when the heading is hidden. Keep Show title and subtitle for a first card. |
| 3. Choose how users start the review | When Checks Run, Run Button Display | Choose whether Checks run when the page opens or when the user selects Run. A card that waits for Run must show the button and the heading. |
| 4. Customize the Run button (optional) | Run Button Label, Run Button Icon, Rerun Button Label | Leave blank to show Run, Rerun, and the play icon. |
| 5. Choose how results appear | Reveal Mode, Passed Checks, Found/Expected Display, Summary Display, Skipped Checks | The defaults work for most cards. These settings change what the card shows, never the results. |
| 6. Advanced settings and troubleshooting | Stop after a system error, Publish User Run Event, Show Diagnostics, Publish Error Log Event | Leave cleared unless you need to stop a run after a system error, publish events, or troubleshoot. |
| Package information | Protected Component, Namespace Prefix | Read-only. A Check Set your organization creates has no namespace prefix. |
The Check Set field reference describes every field.
Record Health Check form
Section titled “Record Health Check form”A Check defines one requirement on a card. The form has numbered sections that every Check uses, and unnumbered rule sections for each Evaluation Type.
Section 1: Name and organize the Check
Section titled “Section 1: Name and organize the Check”Enter Label, Check Set, Evaluation Type, Record Health Check Name, and Evaluation Order. Leave Active cleared until the configuration is validated. Evaluation Order sets the order on the card, from lowest to highest.
Rule sections for the Evaluation Type
Section titled “Rule sections for the Evaluation Type”Salesforce shows every rule section on the form, whatever Evaluation Type you choose. Complete only the sections for your Evaluation Type, and leave the others blank.
| Evaluation Type | Complete these sections |
|---|---|
| Verify with a formula | Formula rule - Verify with a formula: enter a Pass Condition that returns true or false. |
| Verify with a query | The three Query sections. In Query - Compare with the expected value, choose Expected Value Comes From, then fill only the matching field. |
| Compare two queries | The three Query sections, including Source Query and Comparison Query. Leave Expected Value Comes From blank. |
| Verify with Apex | Apex rule - Verify with Apex: enter the Apex Class and, if the class accepts them, Apex Parameters (JSON). |
For a query Check, work through the three Query sections in order:
- Query - Find and read records (both query types). Enter Source Query, the Source Query
Field to read, and How To Read Query Results. Leave Source Query Field blank for a bare
COUNT()query. Use Value to find in the list (formula) only with the List contains any and List contains none operators. - Query - Compare with the expected value. Choose Comparison Operator first. Is empty and Is not empty need no expected value. For other operators on Verify with a query, choose Expected Value Comes From and fill only its field: Expected Value (Fixed), Expected Value (Formula), or Comparison Query. Expected Currency ISO Code is required only for a fixed value compared with a Currency field.
- Query - Decide what empty results mean. If Query Finds No Records decides the result when the query returns nothing, and If Field Value Is Empty decides how a blank field is compared. Both can change a result from Pass to Fail, so choose them deliberately.
The Query reference explains each choice.
Sections 2 to 7
Section titled “Sections 2 to 7”| Section | What to do |
|---|---|
| 2. Explain the result to users | Check Title and Message When Failed are required. Check Description appears when a user hovers over the title. Message When Unable To Evaluate should say the Check could not run, not that the record failed. |
| 3. Group and prioritize results | Failure Severity is required: Critical shows Failed, Warning shows Warning, and Info shows Info. Category is optional and groups the summary counts. |
| 4. Add a fix link (optional) | Enter Action URL, and optionally Action Label, only when a page helps the user fix the record. See Add a fix link. |
| 5. Limit when this Check applies (optional) | Keep Applies To set to All records unless the Check applies only to some records. Then complete only the fields for the choice you make. |
| 6. Customize Found and Expected (optional) | Leave blank at first. The Found and Expected reference explains how the overrides combine. |
| 7. Advanced settings | Keep Formula Result Type at Automatic, Max Query Rows (1-2000) at 200, and Publish User Result Event cleared unless you need a change. |
The Check field reference describes every field.