Reference
Look up the exact details of Record Health Check 2.0.11: every Setup field, merge token, status, Reason Code, Platform Event field, permission set, limit, and versioned contract. Record Health Check is the open-source Salesforce package that shows on a Lightning record page whether a record meets requirements an administrator configures. For step-by-step instructions, start with Start here or Build Checks.
Choose a reference area
Section titled “Choose a reference area”| Folder | What you can find there |
|---|---|
| Feature catalog | Every shipped capability, its supported behavior, and the detailed guide that owns it |
| Public contract | Complete plugin, evidence, display, diagnostics, preview, readiness, limit, and compatibility contract |
| Source inventory | Package contents generated directly from metadata and Apex source |
| Permission Sets | The seven installed access bundles and the ways they authorize runs, diagnostics, events, and readiness review |
| Custom Permissions | The Run Custom Permission and the separate Permission Set assignment used for diagnostics authorization |
| Configuration | Names, display formatting, and field limits |
| Merge syntax | Token namespaces, properties, fallbacks, and SOQL usage |
| Evaluation | Exact Formula, Query, Compare Two Queries, and bulk-query behavior |
| Custom Metadata | Check Set and Check configuration field dictionaries |
| Platform Event metadata | Fields published by the three Record Health Check Platform Events |
| Results | Card labels, API statuses, and Reason Codes |
| Platform | Compatibility, localization, limitations, and Salesforce-specific edge cases |
| Contracts | Versioned integration boundaries |
Use the glossary when a Record Health Check or Salesforce term is unfamiliar.
Common lookups
Section titled “Common lookups”| I need to know… | Reference |
|---|---|
| What the package supports | Complete feature catalog |
| What the public contract guarantees | Public contract |
| Which field to use in Setup | Custom Metadata |
| Which Permission Set to assign | Permission Sets |
| What a readiness receipt stores and who can read it | Readiness receipts |
| What the Run Custom Permission controls, and how diagnostics access works | Custom Permissions |
| Which fields a Platform Event publishes | Platform Event metadata |
Why a result says FAIL, ERROR, or UNABLE_ | Result statuses and card labels |
| What a Reason Code means | Reason Codes |
| Which merge tokens are supported | Merge tokens |
| How Formula or Query evaluation behaves | Evaluation reference |
| How the framework is assembled | Framework architecture |
| Which package Apex class owns a responsibility | Package Apex implementation reference |