Apex result, Lightning, and plugin types (L1)

Important

Use this page when tracing result, Lightning, or plugin types. This class-level reference is not a Setup or Flow walkthrough. Administrators should use the Flow, configuration, and evaluation guides; subscriber developers should use the public Apex API or Apex Check contract.

Note

Use this page to understand the objects returned by the Apex API, the data sent to the Lightning card, the interface implemented by a custom Apex Check, and the examples included in the repository.

Use the Apex class reference to place these result and plugin classes in the full package structure. To write a plugin, see Apex Check contract and Plugin verification.

Results, definitions, and plugin interface (L1)

RecordHealthCheckEvaluationResult / RecordHealthCheckResultDisplay

Role: Keep values used by automation separate from text formatted for a person.

Type: Global data holders

RecordHealthCheckEvaluationResult contains Status, the Check Qualified API Name, Reason Code, Severity, and Found and Expected values in their Salesforce data types. RecordHealthCheckResultDisplay contains labels, messages, links, and formatted values only when the request asks for display content.

RecordHealthCheckResponse / RecordHealthCheckResultItem

Role: Return results for either one Check or a complete Check Set.

Type: Global data holders

The response keeps the input record order and selected Check order. Each item contains one evaluation and, when requested, its display content. The summary contains the number of PASS, FAIL, SKIPPED, UNABLE_TO_EVALUATE, and ERROR results.

See also: Apex API response contract

RecordHealthCheckDefinition / RecordHealthCheckDefinitionResponse

Role: Tell the Lightning card which Checks and display settings to use.

Type: Data holders (@AuraEnabled) · public (no sharing keyword)

Key members:

Member	Purpose
RecordHealthCheckDefinition.developerName / label / description / priority	One Check’s identity and display fields
RecordHealthCheckDefinition.dependsOnCheckDeveloperName	null when the Check has no PrerequisiteCheck__c dependency
RecordHealthCheckDefinitionResponse title/trigger/reveal/display fields	Check Set card settings (title, trigger/reveal modes, passed/skipped/comparison display, stop-on-first-error)
RecordHealthCheckDefinitionResponse.checksOmittedByLimit	Compatibility flag kept false because a Check Set over 25 active Checks fails closed before definitions are returned
RecordHealthCheckDefinitionResponse.inactiveCheckLabels	Diagnostics-only detail behind inactiveCheckCount
RecordHealthCheckDefinitionResponse.showDiagnostics / checks	Diagnostics visibility flag and the ordered Check definitions

Notable behavior:

• inactiveCheckLabels contains the names of inactive Checks, not only their count. The Lightning card uses this information only when an authorized administrator opens diagnostics.

RecordHealthCheckAdminDetail

Role: Hold troubleshooting details shown only to users allowed to view diagnostics.

Type: Data holder (@AuraEnabled) · public (no sharing keyword)

Left blank on a normal business response.

Key members:

Member	Purpose
containsRestrictedDetail	Whether the diagnostic object contains access-sensitive details
reasonCode	Diagnostics reason code
message	Diagnostics message text

Notable behavior:

• All three fields are @AuraEnabled and are assigned individually by package code.
• The current Platform Event publisher always sets ContainsRestrictedDetail__c to false; it does not copy containsRestrictedDetail from this object into an event.

RecordHealthCheckValueSource

Role: Build readable notes explaining where a Found or Expected value came from.

Type: Data holder · public (no sharing keyword)

Key members:

Member	Purpose
Detail (nested: sourceLabel, rawValueLabel, coercionLabel)	Structured pieces of one diagnostic note
render(Detail)	Turns a Detail into the single human-readable note shown as actualValueDetail / expectedValueDetail
rowCount(...)	Formats pluralized row counts

Notable behavior:

• render returns null, not an empty string, when every part is blank. The Lightning card therefore does not show an empty pair of parentheses.
• rowCount produces natural wording: 1 row, 2 rows, and 0 rows when the count is null.

RecordHealthCheckPlugin (interface)

Role: Define the method every custom Apex Check must provide.

Type: Interface · global

global interface RecordHealthCheckPlugin {
  Map<Id, RecordHealthCheckOutcome> evaluate(RecordHealthCheckScope scope);
}

RecordHealthCheckDisplayPlugin / RecordHealthCheckDisplayOverride

Role: Optionally derive human presentation from data already loaded during evaluation.

