Skip to content

Source inventory

Detailed page. Use “On this page” to jump directly to the section you need.

This page is generated from package source by npm run generate:docs:inventory. Do not edit it by hand. npm run check:docs:inventory fails when source and this page differ.

Use this inventory to confirm what the package actually ships. Task guides explain how to use these capabilities.

ItemSource value
PackageRecord Health Check
Namespacerhc
Metadata API66.0
Salesforce labelAPI namePurpose
Record Health Check AdminRecord_Health_Check_AdminConfigure and validate Record Health Check and view diagnostics. Creating Custom Metadata records also requires Salesforce Customize Application or equivalent access.
Record Health Check Card UserRecord_Health_Check_Card_UserRun the Lightning record-page card, configure its App Builder picker, and publish enabled card lifecycle events. Excludes Flow, Agent, REST, async Apex, and Custom Metadata authoring.
Record Health Check Diagnostics ViewerRecord_Health_Check_Diagnostics_ViewerView restricted Record Health Check details, including troubleshooting output when enabled. Assign alongside a packaged runner Permission Set temporarily and narrowly.
Record Health Check Error Log PublisherRecord_Health_Check_Error_Log_PublisherPublish restricted Record Health Check Log Platform Events. Assign narrowly: Salesforce requires Read together with Create for Platform Event publishers.
Record Health Check MCP IntegrationRecord_Health_Check_MCP_IntegrationRun only the versioned Record Health Check Apex REST adapter for dedicated integrations. Excludes UI, Flow, Agentforce, async Apex, lifecycle events, and diagnostics.
Record Health Check Readiness AuditorRecord_Health_Check_Readiness_AuditorRead-only access to bounded Record Health Check draft verification receipts.
Record Health Check UserRecord_Health_Check_UserRun Record Health Checks from Lightning, Apex, Flow, or Agentforce. Includes the required entry-point classes and Set Run and Check Result event access. Excludes diagnostic details.
Salesforce labelAPI namePurpose
Record Health Check RunRecord_Health_Check_RunAllows a user to run Record Health Checks from supported Lightning, Flow, Apex, and asynchronous entry points.
Salesforce labelBundleAvailable in Lightning App BuilderPurpose
Record Health CheckrecordHealthChecklightning__RecordPageRuns metadata-driven record health checks with SLDS 1 and SLDS 2 styling.
Record Health Check PreviewrecordHealthCheckPreviewlightning__AppPage, lightning__HomePage, lightning__TabAdministrator-only detached Check validation and representative-record preview.
ComponentSalesforce labelPropertyTypePurpose
Record Health CheckCheck SetcheckSetNameStringChoose the Check Set to run on this record page. The list shows active Check Sets whose Record Object API Name matches this page’s object. If the list is empty, create and activate a Check Set for this object under Setup - Custom Metadata Types - Record Health Check Set.
SurfaceSalesforce labelApex classPurpose
FlowRun Record Health CheckRecordHealthCheckRunCheckFlowActionRuns one qualified Record Health Check for each input record.
AgentforceRun Record Health Check for AgentforceRecordHealthCheckRunCheckAgentActionUse when a user asks for the actual result of one named Record Health Check on one Salesforce record. FAIL is a completed business finding. UNABLE_TO_EVALUATE and ERROR are not PASS.
FlowRun Record Health Check SetRecordHealthCheckRunSetFlowActionRuns one qualified Record Health Check Set for each input record.
AgentforceRun Record Health Check Set for AgentforceRecordHealthCheckRunSetAgentActionUse when a user asks for the actual health of one Salesforce record under one named Record Health Check Set. FAIL is a completed business finding. UNABLE_TO_EVALUATE and ERROR are not PASS.
FlowValidate Record Health Check ConfigurationRecordHealthCheckValidateMetadataActionValidates every Record Health Check Set and Check, including inactive drafts, before activation.
ActionDirectionSalesforce labelApex variableTypeRequired
Run Record Health CheckInputCheck Qualified API NamecheckQualifiedApiNameStringYes
Run Record Health CheckInputRecord IDrecordIdIdYes
Run Record Health CheckInputEvent PublicationeventPublicationStringYes
Run Record Health CheckOutputSuccessisSuccessBooleanNo
Run Record Health CheckOutputError MessageerrorMessageStringNo
Run Record Health CheckOutputError TypeerrorTypeStringNo
Run Record Health CheckOutputContract VersioncontractVersionStringNo
Run Record Health CheckOutputStatusstatusStringNo
Run Record Health CheckOutputReason CodereasonCodeStringNo
Run Record Health CheckOutputResult JSONresultJsonStringNo
Run Record Health Check for AgentforceInputRecord IDrecordIdIdYes
Run Record Health Check for AgentforceInputCheck Qualified API NamequalifiedApiNameStringYes
Run Record Health Check for AgentforceInputCorrelation IDcorrelationIdStringNo
Run Record Health Check for AgentforceOutputContract VersioncontractVersionStringNo
Run Record Health Check for AgentforceOutputCorrelation IDcorrelationIdStringNo
Run Record Health Check for AgentforceOutputSuccesssuccessBooleanNo
Run Record Health Check for AgentforceOutputOperationoperationStringNo
Run Record Health Check for AgentforceOutputStatusstatusStringNo
Run Record Health Check for AgentforceOutputReason CodereasonCodeStringNo
Run Record Health Check for AgentforceOutputError TypeerrorTypeStringNo
Run Record Health Check for AgentforceOutputError MessageerrorMessageStringNo
Run Record Health Check for AgentforceOutputDiagnostic IDdiagnosticIdStringNo
Run Record Health Check for AgentforceOutputDiagnostic CategorydiagnosticCategoryStringNo
Run Record Health Check for AgentforceOutputDiagnostic SummarydiagnosticSummaryStringNo
Run Record Health Check for AgentforceOutputRecommended ActionrecommendedActionStringNo
Run Record Health Check SetInputCheck Set Qualified API NamecheckSetQualifiedApiNameStringYes
Run Record Health Check SetInputRecord IDrecordIdIdYes
Run Record Health Check SetInputEvent PublicationeventPublicationStringYes
Run Record Health Check SetOutputSuccessisSuccessBooleanNo
Run Record Health Check SetOutputError MessageerrorMessageStringNo
Run Record Health Check SetOutputError TypeerrorTypeStringNo
Run Record Health Check SetOutputContract VersioncontractVersionStringNo
Run Record Health Check SetOutputStatusstatusStringNo
Run Record Health Check SetOutputPassed CountpassedCountIntegerNo
Run Record Health Check SetOutputFailed CountfailedCountIntegerNo
Run Record Health Check SetOutputSkipped CountskippedCountIntegerNo
Run Record Health Check SetOutputUnable CountunableCountIntegerNo
Run Record Health Check SetOutputSystem Error CountsystemErrorCountIntegerNo
Run Record Health Check SetOutputResult JSONresultJsonStringNo
Run Record Health Check Set for AgentforceInputRecord IDrecordIdIdYes
Run Record Health Check Set for AgentforceInputCheck Set Qualified API NamequalifiedApiNameStringYes
Run Record Health Check Set for AgentforceInputCorrelation IDcorrelationIdStringNo
Run Record Health Check Set for AgentforceOutputContract VersioncontractVersionStringNo
Run Record Health Check Set for AgentforceOutputCorrelation IDcorrelationIdStringNo
Run Record Health Check Set for AgentforceOutputSuccesssuccessBooleanNo
Run Record Health Check Set for AgentforceOutputOperationoperationStringNo
Run Record Health Check Set for AgentforceOutputStatusstatusStringNo
Run Record Health Check Set for AgentforceOutputPassed CountpassedIntegerNo
Run Record Health Check Set for AgentforceOutputFailed CountfailedIntegerNo
Run Record Health Check Set for AgentforceOutputSkipped CountskippedIntegerNo
Run Record Health Check Set for AgentforceOutputUnable CountunableIntegerNo
Run Record Health Check Set for AgentforceOutputSystem Error CountsystemErrorIntegerNo
Run Record Health Check Set for AgentforceOutputError TypeerrorTypeStringNo
Run Record Health Check Set for AgentforceOutputError MessageerrorMessageStringNo
Run Record Health Check Set for AgentforceOutputDiagnostic IDdiagnosticIdStringNo
Run Record Health Check Set for AgentforceOutputDiagnostic CategorydiagnosticCategoryStringNo
Run Record Health Check Set for AgentforceOutputDiagnostic SummarydiagnosticSummaryStringNo
Run Record Health Check Set for AgentforceOutputRecommended ActionrecommendedActionStringNo
KindSalesforce labelAPI nameCustom fields
Custom Metadata TypeRecord Health CheckRecord_Health_Check__mdt45
Platform EventRecord Health Check LogRecord_Health_Check_Log__e15
Custom ObjectRecord Health Check ReadinessRecord_Health_Check_Readiness__c17
Platform EventRecord Health Check ResultRecord_Health_Check_Result__e13
Custom Metadata TypeRecord Health Check SetRecord_Health_Check_Set__mdt19
Platform EventRecord Health Check Set RunRecord_Health_Check_Set_Run__e18
Salesforce labelAPI nameType
Check Developer NameCheckDeveloperName__cText
Check Set Developer NameCheckSetDeveloperName__cText
CodeCode__cText
Contract VersionContractVersion__cText
Structured Diagnostic DetailsDetailsJson__cLongTextArea
Event IDEventId__cText
Exception TypeExceptionType__cText
Framework VersionFrameworkVersion__cText
LevelLevel__cText
MessageMessage__cLongTextArea
Occurred AtOccurredAt__cDateTime
Record IDRecordId__cText
Run IDRunId__cText
Stack TraceStackTrace__cLongTextArea
User IDUserId__cText
Salesforce labelAPI nameType
Check Qualified API NameCheckQualifiedApiName__cText
Check Set Qualified API NameCheckSetQualifiedApiName__cText
Contains Restricted DetailContainsRestrictedDetail__cCheckbox
Contract VersionContractVersion__cText
Event IDEventId__cText
Framework VersionFrameworkVersion__cText
Occurred AtOccurredAt__cDateTime
Reason CodeReasonCode__cText
Record IDRecordId__cText
Run IDRunId__cText
SeveritySeverity__cText
SourceSource__cText
StatusStatus__cText
Salesforce labelAPI nameType
Check Set Qualified API NameCheckSetQualifiedApiName__cText
Contract VersionContractVersion__cText
Eligible Check CountEligibleCheckCount__cNumber
Evaluated Check CountEvaluatedCheckCount__cNumber
Event IDEventId__cText
Failed CountFailedCount__cNumber
Framework VersionFrameworkVersion__cText
Occurred AtOccurredAt__cDateTime
Passed CountPassedCount__cNumber
PhasePhase__cText
Processed Record CountProcessedRecordCount__cNumber
Record IDRecordId__cText
Run IDRunId__cText
Skipped CountSkippedCount__cNumber
SourceSource__cText
Submitted Record CountSubmittedRecordCount__cNumber
System Error CountSystemErrorCount__cNumber
Unable CountUnableCount__cNumber
Salesforce labelAPI nameObjectActive
Example: Account Check Builder GuideExample_Account_Check_Builder_GuideAccountYes
Example: Account Relationship & RiskExample_Account_Relationship_RiskAccountYes
Example: Contact Relationship ReadinessExample_Contact_Relationship_ReadinessContactYes
Example: Opportunity Deal ReadinessExample_Opportunity_Deal_ReadinessOpportunityYes
Salesforce labelAPI nameCheck SetEvaluation TypeActive
Example: Account Owner Is ActiveExample_Account_Owner_ActiveExample_Account_Relationship_RiskFORMULAYes
Example: Proposal and Product totalsExample_Average_Deal_Vs_LargestExample_Account_Check_Builder_GuideCOMPARE_TWO_QUERIESYes
Example: Find a Technical Buyer roleExample_Billing_State_In_ContactsExample_Account_Check_Builder_GuideQUERYYes
Example: Channel Partner GovernanceExample_Channel_Partner_GovernanceExample_Account_Relationship_RiskQUERYYes
Example: Opportunity Product coverageExample_Contact_Cities_Exact_ParentExample_Account_Check_Builder_GuideCOMPARE_TWO_QUERIESYes
Example: Sales and service ContactsExample_Contact_Cities_Overlap_ParentExample_Account_Check_Builder_GuideCOMPARE_TWO_QUERIESYes
Example: Contact Readiness - AccountExample_Contact_RR_AccountExample_Contact_Relationship_ReadinessFORMULAYes
Example: Contact Readiness - EmailExample_Contact_RR_EmailExample_Contact_Relationship_ReadinessQUERYYes
Example: Contact Readiness - CityExample_Contact_RR_Mailing_CityExample_Contact_Relationship_ReadinessFORMULAYes
Example: Contact - Active OwnerExample_Contact_RR_Owner_ActiveExample_Contact_Relationship_ReadinessQUERYYes
Example: Contact reporting lineExample_Contact_RR_PhoneExample_Contact_Relationship_ReadinessFORMULAYes
Example: Contact - Email or PhoneExample_Contact_RR_Reachable_ChannelExample_Contact_Relationship_ReadinessFORMULAYes
Example: Contact - Recent EngagementExample_Contact_RR_Recent_EngagementExample_Contact_Relationship_ReadinessQUERYYes
Example: Contact Readiness - TitleExample_Contact_RR_TitleExample_Contact_Relationship_ReadinessFORMULAYes
Example: Contact details on open dealsExample_Contact_States_Match_BillingExample_Account_Check_Builder_GuideQUERYYes
Example: Proposal Next StepsExample_Contact_Vs_Open_Opp_CountExample_Account_Check_Builder_GuideCOMPARE_TWO_QUERIESYes
Example: Cases closed vs createdExample_Contacts_Cover_Open_CasesExample_Account_Check_Builder_GuideQUERYYes
Example: Contacts Have Email AddressesExample_Contacts_Have_EmailExample_Account_Relationship_RiskQUERYYes
Example: Customer Engagement Is CurrentExample_Customer_Engagement_CurrentExample_Account_Relationship_RiskAPEXYes
Example: Open Opportunity Close DatesExample_Distinct_Cities_Vs_ContactsExample_Account_Check_Builder_GuideCOMPARE_TWO_QUERIESYes
Example: Won Opportunity primary rolesExample_Earliest_Vs_Latest_CloseExample_Account_Check_Builder_GuideCOMPARE_TWO_QUERIESYes
Example: Executive SponsorshipExample_Executive_SponsorshipExample_Account_Relationship_RiskQUERYYes
Example: High-priority Case countExample_Fewer_Than_Ten_Open_CasesExample_Account_Check_Builder_GuideQUERYYes
Example: Escalated Case descriptionsExample_Guide_Contacts_Have_EmailExample_Account_Check_Builder_GuideQUERYYes
Example: Parent bill-to alignmentExample_Guide_Industry_ManufacturingExample_Account_Check_Builder_GuideFORMULAYes
Example: Proposal CampaignsExample_Guide_Open_Deals_Have_ContactsExample_Account_Check_Builder_GuideCOMPARE_TWO_QUERIESYes
Example: Verified engagement cadenceExample_Guide_Recent_ActivityExample_Account_Check_Builder_GuideAPEXYes
Example: Decision Maker rolesExample_Has_At_Least_One_ContactExample_Account_Check_Builder_GuideQUERYYes
Example: Active Opportunity ownersExample_High_Value_Open_OppExample_Account_Check_Builder_GuideQUERYYes
Example: Industry Aligns With ParentExample_Industry_Aligns_With_ParentExample_Account_Relationship_RiskFORMULANo
Example: No High-Priority IssuesExample_No_High_Priority_IssuesExample_Account_Relationship_RiskQUERYYes
Example: Open Opportunity Contact RolesExample_Oldest_Contact_City_MatchesExample_Account_Check_Builder_GuideCOMPARE_TWO_QUERIESYes
Example: Open Case ContactsExample_Open_Cases_Have_ContactsExample_Account_Check_Builder_GuideQUERYYes
Example: Open Deals Have ContactsExample_Open_Deals_Have_ContactsExample_Account_Relationship_RiskCOMPARE_TWO_QUERIESYes
Example: Proposal Amount exceptionsExample_Open_Opps_Have_AmountExample_Account_Check_Builder_GuideQUERYYes
Example: New pipeline vs lost valueExample_Open_Pipeline_Covers_RevenueExample_Account_Check_Builder_GuideCOMPARE_TWO_QUERIESYes
Example: Deal Readiness - AccountExample_Opportunity_DR_AccountExample_Opportunity_Deal_ReadinessFORMULAYes
Example: Deal Readiness - AmountExample_Opportunity_DR_AmountExample_Opportunity_Deal_ReadinessFORMULAYes
Example: Deal Readiness - Buyer ContactExample_Opportunity_DR_Buyer_ContactExample_Opportunity_Deal_ReadinessQUERYYes
Example: Deal Readiness - Close DateExample_Opportunity_DR_Close_DateExample_Opportunity_Deal_ReadinessFORMULAYes
Example: Deal Readiness - Next StepExample_Opportunity_DR_Next_StepExample_Opportunity_Deal_ReadinessFORMULAYes
Example: Deal Readiness - Active OwnerExample_Opportunity_DR_Owner_ActiveExample_Opportunity_Deal_ReadinessQUERYYes
Example: Deal Readiness - ProbabilityExample_Opportunity_DR_ProbabilityExample_Opportunity_Deal_ReadinessFORMULAYes
Example: Deal - Recent ActivityExample_Opportunity_DR_Recent_ActivityExample_Opportunity_Deal_ReadinessQUERYYes
Example: Won Opportunity AmountsExample_Parent_Cities_Require_DataExample_Account_Check_Builder_GuideCOMPARE_TWO_QUERIESYes
Example: Priority Case Contact coverageExample_Parent_Covers_Contact_CitiesExample_Account_Check_Builder_GuideCOMPARE_TWO_QUERIESYes
Example: Pipeline Protects RevenueExample_Pipeline_Protects_RevenueExample_Account_Relationship_RiskQUERYYes
Example: Account Phone or WebsiteExample_Segregation_Of_DutiesExample_Account_Check_Builder_GuideFORMULAYes
Example: Commit Opportunity countExample_Significant_Open_OppExample_Account_Check_Builder_GuideQUERYYes
Example: Account Type is setExample_Website_URL_ValidExample_Account_Check_Builder_GuideFORMULAYes
Apex typeGlobal methods
RecordHealthCheckRequestforCheck(), forCheckSet(), withDiagnosticContractVersion(), withEventPublication(), withExecutionOrigin(), withResultMode(), withRunId()
RecordHealthCheckOptionsdefaults(), withDiagnosticContractVersion(), withEventPublication(), withExecutionOrigin(), withResultMode(), withRunId()
RecordHealthCheckPreviewRequestforDraftCheck(), withMode(), withReadinessReceipt()
RecordHealthCheckPreviewServicedeleteExpiredReadinessReceipts(), preview()
RecordHealthCheckQueueableenqueue(), execute()
RecordHealthCheckBatchexecute(), finish(), run(), start()
RecordHealthCheckScheduledexecute(), scheduleDaily()

