Expire Fixed Non-Qualifying Points by Using Aggregated Expiration Ledgers

Use the Expire Fixed Non-Qualifying Points Using Aggregated Expiration Ledgers Data Processing Engine definition to expire members’ fixed-type, non-qualifying points. Run the definition to expire member points regardless of whether you’re consolidating member points in real time or in batches.

Required Editions

Available in: Lightning Experience in Enterprise, Performance, Developer, and Unlimited Editions that have Loyalty Management enabled

The definition uses the expiration date of the Loyalty Aggregated Point Expiration Ledger records to determine the number of fixed-model, non-qualifying points to expire. An input variable in the definition lets you specify the loyalty program that you require to expire points for. The definition aggregates expirable points whose expiration date is between the last run date and the current run date.

After calculating the number of points to expire from the members' point balances, the results are written back to these objects:

Object	Writeback Result
Loyalty Aggregated Point Expiration Ledger	Changes the status of the records that the current run expires points to Inactive.
Transaction Journal	Creates a unique record for each member whose points are expiring.
Loyalty Ledger	Creates Expiry type records to expire points from members' point balances. The records are associated with the members’ Transaction Journal records.
Loyalty Member Currency	Updates members' point balances after deducting the expired points.

Input Variables

Input Variable Name	Description
Loyalty Program Name	The name of the loyalty program for which the Data Processing Engine definition is run.
Last Run Date	The date when this Data Processing Engine definition was last run. This date helps determine the number of points that must be expired by a run. This date is updated in the Last Points Aggregation Date field of the Loyalty Member Currency records.

Nodes

Node Name	Node Type	Description
Loyalty Aggregated Point Expiration Ledger Loyalty Member Currency Loyalty Program Loyalty Program Currency	Data Source	Objects used as data sources to expire fixed-model non-qualifying points for members.
Add Loyalty Program Name to Program Currency	Join	Adds the loyalty program name to the loyalty program currencies.
Add Loyalty Program Details to Aggregated Point Expiration Ledgers	Join	Adds the name and ID of the loyalty program, and the currency type and expiration model of the loyalty program currency to the aggregated point expiration ledgers.
Filter Active Aggregated Point Expiration Ledgers	Filter	Filters active aggregated point expiration ledgers with fixed model non-qualifying points for the loyalty program.
Add Loyalty Member Currency Details to Active Aggregated Ledgers	Join	Adds the ID, last expiration process run date, points to expire, points balance, total points expired, and total points redeemed of the loyalty member currency to the active aggregated point expiration ledgers.
Get Active Aggregated Point Expiration Ledgers with Points to Expire	Formula	Identifies active aggregated point expiration ledgers that contain points to be considered for expiration.
Update Last Run Date	Formula	Validates if the last run date is a future date and corrects it by setting any future date to the current date.
Compare Points Expiry Date With Updated Run Date	Formula	Validates if the points expiry date is earlier than the updated last run date.
Filter Active Aggregated Point Expiration Ledgers with Points Yet to Expire	Filter	Filters active aggregated point expiration ledgers that contain points whose expiration date is on or before the run date.
Calculate Points to Expire from Aggregated Ledgers and Update Status	Formula	Calculates the number of points that must be expired from the aggregated point expiration ledgers and updates their status to Inactive.
Update Loyalty Aggregated Point Expiration Ledgers	Writeback Object	Updates the status of existing aggregated point expiration ledgers, for which points have expired, to Inactive.
Aggregate Points to Calculating Points for Expiry	Group and Aggregate	Aggregates the total ledger points, the points that must be expired, the points that have already expired, and the total points redeemed. These aggregated points help determine the number of points that must be expired.
Calculate Total Points That Can be Expired	Formula	Calculates the total number of points that can be expired.
Calculate Total Expired Points	Formula	Calculates the total number of points that have already expired. This node also determines other values that must be updated by a run.
Calculate Points to Expire	Formula	Calculates the total number of points that must be expired by a run.
Check Whether More Than Zero Points are to Expire	Filter	Checks whether one or more points must be expired by a run.
Create Loyalty Ledgers	Writeback Object	Creates loyalty ledgers to expire member’s fixed model non-qualifying points.
Create Transaction Journals	Writeback Object	Creates transaction journals to expire member’s fixed model non-qualifying points.
Update Loyalty Member Currency	Writeback Object	Updates loyalty member currencies with the total number of points that have expired and the total number of points that must be expired later based on their expiration date. The last expiration process run date is also updated.