Skip to content

Reference

33 guides

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.

FolderWhat you can find there
Feature catalogEvery shipped capability, its supported behavior, and the detailed guide that owns it
Public contractComplete plugin, evidence, display, diagnostics, preview, readiness, limit, and compatibility contract
Source inventoryPackage contents generated directly from metadata and Apex source
Permission SetsThe seven installed access bundles and the ways they authorize runs, diagnostics, events, and readiness review
Custom PermissionsThe Run Custom Permission and the separate Permission Set assignment used for diagnostics authorization
ConfigurationNames, display formatting, and field limits
Merge syntaxToken namespaces, properties, fallbacks, and SOQL usage
EvaluationExact Formula, Query, Compare Two Queries, and bulk-query behavior
Custom MetadataCheck Set and Check configuration field dictionaries
Platform Event metadataFields published by the three Record Health Check Platform Events
ResultsCard labels, API statuses, and Reason Codes
PlatformCompatibility, localization, limitations, and Salesforce-specific edge cases
ContractsVersioned integration boundaries

Use the glossary when a Record Health Check or Salesforce term is unfamiliar.

I need to know…Reference
What the package supportsComplete feature catalog
What the public contract guaranteesPublic contract
Which field to use in SetupCustom Metadata
Which Permission Set to assignPermission Sets
What a readiness receipt stores and who can read itReadiness receipts
What the Run Custom Permission controls, and how diagnostics access worksCustom Permissions
Which fields a Platform Event publishesPlatform Event metadata
Why a result says FAIL, ERROR, or UNABLE_TO_EVALUATEResult statuses and card labels
What a Reason Code meansReason Codes
Which merge tokens are supportedMerge tokens
How Formula or Query evaluation behavesEvaluation reference
How the framework is assembledFramework architecture
Which package Apex class owns a responsibilityPackage Apex implementation reference