Skip to content
Suggest a correction

Explore the installed example Check Sets

Getting started12 min read

Record Health Check installs four example Check Sets with 50 example Checks for Account, Contact, and Opportunity records. Use them to confirm that an installation works and to study complete, working configuration before you build your own Checks.

The examples read the data already in your org. They never create or change Accounts, Contacts, Opportunities, or any other record. Treat them as teaching material: before you use Record Health Check in a business process, create Check Sets that your organization owns and has reviewed.

Every example has a label that starts with Example: and a Developer Name that starts with Example_. Because they install with the package, their Qualified API Names include the rhc__ namespace prefix, for example rhc__Example_Account_Check_Builder_Guide. Use that full name when a Flow or Apex call refers to an example.

Check Set labelDeveloper NameObjectChecksWhen Checks Run
Example: Account Check Builder GuideExample_Account_Check_Builder_GuideAccount25 activeWhen the user clicks Run
Example: Account Relationship & RiskExample_Account_Relationship_RiskAccount8 active, 1 inactiveWhen the user clicks Run
Example: Contact Relationship ReadinessExample_Contact_Relationship_ReadinessContact8 activeWhen the page opens
Example: Opportunity Deal ReadinessExample_Opportunity_Deal_ReadinessOpportunity8 activeWhen the page opens

All four Check Sets are active. None has Show Diagnostics, Publish User Run Event, or Publish Error Log Event selected, and no example Check has Publish User Result Event selected, so installing the examples creates no events and shows no diagnostic detail.

Some Developer Names were kept from earlier releases and no longer describe what the Check does. For example, Example_Website_URL_Valid checks that the Account Type is set. Identify an example Check by its Check Title.

  1. In Setup, enter Custom Metadata Types in Quick Find, then select Custom Metadata Types.
  2. Next to Record Health Check Set, select Manage Records.
  3. Open Example: Account Relationship & Risk. Note its Object, Card Title, and When Checks Run values.
  4. Return to Custom Metadata Types. Next to Record Health Check, select Manage Records.
  5. Open Example: No High-Priority Issues. Confirm that Check Set is Example_Account_Relationship_Risk.
  6. Review Evaluation Type, Source Query, Comparison Operator, Expected Value (Fixed), Message When Failed, and Fix Message. This Check counts open high-priority Cases on the Account and passes when the count equals 0.

A package upgrade can replace changes made to an installed example. To adapt an example, select Clone, give the copy your own label and name, and save it in a Check Set that your organization owns.

  1. Open an Account that you can edit in the sandbox.
  2. If the card shows Run, select it. The two Account examples wait for Run; the Contact and Opportunity examples run when the page opens.
  3. Confirm that the card shows a row for each active Check, not a setup message.
  4. Change one field that a Check uses. For example, on an Account with no open Cases, create a Case on the Account with Priority set to High.
  5. Select Rerun if the card does not run again by itself after the save.
  6. Confirm that No high-priority customer issues changes from Pass to Failed, and that Found shows the number of open high-priority Cases.
  7. Close or delete the test Case when you finish.

The tables list the Checks in the order they appear on the card. Checks with the same Evaluation Order appear in alphabetical order of their Developer Name.

This Check Set teaches every Evaluation Type, in order from simplest to most advanced: Formula, then Query, then Compare Two Queries, then Apex. Hover over or focus a Check title on the card to read how that Check works. It contains exactly 25 active Checks, the most a Check Set can run.

