Customizing Financial Checkpoints
Table of Contents
Learn more about the exciting new feature rolled out in HomeKeeper Version 2.10: Financial Checkpoints One of the most common requests has been the ability to track Household Income over time. This functionality also includes common financial metrics that are evaluated during the Mortgage Readiness Evaluation process - Credit Score, Total Assets, Total Debts, Total Monthly Debt Obligations, Debt Ratios, and AMI%. We've also designed this to allow for further customization, so if your organization wants to track different metrics, you can build upon this foundation using the steps below!
Customizing the "Checkpoints Type" Field
Checkpoint Types represent key milestones when programs might update financials. These were designed to match your program's workflow. While you can add more, these can serve as a blueprint for how often—and at what "checkpoint"—you should conduct them.
"Out-of-the-box," Financial Checkpoint Type has the following picklist values:
- At Intake
- Interim
- At Purchase
- At Resale
- At Annual Recertification
- Final
NOTE: Generally, you should not have a checkpoint with the same date. Financial metrics are taken at a point in time, and Financial Checkpoints are intended to chart changes. As such, there should be some time in between checkpoints.
How to Add and Remove "Checkpoint Type" Field Values
First, navigate to the Object Manager for the Financial Checkpoints Object.
- Click "Setup" then select the "Object Manager" tab
- Search the Objects for "Financial Checkpoint" and select it from the list
Then, from the Object Manager for Financial Checkpoints, find the Checkpoint Type Field
- Select "Fields and Relationships"
- Search for "Checkpoint Type" and select it from the list
Then, you can edit values.
-
Scroll down to the "Values" section to make your changes.
- To add new values, click "New" and add desired values (one per line, with no spaces or punctuation).
- Remove unwanted values by clicking "Deactivate."
- Click "Reorder" to put them in the desired order.
Customizing Financial Checkpoint Fields
Adding Custom Fields to Financial Checkpoints
WARNING: This section is for intermediate Salesforce Admins, as it involves editing Flows and understanding how to troubleshoot any issues in Flows. If you're not familiar with Flows, contact HomeKeeper support for some guidance and potential referral to one of our Alliance Partners for consultation.
Want to learn how to use Flow? Click here for a training from Salesforce!
First, you must create a field in the Financial Checkpoint Object to match the existing Service File field you want to add.
- Identify the Service File field you want to track (Occupation, Household Size, etc.). Note the Field Type (Numeric, Text, Percentage) and any restrictions (# of characters, validation rules).
- Then, navigate to the Financial Checkpoints Object Manager page.
- Click "Setup" then select the "Object Manager" tab
- Search the Objects for "Financial Checkpoint" and select it from the list
- Select "Fields and Relationships" and click "New." Then, select the same "Field Type" as the field you're hoping to add. Click next.
-
Enter the Field Name and characteristics (try to match the Service File field name exactly).
- It's critical that you use the same Field Type, and that the new field is subject to at least the same minimum restrictions (it's OK for the Financial Checkpoints field to have more characters than the Service File field).
- Then, select the desired Field-Level Security for your Profiles, add it to the layout for Financial Checkpoints, and click "Save."
Create a new version of the "Financial Checkpoint - Metrics" Auto-launched Flow and add your field to the new flow.
- Navigate to "Flows" in Setup and click into the existing flow named "Financial Checkpoint - Metrics." Click "Save As New Flow" to create a copy.
- In the newly created flow, edit the Update Records component by double-clicking the component
- Scroll down to find "Add Field" to add another. In the same manner as the others, you will select the Financial Checkpoint "Field" and the associated Service File "Value"
After you are satisfied with your new Flow, deactivate HomeKeeper's original managed flow, and activate your new flow.
- Click on "Financial Checkpoint - Metrics" and click "Deactivate"
- Click into your new flow and click "Activate"
Add Financial Checkpoints to your Custom Lightning Pages
If you have chosen not to use the Lightning pages provided with HomeKeeper and have decided to create your own, we have provided components that you can integrate into your pages to leverage the Financial Checkpoints functionality.
- From the Service File Object Manager, navigate to Lightning Record Pages, and select the one you would like to edit
- On the Lightning record page edit screen, find the Flow component and drag and drop it where you want it to appear. You can put it within a tab or accordion, embedded within that interface:
- Once added, you will find Financial Checkpoint - Create New FC Screen Flow to assign to the component.
- Finally, make sure the Pass record ID in this variable box is checked - this is required for the screen flow to work. Designate this Service File for the Financial Checkpoint that's created.
Financial Checkpoints Components
Here's a list of components included related to Financial Checkpoints:
- Financial Checkpoints Object
- Financial Checkpoint Fields
- Financial Checkpoints Name (screen flow updates to Financial Checkpoint Type + " " + Financial Checkpoint Date
- Financial Checkpoint Type (can customize to add more options)
- Financial Checkpoint Date
- Annual Household Income
- Annual Income (Eligibility)
- Total Assets
- Applicant Credit Score
- Total Debts
- Total Monthly Debt Obligations
- Actual Debt Ratio
- AMI % (Gross)
- AMI % (Eligibility)
- Service File Fields
- Baseline Financial Checkpoint
- Current Financial Checkpoint
- Change in Income
- Change in Assets
- Change in Debts
- Change in Credit Score
- Action Button: "Create Financial Checkpoint" - Launches Screen Flow "Financial Checkpoint - Create New FC Screen Flow"
- Action Layout - All Service File fields added, for usage with Lightning Pages
- Screen Flow Template: "Financial Checkpoint - Create New FC Screen Flow"
- Includes Screen Flow layout, Auto-naming of Financial Checkpoint
- Screen Flow Template: "Financial Checkpoint - Create New FC"
- Includes all field mappings from Service File to Financial Checkpoint metrics
- Deactivate and "Save As" this template to add more field mappings, if you add more fields.
- Apex Class: FinancialCheckpointTriggerUtility
- Controls automated assignment of Financial Checkpoint to Baseline and/or Current, on create, edit, delete. Automatically assigns "earliest" Checkpoint to Baseline and "latest" Checkpoint to Current. Tiebreaker of Created Date if multiple checkpoints with the same date
- Custom Report Type: "Service File with Financial Checkpoint Metrics"
- Standard Service File Report Type with fields from Baseline and Current Checkpoint lookup relationships
- Report: Financial Checkpoints by Service File
- All Financial Checkpoint records grouped by Service File Name