Rule Action Reference¶

Lookup Member¶

Description

The action resolves the member for the current activity and populates the execution context with member details. Since it is typically the first action in a flow, it also performs duplicate-activity detection on activity.externalTxnId.

Parameters

None. Uses the current activity context.

JavaScript API

UDF.populateMember(callback)

Outputs

Populates the Context with:

• member — the resolved member object.
• loyaltyIds — array of loyalty IDs associated with the member.
• activity.memberID — set if the member was resolved by loyalty ID.
• activity.originalMemberID — original member ID (pre-merge if ?resolveMerge=true).
• activity.loyaltyID — defaulted to the primary or default-card-type loyalty ID when the activity didn't supply one.
• duplicateAct — set on the context when a prior Processed activity with the same externalTxnId is found on the same member (used downstream).

Events Triggered

No events are generated by this action.

Possible Errors

Additional Considerations

• Lookup sequence:
  1. If activity.memberID is set, the member is fetched by _id.
  2. Otherwise, the loyalty ID is looked up via the LoyaltyID model and the resulting memberId is used.
  3. If still not resolved and the activity has a loyalty ID, an anonymous member is created and auto-enrolled into the program (subject to program settings and optional loyalty-card validation).
• When a loyalty code has accrueTo set and the activity is an Accrual, the resolved member is replaced by the accrueTo target.
• If the resolved member is missing purses defined by the program, they are added before the member is returned.
• When the activity URL includes ?resolveMerge=true, merged-away members are resolved to their survivor.
• Duplicate-activity detection checks both the member's current activities and ActivityHistory; for matches without an embedded result.log, it pulls the log from Elasticsearch (unless program.enrollSettings.disableEsLogsLookUp is set).

Lookup Peer Member¶

Description

Loads a peer member into the engine execution context using LoyaltyID or MemberID. Sets Context.peer for use by subsequent actions.

What is a Peer Member?

A peer member is another member within the same loyalty program who can be identified and loaded during an activity transaction to perform point operations on their account.

When processing an activity for one member, you can look up a peer member using their Loyalty ID or Member ID, and then add or redeem points on the peer member's account.

Parameters

JavaScript API

UDF.populatePeer(value, callback)

Outputs

The action populates Context.peer with the peer member object returned from the member lookup service.

Events Triggered

No events are generated by this action.

Possible Errors

Additional Considerations

• The peer is only stored on Context.peer; it doesn't affect the primary activity or member objects.
• Loading the peer alone does not persist any changes to it. A subsequent peer action (such as Add Points To Peer or Redeem Points From Peer) is required to write changes back.
• This action is typically followed by Add Points To Peer or Redeem Points From Peer.

Lookup Account Members¶

Description

The action looks up the Account that contains the context member and populates all of its other members (linked members) into the execution context. Only members in the same program are included.

Parameters

None. Uses the current member context.

JavaScript API

UDF.populateAccountMembers(callback)

Outputs

Populates Context.linkedAccount with the matched account plus:

• members — array of linked member objects from the same program (excluding the context member). If the member belongs to no account, this is an empty array.

Linked members are made available for reuse by later actions in the same flow.

Events Triggered

No events are generated by this action.

Possible Errors

Other errors are propagated from the underlying storage layer.

Additional Considerations

• The action is a no-op if Context.linkedAccount is already populated.
• If any linked member is missing purses defined by the program, they are added before the member is returned.
• Tier display names are translated on linked members when the program's tier-name translation setting is enabled.

Lookup Member Aggregates¶

Description

The action is used to lookup and populate aggregate metrics for the member across different time periods.

Parameters

JavaScript API

UDF.populateMemberAggregates(aggregates, types, fromDate, toDate, callback)

Outputs

Populates the Context with one collection per requested aggregate type:

• Context.dailyAggs, Context.weeklyAggs, Context.monthlyAggs, Context.quarterlyAggs, Context.halfYearlyAggs, Context.yearlyAggs, Context.lifetimeAggs.

Each entry includes metricName, metricAggValue, memberId, lastAggDate, the period field(s) for that bucket, and a resolved policyId (from a matching AggregatePolicy or PursePolicy in the same program when one exists). Transient member aggregates are merged on top of database results.

Events Triggered

No events are generated by this action.

Possible Errors

Additional Considerations

• Supports multiple aggregate types: daily, weekly, monthly, quarterly, half-yearly, yearly, lifetime
• Supports regex patterns for aggregate names.
• Regex has a limit of 100 characters.
• Validates date ranges against current activity date
• Returns empty results if no aggregates found
• All dates are adjusted for timezone offset from program settings (default time zone)

Populate Aggregates¶

Description

Loads the value of a single metric across one or more aggregate period types and writes them onto the context, keyed by metric name. This differs from Lookup Member Aggregates, which queries multiple metrics across a date range and returns arrays of aggregate documents.

Parameters

JavaScript API

UDF.populateAggregates(metricName, types, callback)

Outputs

Populates two objects on the context, keyed first by metricName, then by period type:

• Context.populatedMemAggs[metricName][<type>] — the member-scoped aggregate value for each requested type.
• Context.populatedAggs[metricName][<type>] — the global aggregate value for each requested type (when one exists).

If the member has a transient (in-memory) aggregate value for a type, that value is used in preference to the stored one.

Events Triggered

No events are generated by this action.

Possible Errors

Additional Considerations

• The activity date is shifted by the program's enrollSettings.aggregateOffsetTZ before computing the period buckets (day/week/month/quarter/half-year/year), so values align with the program's reporting timezone.
• Use this action when a rule needs to check a single metric's value at multiple roll-ups (for example, comparing daily spend vs. lifetime spend in one condition). Use Lookup Member Aggregates when you need to scan many metrics or filter by a date range.

Update Member Aggregate¶

Description

The action is used to update a member's aggregate value for a given policy.

Parameters

JavaScript API

UDF.updateMemberAggregate(policyId, aggregateName, value, aggregateDate, expirationDate, callback)

Outputs

Updates member's aggregate values in Context.aggregates.

Events Triggered

No events are generated by this action.

Possible Errors

Additional Considerations

• If value is 0 the action is a no-op (returns an empty array).
• When policyId is Variable, both aggregateName and value are validated; otherwise only value is validated.
• The aggregateDate defaults to the activity's UTC date when omitted.
• The action appends to (or updates an existing entry in) Context.aggregates. When the aggregate types include lifetime, the policy's expirationDate is used as the default expiration unless overridden.
• If program.enrollSettings.raiseMetricEventPerInstance is true, every call produces a new aggregate entry; otherwise repeat calls for the same policy on the same member sum into the existing entry.
• Divisions on the new aggregate record default to the policy's divisions (unless the Aggregate division-update skip flag is set).