OrderCheck titleDeveloper NameEvaluation TypeFailure Severity
10Account Type is setExample_Website_URL_ValidVerify with a formulaWarning
20Account has a phone number or websiteExample_Segregation_Of_DutiesVerify with a formulaWarning
30Billing address matches the parent bill-to accountExample_Guide_Industry_ManufacturingVerify with a formulaInfo
40High-priority open Cases stay within the limitExample_Fewer_Than_Ten_Open_CasesVerify with a queryCritical
50At least one open Opportunity is CommitExample_Significant_Open_OppVerify with a queryInfo
60Every open Case has a ContactExample_Open_Cases_Have_ContactsVerify with a queryCritical
70Every escalated open Case has a DescriptionExample_Guide_Contacts_Have_EmailVerify with a queryWarning
80Every open Opportunity has an active ownerExample_High_Value_Open_OppVerify with a queryWarning
90No proposal has a missing or low AmountExample_Open_Opps_Have_AmountVerify with a queryWarning
100Open Opportunities include a Decision MakerExample_Has_At_Least_One_ContactVerify with a queryWarning
110Contacts on open deals have Email or PhoneExample_Contact_States_Match_BillingVerify with a queryWarning
120Open-deal Contact Roles include Technical BuyerExample_Billing_State_In_ContactsVerify with a queryInfo
130Cases closed keep pace with Cases createdExample_Contacts_Cover_Open_CasesVerify with a queryWarning
140Every won Opportunity has an AmountExample_Parent_Cities_Require_DataCompare two queriesWarning
150Every proposal has a Next StepExample_Contact_Vs_Open_Opp_CountCompare two queriesWarning
160Every proposal has a Primary Campaign SourceExample_Guide_Open_Deals_Have_ContactsCompare two queriesCritical
170Open Opportunity Close Dates are in rangeExample_Distinct_Cities_Vs_ContactsCompare two queriesInfo
180Every open Opportunity has a Contact RoleExample_Oldest_Contact_City_MatchesCompare two queriesCritical
190Every won Opportunity has a primary ContactExample_Earliest_Vs_Latest_CloseCompare two queriesWarning
200New pipeline value covers recently lost valueExample_Open_Pipeline_Covers_RevenueCompare two queriesCritical
210Total proposal Amount matches total Product valueExample_Average_Deal_Vs_LargestCompare two queriesWarning
220Sales and service share a Contact nameExample_Contact_Cities_Overlap_ParentCompare two queriesWarning
230Sales Contact names cover priority Case ContactsExample_Parent_Covers_Contact_CitiesCompare two queriesWarning
240Open Opportunity names match those with ProductsExample_Contact_Cities_Exact_ParentCompare two queriesWarning
250Account activity meets the 60-day cadenceExample_Guide_Recent_ActivityVerify with ApexWarning

Account Check Builder Guide: configuration and results shows the formula, queries, and settings of every Check in this set.

This Check Set reviews an Account before a customer conversation: sponsorship, ownership, contact coverage, engagement, pipeline, support risk, and partner governance. Its card title is Example: Account Relationship & Risk Health Check.

OrderCheck titleDeveloper NameEvaluation TypeFailure Severity
10Executive sponsorship is establishedExample_Executive_SponsorshipVerify with a queryWarning
20Account owner is activeExample_Account_Owner_ActiveVerify with a formulaCritical
25Industry aligns with parent accountExample_Industry_Aligns_With_ParentVerify with a formulaInfo
25Open deals have customer contactsExample_Open_Deals_Have_ContactsCompare two queriesWarning
30Contacts have email addressesExample_Contacts_Have_EmailVerify with a queryWarning
40Customer engagement is currentExample_Customer_Engagement_CurrentVerify with ApexWarning
50Pipeline protects the revenue baseExample_Pipeline_Protects_RevenueVerify with a queryInfo
60No high-priority customer issuesExample_No_High_Priority_IssuesVerify with a queryCritical
90Channel partner governance is completeExample_Channel_Partner_GovernanceVerify with a queryWarning

Industry aligns with parent account is inactive and does not appear on the card. It remains in the package so that upgrades do not remove a record that an existing org may reference.

This Check Set reviews whether a Contact is ready for relationship work.

OrderCheck titleDeveloper NameEvaluation TypeFailure Severity
10Account Relationship Is EstablishedExample_Contact_RR_AccountVerify with a formulaCritical
20Relationship Role Has Business ContextExample_Contact_RR_TitleVerify with a formulaInfo
30Business Location Has Regional ContextExample_Contact_RR_Mailing_CityVerify with a formulaInfo
40Contact has Email or PhoneExample_Contact_RR_Reachable_ChannelVerify with a formulaWarning
50Reporting Line Stays Within the Customer AccountExample_Contact_RR_PhoneVerify with a formulaInfo
60Email Channel Has No Recorded BounceExample_Contact_RR_EmailVerify with a queryWarning
70Contact Owner Is ActiveExample_Contact_RR_Owner_ActiveVerify with a queryCritical
80A Task was completed in the last 60 daysExample_Contact_RR_Recent_EngagementVerify with a queryWarning

This Check Set reviews whether an Opportunity is reliable enough to forecast.

