Names and API identities
Find the exact name that Apex, Flow, Lightning App Builder, and Platform Events use for a Check Set
or a Check, its Qualified API Name, and why some names start with rhc__.
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.
Which name should I use?
Section titled “Which name should I use?”A Custom Metadata record has several names. Only one belongs in Record Health Check requests.
| Name shown in Salesforce | Example | Use in Apex or Flow? |
|---|---|---|
| Label | Account checks | No. This is text shown to administrators |
| Developer Name | My_ | Do not use it as a substitute for the Qualified API Name |
| Qualified API Name | My_ or rhc_ | Yes. 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 Name | Qualified API Name example |
|---|---|---|
| An administrator in your org | My_ | My_ |
| The installed Record Health Check package | Example_ | rhc_ |
Another installed package with namespace other | Account_ | other_ |
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.
Find the Qualified API Name
Section titled “Find the Qualified API Name”In Setup, open Custom Metadata Types, and select Manage Records next to Record Health Check Set (or Record Health Check for a Check). The Record Health Check Set Name (or Record Health Check Name) is the record’s Developer Name. Its Qualified API Name is:
- the same name, for a record your organization created, such as
My_Account_Checks; or rhc__followed by the name, for a record that installs with the package, such asrhc__Example_Account_Check_Builder_Guide.
Two places show the Qualified API Name itself:
- The Check Set picker of the Record Health Check component in Lightning App Builder lists each Check Set as Label (Qualified API Name).
- The SOQL query in Confirm the names with SOQL returns it.
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.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));Confirm the names with SOQL
Section titled “Confirm the names with SOQL”Run this query in the Developer Console’s Query Editor, or with sf data query:
SELECT MasterLabel, DeveloperName, QualifiedApiNameFROM rhc__Record_Health_Check_Set__mdtORDER BY QualifiedApiNameFor Checks, query rhc__Record_Health_Check__mdt the same way.
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.
Resolve an API name mismatch
Section titled “Resolve an API name mismatch”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 record-page card shows “The selected Record Health Check is no longer available.” The Flow
actions return Error Type VALIDATION, and Apex throws an exception with the message
Check Set "<name>" was not found. Find the exact Qualified API Name as described above, and replace
the value without editing its 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_GuideExample_Account_Relationship_RiskExample_Contact_Relationship_ReadinessExample_Opportunity_Deal_Readiness
Create separate Check Sets with names and titles that describe your own business requirements. A package upgrade can replace the installed examples, including any edits made to them, but it never changes Custom Metadata records that your team created.