Skip to content

Readiness receipts

Reference6 min read

Keep private evidence that one exact Check draft was validated or previewed against a specific group of records, for example as part of a release review, with a Record Health Check readiness receipt. A receipt is evidence, not approval, saved Check configuration, or result history.

The package stores receipts in the private Record Health Check Readiness object (Record_Health_Check_Readiness__c). The Preview service creates them only when an administrator explicitly requests one after a valid Preview. Administrators do not create or edit these records directly.

A receipt is saved only when it is requested and the Preview validates the draft as VALID.

Where you run PreviewHow to request a receipt
Record Health Check Preview componentSelect Save a readiness receipt after a successful Preview, then select Validate or Preview. See Validate and preview an AI draft
Apex, as a user with Record Health Check AdminBuild the request with rhc.RecordHealthCheckPreviewRequest.forDraftCheck(draft, qualifiedSetName, recordIds), add .withMode('VALIDATE_ONLY') or .withMode('EXECUTE') and .withReadinessReceipt(true), then call rhc.RecordHealthCheckPreviewService.preview(request)

The two Preview modes produce different evidence:

Preview ModeWhat it proves
VALIDATE_ONLYThe draft’s configuration is valid and its fields can be planned. No record is evaluated, so every outcome count is 0, and an Apex draft’s plugin is not loaded
EXECUTEEverything VALIDATE_ONLY proves, plus the draft’s outcome on each record in the scope, with Platform Event publication turned off

The response’s readinessReceipt.receiptStatus reports what happened:

receiptStatusMeaning
SAVEDA receipt was saved. receiptId and expiresAt identify it
NOT_REQUESTEDThe request did not ask for a receipt
NOT_ELIGIBLEValidation did not return VALID, so no receipt was saved. Correct the findings and run Preview again
NOT_SAVEDThe Preview completed, but the receipt could not be saved. warning explains this; the Preview result stands

Capabilities JSON stores the same capability map the Preview response returns. It records which parts of the draft the Preview actually proved, such as configuration and field planning, and which it could not prove, such as an Apex plugin’s schema in VALIDATE_ONLY mode.

A current receipt binds these facts together:

  • the user and Salesforce org that ran the Preview;
  • the exact Check draft and saved Check Set;
  • the Preview mode and completed capabilities;
  • a one-way digest of the sorted record IDs, not the record IDs themselves;
  • the number of records tested and the outcome counts; and
  • the verification time and 30-day expiration time.

Changing the draft or record list makes an earlier receipt noncurrent. A receipt never proves that another user has the same record or field access, and it never activates the Check.

The Record Health Check Preview component shows Readiness: with one of four states after each Preview. The state is computed from your current, unexpired receipts for the exact draft:

StateMeaning
ACTIVEThe saved Check is already active. Receipts are not consulted.
LIVE_VERIFIEDA current Execute receipt shows the draft ran with no ERROR or UNABLE_TO_EVALUATE results, at least one PASS or FAIL, and every recorded capability COMPLETE.
VALIDATEDA current receipt exists for this draft, user and org, but none meets the LIVE_VERIFIED conditions, for example a Validate only receipt.
DRAFTNo current receipt matches: the draft changed, the receipt expired or belongs to another user or org, or run access could not be confirmed.

A receipt counts as current only when its fingerprint matches the draft, it was created by you in this org, and its expiration time has not passed. The state is information for the person reviewing the draft; it does not activate the Check or grant access.

NeedPermission Set
Run Preview and request or clean up receiptsRecord Health Check Admin; this also includes Run authorization
Read saved receipts without running PreviewRecord Health Check Readiness Auditor
Run ordinary ChecksUse Card User, User, Admin, or MCP Integration for the applicable entry point

Readiness Auditor grants read-only access to the readiness object and its fields. It does not grant Run, Preview, cleanup, diagnostics, Custom Metadata, or business-record access.

Salesforce labelAPI nameTypeMeaning
ActorActor__cLookup(User)User who ran the qualifying Preview
Capabilities JSONCapabilitiesJson__cLong Text AreaBounded capability results recorded by Preview
Check IdentityCheckIdentity__cText(255)Exact Check identity used by the draft
Contract VersionContractVersion__cText(10)Receipt contract version
Error CountErrorCount__cNumber(3,0)Draft results with ERROR
Expires AtExpiresAt__cDate/TimeTime after which the receipt is no longer current
Fail CountFailCount__cNumber(3,0)Draft results with FAIL
FingerprintFingerprint__cText(64)SHA-256 identity of the effective draft definition
Preview ModeMode__cPicklistValidate only (VALIDATE_ONLY): the draft was checked without running it. Execute (EXECUTE): the draft was also run against the Preview records. Only an Execute receipt can produce the LIVE_VERIFIED readiness state
Org IdentityOrgIdentity__cText(18)Salesforce org bound to the receipt
Pass CountPassCount__cNumber(3,0)Draft results with PASS
Scope CountScopeCount__cNumber(3,0)Number of representative records in the Preview
Scope DigestScopeDigest__cText(64)SHA-256 digest of the normalized record-ID list
Check Set IdentitySetIdentity__cText(255)Saved Check Set used to own the Preview context
Skipped CountSkippedCount__cNumber(3,0)Draft results with SKIPPED
Unable CountUnableCount__cNumber(3,0)Draft results with UNABLE_TO_EVALUATE
Verified AtVerifiedAt__cDate/TimeTime the qualifying Preview completed

The object also has the Salesforce-generated Readiness Receipt Number auto-number field. It is private, reportable, and protected from direct updates by a validation rule.

  1. Open the receipts. The package installs no tab or report type for them, so create a custom report type on Record Health Check Readiness, or query rhc__Record_Health_Check_Readiness__c with SOQL, as a user with Record Health Check Readiness Auditor or Record Health Check Admin.
  2. Match the Check, Check Set, actor, verification time, expiration, and outcome counts to the release evidence under review.
  3. Treat an expired receipt or a changed draft/scope as stale evidence.
  4. Run Preview again when current evidence is required.

To delete expired receipts, a user with Record Health Check Admin can run rhc.RecordHealthCheckPreviewService.deleteExpiredReadinessReceipts(true) in Apex, for example in Anonymous Apex. It returns the number deleted; one call deletes at most 200 expired receipts. Passing false is rejected, so cleanup cannot happen by accident.

  • A receipt expires after 30 days.
  • One Preview accepts at most 200 unique record IDs.
  • Receipt counts cover the detached draft Check, not its prerequisite or sibling results.
  • The stored scope digest cannot be used to recover the representative record IDs.
  • A save failure returns a safe warning and does not change the completed Preview result.