Lookup Member Loyalty IDs¶

Description

The action is used to lookup and populate loyalty IDs associated with the current member.

Parameters

None. Uses the current member context.

JavaScript API

UDF.populateMemberLoyaltyIds(callback)

Outputs

Populates Context.member.loyaltyIds with an array of loyalty ID objects.

Events Triggered

No events are generated by this action.

Possible Errors

No errors are thrown directly by this action. Any errors that occur are database errors propagated from the underlying MongoDB operations.

Additional Considerations

• Returns early (no-op) if no member is found in context.
• Returns an empty array if the member has no loyalty IDs.
• If Context.member.loyaltyIds is already populated (for example, by Lookup Member), the database results are concatenated onto the existing array — duplicates are not deduplicated by this action.

Lookup Merge Victims¶

Description

The action is used to find all members that were merged into the current member (victims of merge operations).

Parameters

JavaScript API

UDF.populateMergeVictims(memberIds, callback)

Outputs

Populates Context.mergeVictim.members with an array of victim member objects.

Events Triggered

No events are generated by this action.

Possible Errors

No errors are thrown directly by this action. Any errors that occur are database errors propagated from the underlying MongoDB operations.

Additional Considerations

• The action is a no-op (logs a warning and returns) if no context member is set.
• If memberIds is supplied (string or array) and any entry isn't a valid ObjectId, the action logs a warning and skips — it does not throw.
• Only the merge-victim members associated with the current context member are returned.
• Context.mergeVictim is only set when at least one victim is found; otherwise it remains unset.

Add Division¶

Description

Adds a division to a member's profile. This action enables you to associate a member with a specific division within the program.

Parameters

JavaScript API

UDF.addDivision(divisionId, divisionName, callback)

Outputs

Adds the division to the member. The member and activity are updated when the rule flow completes.

Events Triggered

No events are generated by this action.

Possible Errors

Additional Considerations

• The division must exist in the Division collection.
• The division must be one of the program's configured divisions.
• If the member already belongs to the division, the action is a no-op (no save).
• The action does not check a permission for adding divisions (only removal goes through the Member.Divisions.Remove ACL check).

Remove Division¶

Description

Removes a division from a member's profile. This action disassociates a member from a specific division within the program.

Parameters

JavaScript API

UDF.removeDivision(divisionId, divisionName, callback)

Outputs

Removes the division from the member. The member and activity are updated when the rule flow completes, even if the member did not have the division (the action still marks both as dirty).

Events Triggered

No events are generated by this action.

Possible Errors

Additional Considerations

• The division must exist in the Division collection.
• The user must have delete permission on Member.Divisions.Remove (ACL-enforced).
• Unlike Add Division, this action does not require the division to be in the program's divisions list.
• If the member doesn't currently have the division, the action still resolves the division and writes a (functionally unchanged) divisions array; no error is raised.

Add Points¶

Description

The action is used to accrue points to a purse, to reward some activity posted for the member. The action allows setting the purse, points expiration date, escrow date and specifying the accounting type of the points.

Parameters

Outputs

None

JavaScript API

UDF.addPoints(policyId, purseName, points, accountingType, expirationDate, escrowDate, cb)

Events Triggered

Generates the L2 AddPointsEvent when points are added.

Possible Errors

Additional Considerations

• In the Rule Builder the Purse Name is a drop-down, showing all the Purse Policies. You can select Variable if you would like to compute the Purse Name parameter at run-time.
• If points is 0, operation is skipped
• Points can't be negative
• If rule has countLimit or budget > 0, rule context is updated
• To model floating point values (for example, USD), use the lowest granularity (for example cents)

Redeem Points¶

Description

The action is used to redeem points from a member's purse. The action validates available balance before redemption and handles locked points appropriately.

Parameters

JavaScript API

UDF.redeemPoints(policyId, purseName, points, cb)

Events Triggered

Generates the L2 RedeemPointsEvent when points are redeemed.

Possible Errors

Additional Considerations

• In the Rule Builder the Purse Name is a drop-down, showing all the Purse Policies. You can select Variable if you would like to compute the Purse Name parameter at run-time.
• If points is 0, operation is skipped.
• Points can't be negative.
• Checks for available balance before redeeming.
• Considers locked points when calculating available balance.
• To model floating point values (for example, USD), use the lowest granularity (for example, cents).

Redeem Points with Accounting Type¶

Description

The action is used to redeem points from a member's purse with the ability to specify an accounting type for the redemption. The action validates available balance before redemption and handles locked points appropriately.

Parameters

JavaScript API

UDF.redeemPointsWithAccountingType(policyId, purseName, points, accountingType, cb)

Events Triggered

Generates the L2 RedeemPointsEvent when points are redeemed.

Possible Errors

Additional Considerations

• In the Rule Builder the Purse Name is a drop-down, showing all the Purse Policies. You can select Variable if you would like to compute the Purse Name parameter at run-time.
• If points is 0, operation is skipped
• Points can't be negative
• Checks for available balance before redeeming
• Considers locked points when calculating available balance
• To model floating point values (for example USD), use the lowest granularity (for example cents)
• The Accounting Type parameter allows categorization of redemptions for reporting and analytics purposes
• Non-Revenue accounting type is typically used for redemptions that don't involve revenue transactions

Linked Add Points¶

Description

The action is used to add points to multiple linked members' purses in a single operation. Points can be added with different amounts for each member, with optional accounting type, expiration date, and escrow date.

Parameters

Outputs

Returns array of updated purses.

JavaScript API

UDF.linkedAddPoints(policyId, purseName, points, accountingType, expirationDate, escrowDate, cb)

Events Triggered

Generates the L2 AddPointsEvent for each member involved.

Possible Errors

Additional Considerations

• In the Rule Builder the Purse Name is a drop-down, showing all the Purse Policies. You can select Variable if you would like to compute the Purse Name parameter at run-time.
• If points is 0, operation is skipped.
• Points can't be negative.
• If rule has countLimit or budget > 0, rule context is updated.
• When using array format, each object must have:
• memberId as key.
• amount: points to add.
• activity: activity object for the linked member.
• For single member operations, points can be a simple number.
• To model floating point values (for example, USD), use the lowest granularity (for example, cents).
• Activities are automatically created and added to linked members.

Linked Redeem Points¶

Description

The action is used to redeem points from multiple linked members' purses in a single operation. Points can be redeemed in different amounts from each member; an activity is generated for each linked (non-context) member to record the redemption.