Type: Global additive interface and fluent result holder

The callback runs once on the same plugin instance only for EVALUATION_WITH_DISPLAY. Its detached result may override message, FAIL-only fix/action, rich Found/Expected, Expected label, and per-side format/currency. Missing or invalid fields fall back independently to Check configuration. The machine outcome and administrator-owned identity, severity, visibility, ordering and lifecycle policy remain unchanged.

RecordHealthCheckDisplayAction keeps its label and destination atomic. The destination must pass the established Action URL policy before either field replaces the configured action.

The package calls evaluate once with all record IDs in the current request. A plugin should query for all IDs together, create one initial outcome for every requested ID, apply the facts returned by the query, and handle a record-specific conversion problem inside the record loop.

Notable behavior:

• The method signature cannot prove that a plugin queries efficiently or respects the running user’s access. Package code rejects missing or extra result IDs and prohibited database changes. The supplied contract test checks behavior with 1, 10, 50, and 200 records. A human must still review each SOQL query’s access mode.

RecordHealthCheckScope

Role: Supply the records and configuration to RecordHealthCheckPlugin.evaluate.

Type: Read-only global data holder

Key members:

Member	Purpose
objectApiName	Object API name (for example Account)
recordIds	Copy of every record ID in the request
parameters	Copy of the JSON object from ApexParametersJson__c, converted to an Apex map
checkQualifiedApiName	Qualified Check identity
checkSetQualifiedApiName	Qualified parent Check Set identity
runId	ID that connects logs and events from the same request

Notable behavior:

• The getters return copies of the record IDs and parameters. Changing those returned collections cannot change the package’s original request.

See also: Reference: Apex

---

Apex plugin examples

These classes implement RecordHealthCheckPlugin. They show how a custom Apex Check works. Formula, Query, and Compare two queries Checks do not depend on them.

AccountHasRecentActivityCheck

Role: Example that checks recent Account Task or Event activity.

Type: Example plugin (implements RecordHealthCheckPlugin, RecordHealthCheckPluginDefinitionSource, and RecordHealthCheckDisplayPlugin) · global with sharing

This class is included with the installed Record Health Check package. It returns PASS when an Account meets the configured minimum number of closed Tasks and Events dated on or after the calculated cutoff. daysBack defaults to 30 and accepts 1–3,650; minimumActivities defaults to 1 and accepts 1–1,000. Check metadata supplies identity, severity, applicability, publication, and fallback presentation.

Key members:

Member	Purpose
DEFAULT_DAYS_BACK (30)	Look-back window only when daysBack is omitted
MIN_DAYS_BACK / MAX_DAYS_BACK (1 / 3650)	Valid bounds for daysBack
getDefinition()	Declares typed parameters, labels/help, and bulk capacity of 200 at LOW cost
ActivityOutcomeEvaluator	Uses tryEvaluate over preloaded counts for per-record recovery
outcomeFor(...)	Builds typed comparison values and one evidence row
getDisplay(...)	Reuses evaluation state to add query-free message, link, formats, fix, and action

Notable behavior:

• When daysBack is omitted, the class uses 30. A nonnumeric value or a number outside 1 through 3,650 returns UNABLE_TO_EVALUATE/INVALID_CONFIG.
• Both queries use WITH USER_MODE, so the result respects the running user’s record, object, and field access.
• The query count stays at two for a scope of one through 200 Accounts.
• Zero is a real negative value and remains in Found and evidence.
• Display output cannot alter the verdict and falls back to metadata by field when absent or invalid.

See also: Recent Account activity example

Integration-test plugins

These live under integration-tests/main/default/classes/. Installing Record Health Check does not install them. They become available only if your team deliberately deploys that folder.

Class	What it checks	Typical JSON parameters
AccountOpenOpportunityHealthCheck	Open Opportunities that are stale, missing Next Step, and not closing this quarter	{"staleDays": 30}
AccountStrategicReadinessCheck	Weighted readiness score (contacts, pipeline, activity, billing)	{"minScore": 80, "activityDaysBack": 60}

See also: Apex examples

---

Package test helpers

Class	Note
RecordHealthCheckTestDataFactory	@isTest factory for Accounts, Contacts, and related test records; health checks do not use it
*Test.cls / coverage classes	Package tests; custom Apex should not call them as a supported API

---

Related

• Apex class reference
• Architecture