These are the namespace-visible Apex types shipped by the package. A blank method cell means the type is a DTO, enum, exception, or marker whose public contract is its fields, values, inheritance, or interface declaration.

Apex typeKindGlobal methods declared in source
AccountHasRecentActivityCheckclassevaluate(), getDefinition(), getDisplay()
RecordHealthCheckclassevaluate()
RecordHealthCheckAdminDetailclassNot applicable
RecordHealthCheckAgentRestResourceclassdoPost()
RecordHealthCheckBatchclassexecute(), finish(), run(), start()
RecordHealthCheckContractHarnessTestclasscreateScope(), evaluate(), newCheck(), testData()
RecordHealthCheckContractTestabstract classhasPermissionEvidence(), hasStableQueryGrowth(), newCheck(), testData(), verifyContract()
RecordHealthCheckContractTestDataabstract classcreateScope(), permissionFixture()
RecordHealthCheckDiagnosticActionclassNot applicable
RecordHealthCheckDiagnosticEnvelopeclassNot applicable
RecordHealthCheckDiagnosticErrorDetailclassNot applicable
RecordHealthCheckDiagnosticIncidentclassNot applicable
RecordHealthCheckDiagnosticResponseclassNot applicable
RecordHealthCheckDiagnosticTraceEntryclassNot applicable
RecordHealthCheckDisplayActionclassNot applicable
RecordHealthCheckDisplayContentclassNot applicable
RecordHealthCheckDisplayGroupclasswithEmptyState(), withItems(), withLabel(), withSeparator()
RecordHealthCheckDisplayNodeclassNot applicable
RecordHealthCheckDisplayOverrideclasswithAction(), withExpected(), withExpectedFormat(), withExpectedLabel(), withFix(), withFound(), withFoundFormat(), withMessage()
RecordHealthCheckDisplayPlugininterfaceNot applicable
RecordHealthCheckDisplayTextclassgroups(), isEmpty(), lineBreak(), link(), paragraphBreak(), recordLinks(), text()
RecordHealthCheckEvaluationResultclassNot applicable
RecordHealthCheckEventPublicationenumNot applicable
RecordHealthCheckEvidenceclasscolumn(), groupBy(), row()
RecordHealthCheckEvidenceCellclassfield(), value()
RecordHealthCheckEvidenceColumnclassNot applicable
RecordHealthCheckEvidenceEnvelopeclassNot applicable
RecordHealthCheckExecutionOriginenumNot applicable
RecordHealthCheckOptionsclassdefaults(), withDiagnosticContractVersion(), withEventPublication(), withExecutionOrigin(), withResultMode(), withRunId()
RecordHealthCheckOutcomeclasserror(), fail(), failEquals(), itemsFound(), noneFound(), pass(), passEquals(), skipped(), tryEvaluate(), unableToEvaluate(), withComparison(), withEvidence(), withExpected(), withFound()
RecordHealthCheckOutcomeBuilderExceptionclassNot applicable
RecordHealthCheckPlugininterfaceNot applicable
RecordHealthCheckPluginDefinitionclassbooleanParameter(), capacity(), choiceParameter(), describe(), integerParameter(), nullable(), required(), stringParameter()
RecordHealthCheckPluginDefinitionSourceinterfaceNot applicable
RecordHealthCheckPluginTestclassverify()
RecordHealthCheckPluginVerificationclassassertComplete(), assertNoSideEffects(), assertRenderable()
RecordHealthCheckPreviewFindingclassNot applicable
RecordHealthCheckPreviewParameterclassNot applicable
RecordHealthCheckPreviewRequestclassforDraftCheck(), withMode(), withReadinessReceipt()
RecordHealthCheckPreviewResponseclassNot applicable
RecordHealthCheckPreviewServiceclassdeleteExpiredReadinessReceipts(), preview()
RecordHealthCheckQueueableclassenqueue(), execute()
RecordHealthCheckReadinessReceiptclassNot applicable
RecordHealthCheckRecordEvaluatorinterfaceNot applicable
RecordHealthCheckRequestclassforCheck(), forCheckSet(), withDiagnosticContractVersion(), withEventPublication(), withExecutionOrigin(), withResultMode(), withRunId()
RecordHealthCheckResponseclassdiagnostics()
RecordHealthCheckResultDisplayclassNot applicable
RecordHealthCheckResultItemclassNot applicable
RecordHealthCheckResultModeenumNot applicable
RecordHealthCheckRunCheckAgentActionclassrunCheck()
RecordHealthCheckRunCheckFlowActionclassrunCheck()
RecordHealthCheckRunSetAgentActionclassrunSet()
RecordHealthCheckRunSetFlowActionclassrunSet()
RecordHealthCheckRunSummaryclassadd(), total()
RecordHealthCheckScheduledclassexecute(), scheduleDaily()
RecordHealthCheckScopeclassrecordIdAt(), size()
RecordHealthCheckSelectionclassforCheck(), forCheckSet()
RecordHealthCheckStatusabstract classisActionable()
RecordHealthCheckValidateMetadataActionclassvalidateConfiguration()
RecordHealthCheckValueclassisList(), ofBoolean(), ofCount(), ofDate(), ofDateTime(), ofId(), ofList(), ofNumber(), ofString()
  • RecordHealthCheck
  • RecordHealthCheckAgentRestResource
  • RecordHealthCheckBatch
  • RecordHealthCheckController
  • RecordHealthCheckPreviewController
  • RecordHealthCheckQueueable
  • RecordHealthCheckRunCheckAgentAction
  • RecordHealthCheckRunCheckFlowAction
  • RecordHealthCheckRunSetAgentAction
  • RecordHealthCheckRunSetFlowAction
  • RecordHealthCheckScheduled
  • RecordHealthCheckSetPicklist
  • RecordHealthCheckValidateMetadataAction