OrderCheck titleDeveloper NameEvaluation TypeFailure Severity
10Customer Account Is IdentifiedExample_Opportunity_DR_AccountVerify with a formulaCritical
20Deal Value Is EstablishedExample_Opportunity_DR_AmountVerify with a formulaCritical
30Close Date Is CurrentExample_Opportunity_DR_Close_DateVerify with a formulaWarning
40Next Step has non-placeholder textExample_Opportunity_DR_Next_StepVerify with a formulaWarning
50Win Probability Matches Deal StateExample_Opportunity_DR_ProbabilityVerify with a formulaInfo
60Opportunity Owner Is ActiveExample_Opportunity_DR_Owner_ActiveVerify with a queryCritical
70A Primary Buyer Contact Is IdentifiedExample_Opportunity_DR_Buyer_ContactVerify with a queryWarning
80A Task was completed in the last 30 daysExample_Opportunity_DR_Recent_ActivityVerify with a queryWarning

Open one of these Checks in Setup to see a working configuration of each technique. No example Check uses a Prerequisite Check or a Category.

TechniqueExample Check (Check Set)Read more
Apply a Check only when a formula is trueChannel partner governance is complete (Account Relationship & Risk)Applies To
Apply a Check only when a count query matchesOpen Opportunity Close Dates are in range (Account Check Builder Guide)Applies When (Count Query)
Show readable Found and Expected values on a Formula CheckAccount owner is active (Account Relationship & Risk)Formula Checks: Found and Expected
Decide what a query with no rows meansPass: Every open Case has a Contact; Fail: Contact Owner Is Active (Contact Relationship Readiness); Skip: Every escalated open Case has a Description; Unable to Check: Total proposal Amount matches total Product value. All others listed are in Account Check Builder GuideIf Query Finds No Records
Compare two listsSales and service share a Contact name (Lists overlap), Sales Contact names cover priority Case Contacts (Lists contain all), and Open Opportunity names match those with Products (Lists match exactly), all in Account Check Builder GuideCompare two queries: List mode
Find the record’s value in a listOpen-deal Contact Roles include Technical Buyer (Account Check Builder Guide), with List contains anyQuery Checks: Operators
Format a record value inside a messagePipeline protects the revenue base (Account Relationship & Risk): {!record.AnnualRevenue format="CURRENCY" fallback="Not available"} in Message When FailedFormat a field value
Show a ratio as a percentageWin Probability Matches Deal State (Opportunity Deal Readiness), with Display: Value Format set to Ratio as percentDisplay Found and Expected
Place a link inside the fix instructionsCustomer engagement is current (Account Relationship & Risk): {!link label="Open this account" href="/lightning/r/Account/{!record.Id}/view"} in Fix MessageInline links

Thirty-four example Checks insert result values into their text with {!rhcResult...} merge tokens in Display: Found Text, Display: Expected Text, or Message When Failed. For example:

  • No high-priority customer issues uses {!rhcResult.foundValue} and {!rhcResult.foundValuePluralSuffix} to show “1 open high-priority case” or “2 open high-priority cases.”
  • Contacts have email addresses shows how many Contacts are missing an email address with {!rhcResult.failedRecordCount}, how many were reviewed with {!rhcResult.totalRecordCount}, and the email of the second Contact the query returned with {!rhcQuery.sourceRows[1].Email fallback="email not available"}. Row numbers start at 0, so [1] is the second row. The Source Query ends with ORDER BY Id, so “second” always means the same Contact.
  • Most examples use {!record.Name fallback="this account"}, which shows the record name, or the fallback text when the user cannot read the name.

The merge syntax reference lists every token.

Two example Checks run the packaged Apex class AccountHasRecentActivityCheck:

  • Customer engagement is current passes when the Account has at least one activity in the last 60 days. Its Apex Parameters (JSON) value is {"daysBack": 60}.
  • Account activity meets the 60-day cadence passes when the Account has at least two activities in the last 60 days. Its value is {"daysBack": 60, "minimumActivities": 2}.

The class counts closed Tasks and all Events whose Related To field is the Account and whose activity date is on or after the start of the window. A Task related only to a Contact through the Name field does not count. daysBack accepts 1 to 3,650 and defaults to 30. minimumActivities accepts 1 to 1,000 and defaults to 1. A value outside those ranges makes the Check show Unable to Check.

Recent activity Apex example explains the class and how to test it.

What you seeWhat to do
No example appears in the Lightning App Builder Check Set listConfirm that the page is for Account, Contact, or Opportunity. The list shows only active Check Sets for the page’s object.
The card shows a setup messageConfirm that the selected Check Set’s Object matches the page’s object and that the user has Record Health Check Card User.
A row shows Unable to CheckConfirm that the user can read the objects and fields that Check uses.
A row shows System ErrorFollow Troubleshoot with the browser console.