- Print
- PDF
Configuring Workflow for Settlement Offers in VA 2.0
This guide provides detailed instructions for configuring and managing settlement offers using the Bundle Settlement Offer Amount, Bundle Settlement Offer Expiration Date, and Bundle Settlement Offer Max Payments fields. These enhancements allow businesses to present consumers with time-limited settlement offers via VA 2.0.
Populating the Bundle Settlement Offer Fields
Agencies can populate these fields using two methods:
ETL Import: Agencies can calculate and populate the Bundle Settlement Offer fields by exporting account data, modifying it, and reloading it through the ETL process.
Action Path: Agencies can design workflows that use flow actions and JavaScript to calculate and set the Bundle Settlement Offer fields dynamically.
For more information on Bundle Settlement Offer Fields view: VA 2.0 Bundle Settlement Offer
Step Overview:
To set up and manage settlement offers, follow these steps. The guide includes common steps for configuring workflows and additional steps specific to the bundle field population method you choose: ETL Import or Action Path.
Common Steps for Both ETL Import and Action Path
Define Eligible Accounts: Create a logic block to identify accounts that meet settlement offer criteria.
Populate Bundle Settlement Fields: Use ETL Import or Action Path methods described below.
Create Communication Logic Blocks:
Active Settlement Offers: Identify accounts with active, non-expired settlement offers.
Send Settlement Offer Text Message: Define accounts eligible for text communications.
Send Settlement Offer Email: Define accounts eligible for email communications.
Create Communication Profiles: Configure Text and Email profiles for managing settlement offer communications.
Enable Settlement Offer in VA 2.0: Activate the Use Bundle Settlement Offer Amount feature in Virtual Agent settings.
Create Action Path Workflow: Build the workflow to send text and email communications based on logic conditions.
Create and Schedule the Job: Set up a job to execute workflows, using logic blocks and action paths.
Additional Steps Based on Population Method
ETL Import: Export, modify, and reload settlement offer data via the ETL process.
Action Path: Use flow actions and JavaScript to dynamically calculate and set settlement offer fields within workflows.
Option One: Populating Bundle Settlement Fields via ETL Import
Step 1: Creating the “Eligible Accounts for Bundle Settlement Offer” Logic Block
Before configuring workflows or ETL layouts, create a Logic Block to identify eligible accounts for settlement offers.
Navigate to Setup → Workflow → Logic Blocks, New
Enter the following details:
Label: Eligible Accounts for Bundle Settlement Offer
Description: Identifies accounts eligible for settlement offers based on defined criteria.
Return Primary Accounts Only: enable
Define the logic for account eligibility (e.g., agency number, account balance thresholds, assigned date, etc.).
Test the Logic Block and adjust if necessary.
Save the Logic Block.
Step 2: Download and Modify the CSV File
Download:
Run the logic block and export the results as a CSV file.
Modify:
Open the file in a spreadsheet editor.
Add these columns:
Bundle Settlement Offer Amount
Bundle Settlement Offer Expiration Date
Bundle Settlement Offer Max Payments
Populate values for each account.
Example Formula: =A2 * 0.75 for 75% of the current balance.
Date Format: MM/DD/YYYY (e.g., 06/01/2025).
Max Payments: Enter the maximum allowed payments (e.g., 6).
Save the file as CSV.
Step 3: Create an ETL Profile
Use the modified CSV file to create an ETL profile for importing settlement offer data.
Navigate to Accounts → ETL Import → Profiles → New.
Upload the CSV File.
Configure the ETL profile:
Label: Provide a name (e.g., Bundle Settlement Offer Import).
Load Method: Select Account Updates.
File Format:
Choose the CSV file format.
Verify the delimiter (comma) and quote character settings.
Map the fields in your CSV file to the corresponding ACE fields:
Agency #
Bundle Settlement Offer Amount
Bundle Settlement Offer Expiration Date
Bundle Settlement Offer Max Payments
Click Load.
Save the ETL profile for future use.
Please Note:
Customers can save the ETL profile and add it to a job for automated execution.
Step 4: Configuring the ETL Job Task:
Navigate to: Setup → Jobs → New Job.
Label: Bundle Settlement Offer Import
Add a Job Task with the following details:
Task Type: ETL: Engine
Description: Extracts, transforms, and loads files matching the mask.
Input File Folder: Specify the folder containing the CSV files.
ETL Profile: Select the saved ETL profile (e.g., Bundle Settlement Offer Import).
Mask: Define the file mask for matching files (e.g., settlement_offer.csv).
Mark File as New: Enable this option to process new files only.
Processed File Folder: Specify the folder for processed files (optional).
Active: Ensure the job task is active.
Save the job task.
Schedule the job to run on demand.
Option 2: Populating Bundle Settlement Fields via Action Path
Step 1: Define Eligible Accounts
Create the Logic Block as described in Option 1.
Step 2: Configure the Action Path
Navigate to Setup → Workflow → Action Paths and create a new Action Path.
Provide the following details:
Label: Set Bundle Settlement Offer Fields.
Description: Workflow for configuring settlement offer fields.
Add Flow Actions:
Label: Javascript Calculate Bundle Settlement Offer Amount
Class Name: Javascript
Script: The script calculates a settlement offer amount for a debt account as a percentage of the current balance and assigns the value to the settlement offer field. It then saves the updated debt record. You can customize the settlementPercentage to apply different discount rates for various accounts.
var bundle = new Bundle(debt.bundleID); var currentBalance = bundle.currentBalance.doubleValue(); var settlementPercentage = 0.50; // 50% var settlementAmount = currentBalance * settlementPercentage; debt.bundleSettlementOfferAmount = new Currency(settlementAmount); debt.saveAfterActions = true;
Set Account Fields:
Bundle Settlement Offer Expiration Date: Format the date as MM/DD/YYYY.
Bundle Settlement Offer Max Payments: Enter the maximum number of payments allowed (e.g., 6).
Save the Action Path.
Step 3: Create the Job
Name the job: Set Bundle Settlement Offer Fields.
Add the following tasks:
Job Task: Action Path Workflow.
Use Logic Block: Eligible Accounts for Bundle Settlement Offer.
Use Action Path: Set Bundle Settlement Offer Fields.
Run the job to populate the settlement fields.
Remaining Steps for Both Methods
Step 4: Create Consumer Communications
There are two options available to direct consumers to the VA 2.0 Settlement Page. When configuring templates, ensure you select the appropriate parameter based on the communication method to maintain smooth delivery and compatibility with communication standards.
For Email Communications:
Use: ${debt.virtualAgentLoginUrl}?vaRef=SETTLEMENT
This parameter directs consumers to the Settlement page within VA 2.0 and is commonly used in email templates.
For Text Message Communications:
Use: ${debt.virtualAgentLoginUrl}?vaRef=STM
This parameter also directs consumers to the Settlement page and is designed for optimal delivery in text messages.
Step 5: Configuring the Virtual Agent Profile
To display the settlement offer in VA 2.0, configure the associated Virtual Agent profile.
Navigate to Setup → Virtual Agent → Profiles.
Locate the Settlement Options section.
Enable Allow Settlements.
Enable Use Bundle Settlement Offer Amount.
Save the profile.
Please Note: If the Client Settlement configuration does not allow settlement, the consumer will not be able to to receive the settlement offers.
Step 6: Create “Active Bundle Settlement Offer Accounts” Logic Block
Create a Logic Block to identify accounts with active settlement offers that are not expired.
This logic block will be used in the job task for action path workflow being used to schedule communications for this offer.
Navigate to Setup → Workflow → Logic Blocks, New
Enter the following details:
Label: Active Bundle Settlement Offer Accounts
Add Field: Define the logic for account eligibility (e.g., account status New/Active).
Add Custom From: BUNDLE
Add Custom SQL
bundle.settlement_offer_expiration_date >= CURRENT_DATE + 3
Test the Logic Block to verify it identifies the correct accounts.
Adjust the logic if necessary.
Save the Logic Block.
Purpose of the Custom SQL:
By applying a buffer (CURRENT_DATE + 3), this logic ensures consumers receive messages with enough time to review and act on the settlement offer before it expires.
Agencies can adjust the buffer (e.g., increasing or decreasing the number of days) based on their operational needs or communication strategies.
Step 7: Create Communication Logic Blocks
Logic Block 1: Send Settlement Offer Text Message
Purpose:
This logic ensures that text messages are sent only to eligible and active consumers who have opted in for communication. Agencies can customize the logic to adjust contact prioritization or inclusion criteria as needed.
Custom From: demographic_phone
Custom SQL
AND demographic_phone.txt_msg_status = 'OPTED_IN'
AND demographic_phone.active IS true
AND demographic_phone.demographic_phone_id = (
SELECT demographic_phone_id
FROM demographic_phone da, bundle
WHERE bundle.primary_debt_id = da.debt_id
AND bundle.bundle_id = debt.bundle_id
AND da.demographic_type = 'PRIMARY'
ORDER BY da.contact_priority, da.last_update DESC
LIMIT 1
)
Logic Block 2: Send Settlement Offer Email
Purpose:
This logic ensures that email messages are sent only to eligible and active consumers who have opted in for communication. Agencies can customize the logic to adjust contact prioritization or inclusion criteria as needed.
Custom From: demographic_email
Custom SQL:
AND demographic_email.els_status = 'OPTED_IN'
AND demographic_email.active IS true
AND demographic_email.demographic_email_id = (
SELECT demographic_email_id
FROM demographic_email da, bundle
WHERE bundle.primary_debt_id = da.debt_id
AND bundle.bundle_id = debt.bundle_id
AND da.demographic_type = 'PRIMARY'
ORDER BY da.contact_priority, da.last_update DESC
LIMIT 1
)
Step 8: Create Action Path Workflow
Action Path Name: Settlement Offer Communication Workflow.
Add Flow Actions: Add Logic Condition for Text Messages:
Logic Block: Send Settlement Offer Text Message.
True: Add an action to send text messages.
Label: Send Text Message = Settlement Offer.
Class Name: Send Text Message.
Text Message Profile: Settlement Offer Text Message.
Add Logic Condition for Email Messages:
Logic Block: Send Settlement Offer Email.
True: Add an action to send emails.
Label: Send Email = Settlement Offer.
Class Name: Send Email Message.
Email Message Profile: SETTLEMENT_OFFER_EMAIL.
Save the workflow.
Step 9: Create the Job
Job Name: Process Bundle Settlement Offer Workflow.
Add the following task:
Job Task: Action Path Workflow.
Use Logic Block: Active Bundle Settlement Offer Accounts.
Use Action Path: Settlement Offer Communication Workflow.
Schedule: On Demand (This ensures the task is not triggered daily, preventing overcommunication. Run the job only once to maintain appropriate communication frequency.)
Save the job.