Overview
The Payments2Us Health Check feature helps you scan for common setup and configuration issues with the Payments2Us App in your org. It identifies potential problems (for example, “merchant facility license is expiring” or “site user is missing permissions”), assigns each a priority level, and links directly to the relevant help article to guide you in resolving them.
How it works:
The Health Check scan runs a set of automated workflows, and the results are organized into three custom objects:
- Payments2Us Health Check: The parent record representing the full Health Check scan run.
- Payments2Us Health Check Item: It is a related list under the Payments2Us Health Check, containing each of the identified issue types in the health check scan.
- Payments2Us Health Check Item Occurrences: It is a related list under the Payments2Us Health Check Item, containing all the occurrences of the issue types.
Example: If three of your five Merchant Facility licenses are nearing expiry, the Health Check logs one “License Expiring” item and “three occurrences”, one for each merchant facility with their respective details.
Health Check processor chain
When a scan runs, three batch processors execute one after another:
- Merchant Facility Processor: Checks all Merchant Facilities (Payment Settings), site setup, site user permissions, and sharing rules.
- User Permission Processor: Checks internal Salesforce users who have created Payment Txns in the last 6 months.
- Workflows Processor: Checks legacy workflow vs Flow migration status for Payments2Us workflows.
When all three complete, the Health Check status is updated to Generation Complete, and a completion email is sent to the user who started the scan.
When Health Check Runs
Health Check can be started in two ways:
Manual run (on demand)
- From the Payments2Us Health Checks tab → New Health Check → Proceed (Detailed process added below)
Automatic run (scheduled)
Health Check may also start automatically:
- Monthly schedule: When triggered, the next run is scheduled for a random time on the 1st day of the following month (to spread load across customer orgs).
-
Batch Processor chain: After the Batch Processor and Payment Status Check Processor finish, Health Check may be initiated:
- Scheduled Batch Processor runs: Payment Status Check runs approximately every 3 hours; Health Check follows when that chain completes.
- Batch Processor Run Now: Payment Status Check and Health Check always run immediately after the batch finishes (not limited to the 3-hour window).
Automatic Health Check only runs when:
- Batch resources are available
- No Health Check is already scheduled or running
- The org is production (not a sandbox)
Stopping Health Check
When the Batch Processor is stopped from the Batch Status page, any waiting or paused Health Check scheduled jobs are also aborted. This helps avoid background jobs conflicting with Apex code updates.
Required Permissions
The Health Check scan can only be performed by users assigned to either of these permission sets:
- Payments2Us Admin Users
- Payments2Us Finance Users
1. Perform a New Manual Health Check
- Open the Payments2Us App.
- Go to the Payments2Us Health Checks Tab.
- Click the New Health Check button.
It opens the Payments2Us Health Check processor page.
- Click Proceed to initiate the Health Check process.
A new Health Check record with status “Generation Running” is created. The Health Check scan runs in the background across three batch processors (Merchant Facility → User Permissions → Workflows) and may take a few minutes to complete.
When finished, the status changes to “Generation Complete”, and you receive a completion email.
2. Schedule a Manual Health Check
- Open the Payments2Us app.
- Open your Merchant Facility (Payment Setting) record, usually the primary active facility.
- Find Batch Payments Processor Status.
- If status is Stopped, click Start.
- Leave the batch processor Started if you want automatic health checks to stay scheduled.
- In production orgs only, the system will:
- Schedule a monthly health check job, and
- May start a health check soon after batch processing runs (including after Run Now on the batch processor, when that path runs).
- When a run finishes, open the Payments2Us Health Checks tab to see the new Health Check record and any issues.
- You will also receive an email when a run completes.
3. Review Health Check Results
Once the scan completes, the status of the Payments2Us Health Check record changes to “Generation Complete”. This indicates that the health check process has been finished and all the detected issues (if any) are listed under the Payments2Us Health Check Items related list.
If batch resources were unavailable during processing, the status may show Generation Failed; wait until fewer batch jobs are running and start a new Health Check.
4. Review Health Check Items
Click into the individual Health Check Item to see the identified issue type details:
(6) A short Issue Note explaining the problem.
(7) A direct Help Article Link with instructions to resolve it.
(8) The related list of Health Check Item Occurrences, which show each affected record.
5. Review Health Check Item Occurrences
Each occurrence record provides details for the particular issue:
(9) A lookup to the specific record the issue is associated with (for example, the Merchant Facility or Sharing rules).
(10) A short Issue Note explaining the problem.
(11) A short Issue Description highlighting what needs attention.
6. Take Action to Solve The Issues
After reviewing the issues:
- Follow the help article linked within the Issue Note to fix each problem.
- Once resolved, update the occurrence record status to Closed to mark it complete.
Pro Tip
Run the Health Check scan regularly, especially after:
- Payments2Us upgrades (particularly 11.6 sharing settings changes)
- Merchant Facility or Force.com Site configuration changes
- New payment gateway setup
- Permission set or profile changes
- Workflow-to-Flow migration work
Running a Health Check after these changes helps you catch setup issues before they affect online payments or site access.