Parameters

Outputs

Returns the array of updated purses for the context member. For linked members, the redeemed purse is added to the linked member's activity result log instead of the return value.

JavaScript API

UDF.linkedRedeemPoints(policyId, purseName, points, cb)

Events Triggered

Generates the L2 RedeemPointsEvent for each member affected.

Possible Errors

Additional Considerations

• In the Rule Builder the Purse Name is a drop-down, showing all the Purse Policies. You can select Variable if you would like to compute the Purse Name parameter at run-time.
• If points is 0, operation is skipped.
• When points is a plain number, the action redeems from the context member only.
• When points is an array, each entry is a single-key object: the key is the member ID and the value is { amount: <number>, activity: <activity object> }. The activity is required for any member other than the context member — it becomes a linked activity, validated and added to that member.
• Available balance is computed as purse.availBalance - lockedPoints evaluated at the activity date plus UTC offset; only locked points whose lockedTillDate is still after the activity date are subtracted.
• If the request exceeds the available balance, the purse policy's overdraftLimit is consulted; redemption proceeds only if the policy allows enough overdraft to cover the request.
• Linked redemptions accumulate into Context.result.data.linkDraw (set on the context member's activity).
• To model floating point values (for example, USD), use the lowest granularity (for example, cents).

Targeted Redeem Points¶

Description

The action is used to redeem points from a specific activity's accruals.

Parameters

JavaScript API

UDF.targetedRedeemPoints(policyId, purseName, points, targetAct, callback)

Events Triggered

Generates L2 RedeemPointsEvent when points are redeemed.

Possible Errors

Additional Considerations

• Validates target activity ID is valid ObjectId.
• Validates purse exists and belongs to member.
• Checks available points in target activity's accruals.
• Can't redeem more points than available in target activity.
• Points can't be redeemed after the purse period close date.
• Generates events before database updates.
• Updates both purse balance and accrual records.

Add Points To Peer¶

Description

Adds points to the peer member’s purse. The action expects a peer to already be populated in the execution context via Lookup Peer Member. It creates a linked activity for the peer (type: “Peer Add Points”) and updates the peer’s purse balance.

Parameters

Using Context Member Instead of Peer

By default, this action operates on the peer member loaded via Lookup Peer Member. To operate on the context member instead, wrap the activity in a payload that sets useContextMemberAsPeer: true and places the activity override under an activity key:

{
  "useContextMemberAsPeer": true,
  "activity": {
    "type": "Peer Add Points"
  }
}

When this flag is set to true, the points operation runs on the context member and the override at activity is merged into the generated linked activity. (When the flag is absent or false, the entire payload object is treated as the activity override and applied to the peer member's linked activity.)

JavaScript API

UDF.addPointsToPeer(policyId, purseName, points, activityPayload,
    accountingType, expiration, escrowDate, callback)

Peer Member Activity

The peer member must already be populated in the context via the Lookup Peer Member action. A new activity is created for the peer member with the following payload:

{
  "type": "Peer Add Points",
  "date": context.activity.utcDate || new Date(),
  "currencyCode": context.activity.currencyCode,
  "memberID": peerMember._id,
  "originalMemberID": peerMember._id,
  "srcChannelID": context.activity.srcChannelID,
  "srcChannelType": context.activity.srcChannelType,
  "value": context.activity.value,
  "status": "Processed"
}

Outputs

• The purse balance is increased by the specified points on:
  • Peer member (default behavior)
  • Context member (when useContextMemberAsPeer: true is set in Activity Payload)
• A linked peer activity of type “Peer Add Points” is created and attached to the primary activity via activity.data.peerActivityId.
• The callback receives either an error or the result object from the points addition.

Events Triggered

Generates the L2 AddPointsEvent when points are added.

Possible Errors

Related Actions

• Redeem Points From Peer
• Lookup Peer Member

Additional Considerations

• If the points value is 0, the action returns an empty array.
• The linked peer activity inherits metadata (date, currency, channel, location, and so on.) from the primary activity unless overridden by the activityPayload parameter.
• Errors are logged via the internal logger and passed to the callback.

Redeem Points From Peer¶

Description

Redeems points from the peer member's purse. The action expects a peer to already be populated in the execution context via Lookup Peer Member. It creates a linked activity for the peer (type: "Peer Redeem Points"), updates the peer member's purse balance, and allows the activity payload to be overridden. The peer's changes are saved when the rule flow completes.

Parameters

Using Context Member Instead of Peer

By default, this action operates on the peer member loaded via Lookup Peer Member. To operate on the context member instead, wrap the activity in a payload that sets useContextMemberAsPeer: true and places the activity override under an activity key:

{
  "useContextMemberAsPeer": true,
  "activity": {
    "type": "Peer Redeem Points"
  }
}

When this flag is set to true, the redemption runs on the context member and the override at activity is merged into the generated linked activity. (When the flag is absent or false, the entire payload object is treated as the activity override and applied to the peer member's linked activity.)

JavaScript API

UDF.redeemPointsFromPeer(policyId, purseName, points, activityPayload, callback)

Peer Member Activity

The peer member must already be populated in the context via the Lookup Peer Member action. A new activity is created for the peer member with the following payload:

{
  "type": "Peer Redeem Points",
  "date": context.activity.utcDate || new Date(),
  "currencyCode": context.activity.currencyCode,
  "memberID": peerMember._id,
  "originalMemberID": peerMember._id,
  "srcChannelID": context.activity.srcChannelID,
  "srcChannelType": context.activity.srcChannelType,
  "value": context.activity.value,
  "status": "Processed"
}

Outputs

• The purse balance is reduced by the specified points on:
  • Peer member (default behavior)
  • Context member (when useContextMemberAsPeer: true is set in Activity Payload)
• A linked peer activity of type “Peer Redeem Points” is created and attached to the primary activity via activity.data.peerActivityId.
• The callback receives either an error or the result object from the redemption.

Events Triggered

Generates the L2 RedeemPointsEvent when points are redeemed.

Possible Errors

Related Actions

• Add Points To Peer
• Lookup Peer Member

Additional Considerations

• If the points value is 0, the action returns an empty array and makes no changes.
• The linked peer activity inherits metadata (date, currency, channel, location, and so on.) from the primary activity unless overridden by the activityPayload parameter.
• Errors are logged via the internal logger and passed to the callback.

Lock Points¶

Description

The action is used to lock points in a purse until a specified date.

Parameters

JavaScript API

UDF.lockPoints(policyId, purseName, points, lockedTill, tag, callback)

Events Triggered

• Generates L2 LockPointsEvent when points are locked

Possible Errors

Additional Considerations

• Validates purse exists and belongs to member.
• Points must be a positive number.
• Locked till date must be on or after the activity date.
• Points can't be locked after the purse period close date.
• Total locked points can't exceed purse balance.

Unlock Points¶

Description

The action is used to unlock previously locked points in a purse.

Parameters

JavaScript API

UDF.unlockPoints(policyId, purseName, lookupField, lookupValue, callback)

Events Triggered

• Generates L2 UnlockPointsEvent when points unlocked

Possible Errors

Additional Considerations

• Validates lookup field and value are provided.
• Validates purse exists and belongs to member.
• After the purse policy's period close date, the operation is a no-op (the action logs an info message and returns an empty result) instead of an error.
• Updates the locked-points array in the purse.
• Returns the unlocked-points records that were applied to the activity.
• Supports multiple lock records matching lookup criteria.

Expire Balance¶

Description

The action is used to expire the balance in a purse.

Parameters

JavaScript API

UDF.expireBalance(purseId, purseName, callback)

Possible Errors

Additional Considerations

• Validates purse exists before expiring the balance.
• The Purse Name parameter is only used when the policy is set to Variable.
• The action zeroes the purse's balance and available balance, adds the previous balance to expired points, and marks the purse as having an in-progress expiration referencing the current activity.
• After the purse policy's period close date, the operation is a no-op (returns the purse unchanged) and only logs an info message.

Expire Accruals¶

Description

This action is used to expire the balance associated with accruals that have reached their expiration date within a purse.

Parameters

JavaScript API

UDF.expireAccruals(purseId, purseName, availableBalance, lastActivityDate, pointsToExpire,
        evaluateExpiredPoints, callback)

Possible Errors

Additional Considerations

• Validates the purse exists before expiring balance.
• The Purse Name parameter is only used when the policy is set to Variable.
• When Evaluate Expired Points is true, the action recalculates the expired points at execution time and ignores the supplied availableBalance, lastActivityDate, and pointsToExpire after the snapshot check passes.
• When Evaluate Expired Points is false, the action requires the supplied lastActivityDate and availableBalance to exactly match the current member state — otherwise it fails with code 2134.
• If pointsToExpire is 0 and Evaluate Expired Points is false, the action is a no-op.
• After the purse policy's period close date, the operation is a no-op (returns the purse unchanged) and only logs an info message.

Escrow Activity¶

Description

The action is used to escrow points from a previous activity.

Parameters

JavaScript API

UDF.escrowActivity(externalTxnId, transactionId, purseId, purseName, value, callback)

Events Triggered

No events are generated by this action

Possible Errors

Additional Considerations

• At least one of External Txn Id or Transaction Id must be provided.
• The Purse Name parameter is only valid when the policy is set to Variable.
• The referenced activity must exist on the member (or in ActivityHistory) and must not be in Error or Cancelled status.
• After the purse policy's period close date, the operation is a no-op (returns an empty array) and only logs an info message.

Transfer In¶

The Transfer In rule action transfers points from a transfer member to the context member.

Context Member

Transfer Member

Parameters

Execution Details

Context Member

Transfer Member Activity

{
  "type": "Transfer Out",
  "date": context.activity.utcDate || new Date(),
  "currencyCode": context.activity.currencyCode,
  "memberID": transferMember._id,
  "originalMemberID": transferMember._id,
  "srcChannelID": context.activity.srcChannelID,
  "srcChannelType": context.activity.srcChannelType,
  "value": context.activity.value,
  "status": "Processed",
  "result": {
    "data": {
      "purses": [
        {
          "name": "<Purse Name>",
          "prev": "<Balance before this action execution>",
          "prevAvail": "<Available Balance before this action execution>",
          "new": "<Balance after this action execution>",
          "newAvail": "<Available Balance after this action execution>"
        }
      ]
    }
  }
}

JavaScript API

UDF.transferIn(lookupValue, policyId, purseName, points, activityPayload,
    accountingType, expiration, escrowDate, callback)

Events Triggered

Generates the L2 AddPointsEvent on the context member and the L2 RedeemPointsEvent on the source (transfer) member.

Possible Errors

Additional Considerations

• If points is 0, the action is a no-op (returns an empty array).
• The two leg activities (redemption on the source member, accrual on the context member) are linked via data.transferToActivityId / data.transferFromActivityId.
• The Activity Payload override is merged on top of the generated source activity; it cannot replace the _id, memberID, originalMemberID, program, status, value, locationId, or result fields, which the action sets after merging.

Transfer Out¶

The Transfer Out rule action transfers points from the context member to a transfer member.

Context Member

Transfer Member

Parameters

Execution Details

Context Member

Transfer Member Activity

{
  "type": "Transfer In",
  "date": context.activity.utcDate || new Date(),
  "currencyCode": context.activity.currencyCode,
  "memberID": transferMember._id,
  "originalMemberID": transferMember._id,
  "srcChannelID": context.activity.srcChannelID,
  "srcChannelType": context.activity.srcChannelType,
  "value": context.activity.value,
  "status": "Processed",
  "result": {
    "data": {
      "purses": [
        {
          "name": "<Purse Name>",
          "prev": "<Balance before this action execution>",
          "prevAvail": "<Available Balance before this action execution>",
          "new": "<Balance after this action execution>",
          "newAvail": "<Available Balance after this action execution>"
        }
      ]
    }
  }
}

JavaScript API

UDF.transferOut(lookupValue, policyId, purseName, points, activityPayload,
    accountingType, expiration, escrowDate, callback)

Events Triggered

Generates the L2 RedeemPointsEvent on the context member and the L2 AddPointsEvent on the target (transfer) member.

Possible Errors

Additional Considerations

• If points is 0, the action is a no-op (returns an empty array).
• The two leg activities (redemption on the context member, accrual on the target member) are linked via data.transferToActivityId / data.transferFromActivityId.
• The Activity Payload override is merged on top of the generated target activity; it cannot replace the _id, memberID, originalMemberID, program, status, value, locationId, or result fields, which the action sets after merging.

Transfer Accruals¶

The Transfer Accruals rule action transfers usable accruals from the source member to a target member.

Parameters

Execution Details

Source Member

• Retrieve usable accruals of the source member(contex member).
• Calculates the total available points from usable accruals to transfer.
• Creates a single packaged redemption transaction with the total available points to mark existing accruals as used.

Target Member

• Duplicates the source member accruals to the target member to ensure that the earn and expiration dates are accurately replicated.
• Updates the target member’s purse by adding the transferred points.
• Create a new activity on the target member, with type Transfer Accruals.

{
  "type": "Transfer Accruals",
  "date": context.activity.utcDate || new Date(),
  "currencyCode": context.activity.currencyCode,
  "memberID": targetMember._id,
  "originalMemberID": targetMember._id,
  "srcChannelID": context.activity.srcChannelID,
  "srcChannelType": context.activity.srcChannelType,
  "value": context.activity.value,
  "status": "Processed",
  "result": {
    "data": {}
  },
  "_internal": {
    "primaryActivityId": context.activity._id
  }
}

JavaScript API

UDF.transferAccruals(policyId, purseName, targetMemberId, activityPayload, callback)

Possible Errors

Vest Escrow Points¶

Description

Vests previously-escrowed accruals from a referenced activity. The action finds all accruals on the member created by that activity that haven't yet been vested, then converts them into available balance and records vesting metadata.

Parameters

JavaScript API

UDF.vestEscrowPoints(activityId, callback)

Outputs

Returns the array of vested accruals (empty when there are no eligible escrowed accruals). The member and activity are updated when the rule flow completes.

Events Triggered

The vesting routine generates the underlying purse update events for each affected purse.

Possible Errors

Additional Considerations

• The action searches first in the member's recent activities, then in the activity log.
• Accruals that have already been vested are skipped.
• The escrow vest date defaults to the current activity's date.

Give Reward¶

Description

The action is used to add a reward to a member based on a reward policy. The reward can be configured with a custom code, usage limits, and expiration date. The reward's configuration is determined by the specified reward policy.

Parameters

Outputs

Returns the created reward object.

JavaScript API

UDF.addReward(policyId, rewardCode, rewardCounter, checkLimit, expirationDate, cb)

Events Triggered

• Generates L1 ObjectInsertEvent when creating new reward
• Generates L2 AddRewardEvent when reward is added to member

Possible Errors

Additional Considerations

• If checkLimit is false, reward limit validation errors are logged but not thrown
• If no rewardCode is provided, a UUID is automatically generated
• If no expirationDate is provided, calculated based on policy's expirationHours and expirationSnapTo settings
• If policy.availableRedemptions <= 0, throws error
• Reward's usesLeft defaults to policy.numUses if not specified
• Reward's upc defaults to policy.upc if not specified
• Validates member status against policy.applicableMemberStatus if configured
• Validates member program matches policy program
• Validates policy effectiveDate and expirationDate
• Automatically sets reward type to 'Reward'
• Sets reward name from policy name
• If special flag 'allowFutureEffective' is enabled, policy effective date validation is skipped
• If special flag 'ignoreDoubleApply' is enabled, uses left validation is skipped
• If special flag 'ignoreUsesLeft' is enabled, uses left validation is skipped

Give Specific Reward¶

Description

The action is used to give a specific reward to a member.

Parameters

JavaScript API

UDF.addSpecificReward(rewardObj, checkLimit, rewardCounter, callback)

Events Triggered

• Generates L2 AddRewardEvent when reward is added
• Generates L1 ObjectInsertEvent when creating new reward

Possible Errors

Additional Considerations

• The Reward Object parameter can be a single reward object or an array of reward objects.
• Each reward object must include name (the action sets lookupField to name and lookupValue to the supplied name).
• If the action receives multiple reward objects with the same code, every duplicate after the first is replaced by a freshly generated UUID.
• The action sets member, program, and org on each reward object before invoking member.addSpecificReward.
• When checkLimit is false, error 2049 (no more redemptions) is logged and swallowed; other errors still propagate.
• rewardCounter defaults to 1 when omitted.

Give Reward by Name¶

Description

The action is used to give a reward to a member by name.

Parameters

JavaScript API

UDF.giveRewardByName(rewardName, rewardCode, rewardCounter, checkLimit, expirationDate, callback)

Events Triggered

• Generates L1 ObjectInsertEvent when creating new reward
• Generates L2 AddRewardEvent when reward is added

Possible Errors

Additional Considerations

• Both Reward Name and Reward Code may be supplied as arrays; rewards are issued in series, one per name. The action returns a flat array of issued rewards.
• When Reward Code has fewer entries than Reward Name, missing positions are filled with generated UUIDs.
• When Check Limit is false, only error 2049 (no more redemptions) is suppressed; other validation errors still propagate.

Give Reward by UPC¶

Description

The action is used to give a reward to a member using UPC code.

Parameters

JavaScript API

UDF.giveRewardByUPC(policyId, upc, noOfUses, rewardCounter, extFields, expirationDate, callback)

Events Triggered

• Generates L1 ObjectInsertEvent when creating new reward
• Generates L2 AddRewardEvent when reward is added

Possible Errors

Additional Considerations

• Unlike most other reward-issuing actions, this action does not accept a checkLimit parameter — limit errors always propagate.
• The supplied External Fields object is passed through to the reward as-is.
• The Number of Uses parameter sets noOfUses on the reward (corresponds to usesLeft on the resulting member reward).

Cancel Reward¶

Description

The action is used to cancel a reward by its code.

Parameters

JavaScript API

UDF.cancelReward(rewardCode, allowExpired, allowUsed, callback)

Events Triggered

• Generates L2 RewardReversalEvent when reward is cancelled

Possible Errors

Additional Considerations

• Validates reward exists before canceling.
• Checks reward expiration status if allowExpired is false (string 'true' or boolean true enables override).
• Checks reward usage status if allowUsed is false (string 'true' or boolean true enables override).
• Cancellation is implemented by reversing the activity that issued the reward, via member.cancelTransaction. Reward limit counters and other side effects of the original activity are reversed.

Lock Reward¶

Description

The action is used to lock a reward until a specified date, preventing it from being used until after that date.

Parameters

JavaScript API

UDF.lockReward(lookupField, lookupValues, lockedTill, lockTxnId, options, callback)

lookupField is the reward field to match against (typically code) and lookupValues is the value (or comma-separated values / array) to match. The rule-builder UI populates lookupField as code and uses the entered Reward Code as lookupValues.

Events Triggered

No events are generated by this action.

Possible Errors

Additional Considerations

• Validates reward exists and belongs to member.
• Locked till date must be on or after the activity date.
• Can't lock cancelled rewards.
• Can't lock expired rewards.
• Can't lock rewards that aren't yet effective.
• Transaction ID must be valid if provided.

Unlock Reward¶

Description

The action is used to unlock a previously locked reward.

Parameters

JavaScript API

UDF.unlockReward(lookupField, lookupValues, lockedTill, lockTxnId, options, callback)

lockedTill is unused for unlock and is typically passed as null or omitted. The rule-builder UI sends code as lookupField and the entered reward code as lookupValues.

Events Triggered

• Generates L2 UnlockRewardEvent when reward is unlocked

Possible Errors

Additional Considerations

• Validates reward exists and belongs to member.
• Validates reward isn't cancelled, expired, or not yet effective.
• Lock transaction ID must match the one used when locking.
• Updates reward's locked till date to null.
• Returns if the reward is already unlocked.
• Can't unlock rewards that have been used.

Lock Recent Reward By Type¶

Description

The action is used to lock the most recently issued reward of a specific type until a specified date.

Parameters

JavaScript API

UDF.lockRecentRewardByType(rewardType, lockedTill, options, callback)

Events Triggered

No events are generated by this action.

Possible Errors

Additional Considerations

• Validates reward type is provided.
• Locked till date must be on or after the activity date.
• Can't lock cancelled rewards.
• Can't lock expired rewards.
• Can't lock rewards that aren't yet effective.
• Finds and locks the most recently issued reward matching the type.

Use Recent Reward By Type¶

Description

Uses the most recently assigned reward of the specified type. This action is used to redeem the latest reward that matches the given type.

Parameters

JavaScript API

UDF.useRecentRewardByType(rewardType, callback)

Events Triggered

Generates the L2 UseRecentRewardByTypeEvent.

Possible Errors

Additional Considerations

• The reward must be assigned to the member before it can be used.
• The reward must be within its effective dates.
• The reward must not have exceeded its maximum uses.
• The reward must not be cancelled.
• Only the most recently assigned reward of the specified type is used.
• The reward type is case sensitive.
• If multiple rewards of the same type exist, the most recently assigned one is used.

Use Reward By Code¶

Description

Uses a reward by its code. This action is used to redeem a reward that was assigned to a member using a code.

Parameters

JavaScript API

UDF.useRewardByCode(rewardCode, callback)

Events Triggered

Generates the L2 UseRewardByCodeEvent.

Possible Errors

Additional Considerations

• The reward must be assigned to the member before it can be used
• The reward must be within its effective dates
• The reward must not have exceeded its maximum uses
• The reward must not be cancelled

Give Offer by Lookup Field¶

Description

The action is used to give an offer to a member using lookup field.

Parameters

JavaScript API

UDF.giveOfferByLookup(lookupField, lookupValue, offerCode, offerCounter, checkLimit, expirationDate, futureEffective, callback)

Events Triggered

• Generates L1 ObjectInsertEvent when creating new offer
• Generates L2 AddOfferEvent when offer is added

Possible Errors

Additional Considerations

• When checkLimit is false, error codes 2049 and 2062 are logged and swallowed (the action returns an empty array). Other validation errors still propagate.
• After a successful issue, the offer is added to the activity result.

Give Offer by Lookup Field With Params¶

Description

The action is used to give an offer to a member using lookup field and additional parameters.

Parameters

JavaScript API

UDF.giveOfferByLookupWithParams(lookupField, lookupValue, params, offerCounter, checkLimit, callback)

Events Triggered

• Generates L1 ObjectInsertEvent when creating new offer
• Generates L2 AddOfferEvent when offer is added

Possible Errors

Additional Considerations

• When checkLimit is false, error codes 2049 and 2062 are logged and swallowed (the action returns an empty array). Other validation errors still propagate.
• The params object overrides default offer fields (such as code, expiration date, custom fields).

Lock Offer¶

Description

The action is used to lock an offer until a specified date.

Parameters

JavaScript API

UDF.lockOffer(lookupField, lookupValue, lockedTill, lockTxnId, callback)

Events Triggered

• Generates L2 LockOfferEvent when offer is locked

Possible Errors

Additional Considerations

• Validates offer exists and belongs to member.
• Validates the offer isn't already used, cancelled, or expired.
• Can't lock global offers or multi-use offers.
• Lock transaction ID is required and must be valid.
• Locked till date must be valid and on or after the activity date.

Unlock Offer¶

Description

The action is used to unlock a previously locked offer.

Parameters

JavaScript API

UDF.unlockOffer(lookupField, lookupValue, lockTxnId, callback)

Events Triggered

• Generates L2 UnlockOfferEvent when offer is unlocked

Possible Errors

Additional Considerations

• Validates offer exists and belongs to member.
• Validates the reward isn't cancelled or expired and has taken effect.
• Can't unlock global offers or multi-use offers.
• Lock transaction ID is required and must be valid.
• Must match the transaction ID used when locking.
• Updates offer's locked till date to null.

Use Offer By Code¶

Description

Uses an offer by its code. This action is used to redeem an offer that was assigned to a member using a code.

Parameters

Outputs

Adds the used offer to Context.result.data.offersUsed.

JavaScript API

UDF.useOfferByCode(offerCode, callback)

Events Triggered

Generates the L2 UseOfferEvent.

Possible Errors

Additional Considerations

• The offer must be assigned to the member before it can be used
• The offer must be within its effective dates
• The offer must not have exceeded its maximum uses
• The offer must not be cancelled

Apply Offers¶

Description

The action is used to apply the best offers to the current activity based on the activity's best offers list.

Parameters

JavaScript API

UDF.applyOffers(ignoreMissing, callback)

Events Triggered

• Generates L2 UseOfferByCodeEvent for each offer applied
• Generates L2 UseRewardByCodeEvent for each reward applied

Possible Errors

Additional Considerations

• Uses the activity's bestOffers list to determine which offers to apply
• If ignoreGlobalOffer is false, throws an error when global offer policies aren't found
• If ignoreOffer is false, throws an error when offer not found for member
• If ignoreReward is false, throws an error when reward not found for member
• Validates offer effective dates and expiration dates before applying

Check Offer Limits¶

Description

The action is used to check if a member has exceeded offer or reward limits based on configured thresholds.

Parameters

Outputs

Sets Context.limitExceeded to true if any limit is exceeded, false otherwise.

JavaScript API

UDF.checkOfferLimits(entityType, policyFilter, limits, isCalendar, callback)

Events Triggered

No events are generated by this action.

Possible Errors

This action does not throw rule-engine validation errors. Any error is a propagated database error from MongoDB.

Additional Considerations

• Supports day, week, and month limits supplied as keys on the limits object.
• The entityType is normalized to either Reward or Offer (any other value falls back to Offer).
• If limits is empty or missing, the action returns without computing anything (and Context.limitExceeded remains false).
• Week boundaries follow the program's weekStartDay setting only when Calendar is true.
• Calendar mode uses fixed month/week boundaries; non-calendar mode uses rolling periods ending at the activity date.
• The action counts both transient member records (rewards/offers on the in-memory member) and stored records.

Update Member Offer With Params¶

Description

The action is used to apply the provided lookups and offer filter to identify relevant member offers and updates their attributes.

Parameters

Outputs

The updates are applied to each member offer record filtered using the provided lookup fields and values. If an offer filter is provided and its key matches a lookup field, the filter conditions are combined with the existing lookups; otherwise, the filter is applied alongside the existing criteria.

JavaScript API

UDF.updateMemberOfferWithParams(lookupField, lookupValue, offerFilter, offerObj, callback)

Events Triggered

No events are generated by this action.

Possible Errors

Additional Considerations

• The offer must be assigned to the member before its attributes can be updated.
• Returns if the offer matching the filters isn't found.
• Sets updatedAt and updatedBy fields automatically.
• Updates the attributes of the member's offer based on the applied filters.

Resolve Best Offer Policies¶

Description

The action is used to resolve and populate offer policies corresponding to best offers.

Parameters

JavaScript API

UDF.resolveBestOfferPolicies(lookupObj, context, callback)

Outputs

Updates best offers in Context.activity.bestOffers with resolved policy IDs.

Events Triggered

No events are generated by this action.

Possible Errors

Additional Considerations

• Validates lookup field is provided
• Looks up policies by the specified field
• Updates originalPolicyId and policyId in best offers
• Logs missing policies if ignoreMissing is true
• Only processes global offers that don't already have originalPolicyId
• Handles location overrides if configured

Assign Promo Code¶

Description

The action is used to assign a promo code from a campaign to a member.

Parameters

JavaScript API

UDF.assignPromoCode(campaignCode, callback)

Events Triggered

• Generates L1 ObjectUpdateEvent

Possible Errors

Additional Considerations

• Validates campaign exists and is within its effective period
• Updates promo code status from 'New' to 'Assigned'
• Sets assignment date to current time
• Validates campaign belongs to member's program

Redeem Promo Code¶

Description

The action is used to redeem a promo code that has been assigned to the member.

Parameters

JavaScript API

UDF.redeemPromoCode(promoCode, callback)

Outputs

Populates Context.result.data.promoCodes with array containing the redeemed promo code object.

Events Triggered

No events are generated by this action.

Possible Errors

Additional Considerations

• Validates promo code exists and is assigned to member
• Checks campaign start and end dates
• Updates promo code status to 'Redeemed'
• Sets redemption date to current activity date
• Updates context with redeemed code details
• Combines with any existing promo codes in context

Assign And Redeem Promo Code¶

Description

The action is used to assign and immediately redeem a promo code in a single operation.

Parameters

JavaScript API

UDF.assignAndRedeemPromoCode(promoCode, callback)

Events Triggered

• Generates L1 ObjectUpdateEvent

Possible Errors

Additional Considerations

• Validates promo code exists and is in 'New' status
• Updates promo code status directly from 'New' to 'Redeemed'
• Sets both assignment and redemption dates to current time
• Validates campaign belongs to member's program

Lookup Activities¶

Description

The action is used to lookup and populate activities for the current member within a specified date range.

Parameters

JavaScript API

UDF.populateActivities(fromDate, limit, status, type, callback)

Outputs

Populates Context.member.activities with an array of activity objects.

Events Triggered

No events are generated by this action.

Possible Errors

Additional Considerations

• If fromDate isn't provided, defaults to start of current day.
• Activities are filtered by member ID and original member ID (unless disOriginalMemIdHisLookup is enabled).
• Activities are filtered to be between fromDate and current activity date.
• Respects program setting disOriginalMemIdHisLookup to control whether to lookup by original member ID.
• Status parameter can be a comma-separated list of statuses to filter by.

Lookup Activity By ID¶

Description

The action is used to lookup and populate a specific activity by its ID.

Parameters

JavaScript API

UDF.populateActivityById(activityId, callback)

Outputs

Populates Context.member.activities array with the found activity object.

Events Triggered

No events are generated by this action.

Possible Errors

No errors are thrown directly by this action. Any errors that occur are database errors propagated from the underlying MongoDB operations.

Additional Considerations

• Returns immediately if activity ID is invalid or not provided
• Returns if activity isn't found

Lookup Activity By Params¶

Description

The action is used to lookup and populate activities matching specified parameters.

Parameters

JavaScript API

UDF.populateActivityByParams(lookupField, lookupValue, callback)

Outputs

Populates Context.member.activities with matching activity objects.

Events Triggered

No events are generated by this action.

Possible Errors

No errors are thrown directly by this action. Any errors that occur are database errors propagated from the underlying MongoDB operations.

Additional Considerations

• Returns immediately if the lookup field or value isn't provided
• Returns if no matching activities are found
• Supports multiple lookup fields and values as comma-separated lists
• Values must match in order with their corresponding lookup fields

Cancel Transaction¶

Description

The action is used to cancel a previous transaction by either its activity ID or external transaction ID.

Parameters

JavaScript API

UDF.cancelTransaction(lookupField, value, callback)

Events Triggered

• Generates L2 CancelActivityEvent when transaction is cancelled

Possible Errors

Additional Considerations

• Reverses all point transactions from the original activity
• Cancels any rewards or offers that were issued
• Updates the original activity status to indicate cancellation
• Maintains audit trail of the cancellation

Create Metric Event¶

Description

This action is deprecated and no longer supported. Use Update Member Aggregate instead, which writes to the same aggregate pipeline using a typed AggregatePolicy.

Any rule that fires this action returns error 4049 ('Create Metric Event' action has been deprecated and is no longer supported.).

Parameters

None — the action is rejected before its parameters are evaluated.

JavaScript API

The corresponding UDF.createAggEvent function is also deprecated.

Events Triggered

None.

Possible Errors

Additional Considerations

• Existing rules that reference this action should be migrated to Update Member Aggregate. The replacement requires the metric to exist as an AggregatePolicy (or PursePolicy) in the same program.

Generate Custom Event¶

Description

The action is used to generate a custom event with the provided data.

Parameters

JavaScript API

UDF.generateCustomEvent(data, callback)

Events Triggered

• Generates L2 CustomActionEvent with the provided data as payload

Possible Errors

This action doesn't throw any errors.

Additional Considerations

• Only generates an event if data is provided and not empty.
• The event includes the current user and member as part of its header.

Lookup Activity Offers¶

Description

The action is used to lookup and populate offer coupons associated with the current activity.

Parameters

None. Uses the current activity context.

JavaScript API

UDF.populateActivityCouponOffers(callback)

Outputs

Populates the current activity with:

• activity.coupon: The main activity coupon if activity.couponCode exists
• activity.lineItems[].coupon: Individual line item coupons if lineItems[].couponCode exists

Events Triggered

No events are generated by this action.

Possible Errors

No errors are thrown directly by this action. Any errors that occur are database errors propagated from the underlying MongoDB operations.

Additional Considerations

• Looks up offer coupons by their code.
• Only returns coupons that still have uses remaining.
• Sorts by expiration date when multiple matches exist.
• Attaches coupons at both the activity level and the line-item level.
• Returns if no matching coupons are found.

Lookup Activity Rewards¶

Description

The action is used to lookup and populate reward coupons associated with the current activity.

Parameters

None. Uses the current activity context.

JavaScript API

UDF.populateActivityCouponRewards(callback)

Outputs

Populates the current activity with:

• activity.coupon: The main activity coupon if activity.couponCode exists and matches the Reward code
• activity.lineItems[].coupon: Individual line item coupons if lineItems[].couponCode exists and matches the Reward code

Events Triggered

No events are generated by this action.

Possible Errors

No errors are thrown directly by this action. Any errors that occur are database errors propagated from the underlying MongoDB operations.

Additional Considerations

• Looks up reward coupons by their code.
• Only returns coupons that still have uses remaining.
• Sorts by expiration date when multiple matches exist.
• Attaches coupons at both the activity level and the line-item level.
• Returns if no matching coupons are found.

Lookup Applicable Offers¶

Description

The action is used to find the all applicable offers for the current activity and member.

Parameters

JavaScript API

UDF.populateApplicableOffers(filterOfferTypes, policyFilter, lineItemFilter, options, populateFields, callback)

Populates Context.result.data.applicableOffers with array of applicable offers/rewards.

Events Triggered

No events are generated by this action.

Possible Errors

No errors are thrown directly by this action. Any errors that occur are database errors propagated from the underlying MongoDB operations.

Additional Considerations

• Validates all offers/rewards exist and are usable
• Checks offers/rewards cancellation status
• Verifies offers/rewards effective dates
• Validates remaining offers/rewards uses
• Handles both global and member-specific offers (wallet offers/rewards)
• Supports offer budget constraints
• Applies location overrides if configured
• Serializes line items if SPECIAL_FLAGS includes 'serializeLineItems'

Lookup Best Offers¶

Description

The action is used to find the best applicable offers for the current activity and member.

Parameters

JavaScript API

UDF.populateBestOffers(populateFields, offerFilter, lineItemFilter, options, callback)

Outputs

Populates Context.result.data with: - bestOffers: Array of best applicable offers - repricedTicket: Activity with applied discounts - applicableOffers: Array of all applicable offers

Events Triggered

No events are generated by this action.

Possible Errors

No errors are thrown directly by this action. Any errors that occur are database errors propagated from the underlying MongoDB operations.

Additional Considerations

• Validates all offers exist and are usable
• Checks offer cancellation status
• Verifies offer effective dates
• Validates remaining offer uses
• Handles both global and member-specific offers (wallet offers)
• Supports offer budget constraints
• Applies location overrides if configured
• Optimizes offer combinations for maximum discount
• Serializes line items if SPECIAL_FLAGS includes 'serializeLineItems'

Lookup Best Offer Policies¶

Description

The action is used to lookup and populate offer policies corresponding to best offers.

Parameters

JavaScript API

UDF.populateBestOfferPolicies(lookupField, ignoreMissing, callback)

Outputs

Updates best offers in Context.activity.bestOffers with resolved policy IDs.

Events Triggered

No events are generated by this action.

Possible Errors

Additional Considerations

• Validates lookup field is provided
• Looks up policies by the specified field
• Updates originalPolicyId and policyId in best offers
• Logs missing policies if ignoreMissing is true
• Only processes global offers that don't already have originalPolicyId

Lookup Contextual Reward Policies¶

Description

The action is used to find applicable reward policies based on the current activity context, optionally filtered by type and balance requirements.

Parameters

JavaScript API

UDF.promptApplicablePolicies(lookupField, lookupValue, policyFilter, lineItemExclusionFilter, balance, maxPolicies, callback)

Outputs

Populates Context.result.data.applicablePolicies with array of:

• policy: The reward policy object
• discountAmount: Maximum possible discount for this policy

Events Triggered

No events are generated by this action.

Possible Errors

Additional Considerations

• Validates numeric parameters (balance, maxPolicies)
• Filters policies by:
  • Available redemptions > 0
  • Expiration date >= activity date
  • Budget > 0 for offers
  • Cost <= balance (if balance provided)
• Applies location overrides if configured
• Calculates maximum possible discount for each policy
• Sorts results by discount amount (descending)
• Returns top N results if maxPolicies specified
• Handles both rewards and offers with budget constraints

Lookup Eligible Offers¶

Description

The action is used to find all eligible offers for the current activity and member based on policy and line item filters.

Parameters

JavaScript API

UDF.getEligibleOffers(policyFilter, offerFilter, lineItemFilter, options, callback)

Outputs

Populates Context with:

• eligibleOffers: Array of eligible offers
• eligibleRewardPolicies: Array of eligible reward policies with applicable product lines

Events Triggered

No events are generated by this action.

Possible Errors

No errors are thrown directly by this action. Any errors that occur are database errors propagated from the underlying MongoDB operations.

Additional Considerations

• Filters offers based on:
  • Member's program
  • Location overrides if configured
  • Policy criteria if provided
  • Line item criteria if provided
• Calculates applicable product lines for each reward policy
• Handles different discount types:
  • Ticket
  • Mix and Match
  • Combo
  • ComboList
• Supports filtering by:
  • Regular offers
  • Reward offers
  • Global offers
• Logs debug information about policy filtering and location overrides

Lookup Enums¶

Description

The action is used to lookup and populate enums of specified types.

Parameters

JavaScript API

UDF.populateEnums(enumTypes, callback)

Outputs

Populates Context.activityEnums with array of matching enum objects.

Events Triggered

No events are generated by this action.

Possible Errors

No errors are thrown directly by this action. Any errors that occur are database errors propagated from the underlying MongoDB operations.

Additional Considerations

• If no enum types provided, logs debug message and returns
• Filters enums by language 'en'
• Combines with any existing enums in Context.activityEnums
• Uses cached enum data when available
• Returns all enums if no types specified
• Deduplicates enum values using Set