Skip to content

Names and API identities

Use this reference to choose the exact Check Set or Check name required by each Salesforce entry point and understand namespace behavior for installed metadata.

Apex, Flow, Lightning App Builder, and Platform Events identify a Check Set or Check by its exact Qualified API Name. Copy that value from Salesforce. Do not type or remove rhc__ yourself.

Lightning App Builder stores this value when you select a Check Set from the component list. You normally copy it yourself only for a Flow or Apex request, an integration, or troubleshooting.

A Custom Metadata record has several names. Only one belongs in Record Health Check requests.

Name shown in SalesforceExampleUse in Apex or Flow?
LabelAccount checksNo. This is text shown to administrators
Developer NameMy_Account_ChecksDo not use it as a substitute for the Qualified API Name
Qualified API NameMy_Account_Checks or rhc__Example_Account_Check_Builder_GuideYes. Copy this exact value

For a Check Set created by an administrator in your org, Developer Name and Qualified API Name usually look the same. They are still different Salesforce fields. Always copy Qualified API Name so the same instructions also work for metadata installed from a package.

Why does an installed example begin with rhc__?

Section titled “Why does an installed example begin with rhc__?”

rhc is the Record Health Check package namespace. Salesforce adds rhc__ to the Qualified API Name of a Custom Metadata record included with that installed package.

Who created the Custom Metadata record?Developer NameQualified API Name example
An administrator in your orgMy_Account_ChecksMy_Account_Checks
The installed Record Health Check packageExample_Account_Check_Builder_Guiderhc__Example_Account_Check_Builder_Guide
Another installed package with namespace otherAccount_Readinessother__Account_Readiness

The prefix belongs to the package that supplied that particular Custom Metadata record. It does not come from the Check Set’s object or from the Apex class calling Record Health Check.

  1. From Setup, enter Custom Metadata Types in Quick Find.
  2. Select Custom Metadata Types.
  3. Next to Record Health Check Set, select Manage Records.
  4. Open the Check Set.
  5. Copy Qualified API Name exactly as Salesforce shows it.

To run one Check instead of its entire Check Set, repeat the steps for Record Health Check and copy that Check’s Qualified API Name.

Use the copied value without changing it:

// This example represents a Check Set created by an administrator in your org.
// Replace it with the exact Qualified API Name copied from Setup.
String checkSetApiName = 'My_Account_Checks';

Do not add rhc__ because the Apex class begins with rhc.. These are separate names:

// rhc. identifies the installed Apex class.
// checkSetApiName identifies the selected Custom Metadata record.
rhc.RecordHealthCheckResponse response = rhc.RecordHealthCheck.evaluate(
rhc.RecordHealthCheckRequest.forCheckSet(checkSetApiName, accountIds)
);

If you need to confirm the values with SOQL, query the installed Custom Metadata Type:

SELECT DeveloperName, QualifiedApiName
FROM rhc__Record_Health_Check_Set__mdt
ORDER BY QualifiedApiName

The rhc__ after FROM identifies the Custom Metadata Type installed by Record Health Check. The returned QualifiedApiName identifies each Check Set record. Copy the returned value; do not add or remove a prefix.

Record Health Check does not guess. It does not remove a namespace, add rhc__, retry with Developer Name, or select a record with a similar label. The request fails clearly when the exact Qualified API Name is missing or unknown.

This prevents a request from silently running a different Check Set that happens to have the same Developer Name.

The Lightning card reports that its configuration could not be found. Flow and Apex return the corresponding configuration error, including CONFIG_NOT_FOUND where a per-result contract applies. Return to Setup, copy Qualified API Name, and replace the value without editing its namespace prefix.

Keep Example starter configuration explicit

Section titled “Keep Example starter configuration explicit”

The package installs four active Example Check Set records whose Developer Names begin with Example_ and whose card titles begin with Example:. They are learning examples, not business rules for your org:

  • Example_Account_Check_Builder_Guide
  • Example_Account_Relationship_Risk
  • Example_Contact_Relationship_Readiness
  • Example_Opportunity_Deal_Readiness

Create separate Check Sets with names and titles that describe your own business requirements. A package upgrade can update its installed examples; it must not overwrite Custom Metadata records created by your team.