Explore the installed example Check Sets
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.
Find the examples in Setup
Section titled “Find the examples in Setup”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 label | Developer Name | Object | Checks | When Checks Run |
|---|---|---|---|---|
| Example: Account Check Builder Guide | Example_ | Account | 25 active | When the user clicks Run |
| Example: Account Relationship & Risk | Example_ | Account | 8 active, 1 inactive | When the user clicks Run |
| Example: Contact Relationship Readiness | Example_ | Contact | 8 active | When the page opens |
| Example: Opportunity Deal Readiness | Example_ | Opportunity | 8 active | When 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.
Before you start
Section titled “Before you start”- Install Record Health Check. See Install Record Health Check in a sandbox.
- Assign Record Health Check Card User to the user who will test the card.
- Add the Record Health Check component to the record page for the example’s object, and select the example Check Set. See Configure the Lightning record-page component.
- Use sandbox records whose values you are allowed to change.
Step 1: Inspect an example in Setup
Section titled “Step 1: Inspect an example in Setup”- In Setup, enter
Custom Metadata Typesin Quick Find, then select Custom Metadata Types. - Next to Record Health Check Set, select Manage Records.
- Open Example: Account Relationship & Risk. Note its Object, Card Title, and When Checks Run values.
- Return to Custom Metadata Types. Next to Record Health Check, select Manage Records.
- Open Example: No High-Priority Issues. Confirm that Check Set is
Example_Account_Relationship_Risk. - 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.
Step 2: Run an example on a record
Section titled “Step 2: Run an example on a record”- Open an Account that you can edit in the sandbox.
- If the card shows Run, select it. The two Account examples wait for Run; the Contact and Opportunity examples run when the page opens.
- Confirm that the card shows a row for each active Check, not a setup message.
- 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.
- Select Rerun if the card does not run again by itself after the save.
- Confirm that No high-priority customer issues changes from Pass to Failed, and that Found shows the number of open high-priority Cases.
- Close or delete the test Case when you finish.
Checks in each example Check Set
Section titled “Checks in each example Check Set”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.
Example: Account Check Builder Guide
Section titled “Example: Account Check Builder Guide”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.
| Order | Check title | Developer Name | Evaluation Type | Failure Severity |
|---|---|---|---|---|
| 10 | Account Type is set | Example_ | Verify with a formula | Warning |
| 20 | Account has a phone number or website | Example_ | Verify with a formula | Warning |
| 30 | Billing address matches the parent bill-to account | Example_ | Verify with a formula | Info |
| 40 | High-priority open Cases stay within the limit | Example_ | Verify with a query | Critical |
| 50 | At least one open Opportunity is Commit | Example_ | Verify with a query | Info |
| 60 | Every open Case has a Contact | Example_ | Verify with a query | Critical |
| 70 | Every escalated open Case has a Description | Example_ | Verify with a query | Warning |
| 80 | Every open Opportunity has an active owner | Example_ | Verify with a query | Warning |
| 90 | No proposal has a missing or low Amount | Example_ | Verify with a query | Warning |
| 100 | Open Opportunities include a Decision Maker | Example_ | Verify with a query | Warning |
| 110 | Contacts on open deals have Email or Phone | Example_ | Verify with a query | Warning |
| 120 | Open-deal Contact Roles include Technical Buyer | Example_ | Verify with a query | Info |
| 130 | Cases closed keep pace with Cases created | Example_ | Verify with a query | Warning |
| 140 | Every won Opportunity has an Amount | Example_ | Compare two queries | Warning |
| 150 | Every proposal has a Next Step | Example_ | Compare two queries | Warning |
| 160 | Every proposal has a Primary Campaign Source | Example_ | Compare two queries | Critical |
| 170 | Open Opportunity Close Dates are in range | Example_ | Compare two queries | Info |
| 180 | Every open Opportunity has a Contact Role | Example_ | Compare two queries | Critical |
| 190 | Every won Opportunity has a primary Contact | Example_ | Compare two queries | Warning |
| 200 | New pipeline value covers recently lost value | Example_ | Compare two queries | Critical |
| 210 | Total proposal Amount matches total Product value | Example_ | Compare two queries | Warning |
| 220 | Sales and service share a Contact name | Example_ | Compare two queries | Warning |
| 230 | Sales Contact names cover priority Case Contacts | Example_ | Compare two queries | Warning |
| 240 | Open Opportunity names match those with Products | Example_ | Compare two queries | Warning |
| 250 | Account activity meets the 60-day cadence | Example_ | Verify with Apex | Warning |
Account Check Builder Guide: configuration and results shows the formula, queries, and settings of every Check in this set.
Example: Account Relationship & Risk
Section titled “Example: Account Relationship & Risk”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.
| Order | Check title | Developer Name | Evaluation Type | Failure Severity |
|---|---|---|---|---|
| 10 | Executive sponsorship is established | Example_ | Verify with a query | Warning |
| 20 | Account owner is active | Example_ | Verify with a formula | Critical |
| 25 | Industry aligns with parent account | Example_ | Verify with a formula | Info |
| 25 | Open deals have customer contacts | Example_ | Compare two queries | Warning |
| 30 | Contacts have email addresses | Example_ | Verify with a query | Warning |
| 40 | Customer engagement is current | Example_ | Verify with Apex | Warning |
| 50 | Pipeline protects the revenue base | Example_ | Verify with a query | Info |
| 60 | No high-priority customer issues | Example_ | Verify with a query | Critical |
| 90 | Channel partner governance is complete | Example_ | Verify with a query | Warning |
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.
Example: Contact Relationship Readiness
Section titled “Example: Contact Relationship Readiness”This Check Set reviews whether a Contact is ready for relationship work.
| Order | Check title | Developer Name | Evaluation Type | Failure Severity |
|---|---|---|---|---|
| 10 | Account Relationship Is Established | Example_ | Verify with a formula | Critical |
| 20 | Relationship Role Has Business Context | Example_ | Verify with a formula | Info |
| 30 | Business Location Has Regional Context | Example_ | Verify with a formula | Info |
| 40 | Contact has Email or Phone | Example_ | Verify with a formula | Warning |
| 50 | Reporting Line Stays Within the Customer Account | Example_ | Verify with a formula | Info |
| 60 | Email Channel Has No Recorded Bounce | Example_ | Verify with a query | Warning |
| 70 | Contact Owner Is Active | Example_ | Verify with a query | Critical |
| 80 | A Task was completed in the last 60 days | Example_ | Verify with a query | Warning |
Example: Opportunity Deal Readiness
Section titled “Example: Opportunity Deal Readiness”This Check Set reviews whether an Opportunity is reliable enough to forecast.
| Order | Check title | Developer Name | Evaluation Type | Failure Severity |
|---|---|---|---|---|
| 10 | Customer Account Is Identified | Example_ | Verify with a formula | Critical |
| 20 | Deal Value Is Established | Example_ | Verify with a formula | Critical |
| 30 | Close Date Is Current | Example_ | Verify with a formula | Warning |
| 40 | Next Step has non-placeholder text | Example_ | Verify with a formula | Warning |
| 50 | Win Probability Matches Deal State | Example_ | Verify with a formula | Info |
| 60 | Opportunity Owner Is Active | Example_ | Verify with a query | Critical |
| 70 | A Primary Buyer Contact Is Identified | Example_ | Verify with a query | Warning |
| 80 | A Task was completed in the last 30 days | Example_ | Verify with a query | Warning |
Techniques the examples demonstrate
Section titled “Techniques the examples demonstrate”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.
| Technique | Example Check (Check Set) | Read more |
|---|---|---|
| Apply a Check only when a formula is true | Channel partner governance is complete (Account Relationship & Risk) | Applies To |
| Apply a Check only when a count query matches | Open Opportunity Close Dates are in range (Account Check Builder Guide) | Applies When (Count Query) |
| Show readable Found and Expected values on a Formula Check | Account owner is active (Account Relationship & Risk) | Formula Checks: Found and Expected |
| Decide what a query with no rows means | Pass: 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 Guide | If Query Finds No Records |
| Compare two lists | Sales 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 Guide | Compare two queries: List mode |
| Find the record’s value in a list | Open-deal Contact Roles include Technical Buyer (Account Check Builder Guide), with List contains any | Query Checks: Operators |
| Format a record value inside a message | Pipeline protects the revenue base (Account Relationship & Risk): {!record. in Message When Failed | Format a field value |
| Show a ratio as a percentage | Win Probability Matches Deal State (Opportunity Deal Readiness), with Display: Value Format set to Ratio as percent | Display Found and Expected |
| Place a link inside the fix instructions | Customer engagement is current (Account Relationship & Risk): {!link label="Open this account" href="/lightning/r/Account/{!record. in Fix Message | Inline links |
Result values in messages
Section titled “Result values in messages”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 withORDER 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.
Apex Checks
Section titled “Apex Checks”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.
Resolve common problems
Section titled “Resolve common problems”| What you see | What to do |
|---|---|
| No example appears in the Lightning App Builder Check Set list | Confirm 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 message | Confirm 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 Check | Confirm that the user can read the objects and fields that Check uses. |
| A row shows System Error | Follow Troubleshoot with the browser console. |