Journey action that debits reward points from a lead's associated recipient when the goal is entered. Looks up the named points bucket, resolves the recipient by evaluating recipientMvel (or falls back to the lead's own profile), works out the number of points to debit from either the fixed numPoints value or by evaluating numPointsMvel, and creates a debit against the reward for that recipient. Always proceeds to the configured next node.

Group: Journeys

Extends: AbstractGoalAction


Properties

PropertyReturnsDescription
numPointsDoubleFixed number of points to debit, used when numPointsMvel is not set.
numPointsMvelStringMVEL or kcode expression that is evaluated against the lead to calculate the number of points to debit, taking precedence over the fixed numPoints value when set.
pointsBucketNameStringName of the reward points bucket that points are debited from.
reasonStringHuman-readable reason recorded against the debit transaction. Falls back to a default message naming the node's identifier when no reason has been configured.
reasonCodeStringMachine-readable code recorded against the debit transaction, identifying the reason for the debit.
recipientMvelStringMVEL or kcode expression that is evaluated to resolve the profile or organisation that points are debited from. When not set, the lead's own profile is used as the recipient.

Methods

getPointsBucketName()

Returns: String

Name of the reward points bucket that points are debited from.

getNumPoints()

Returns: Double

Fixed number of points to debit, used when numPointsMvel is not set.

getNumPointsMvel()

Returns: String

MVEL or kcode expression that is evaluated against the lead to calculate the number of points to debit, taking precedence over the fixed numPoints value when set.

getReasonCode()

Returns: String

Machine-readable code recorded against the debit transaction, identifying the reason for the debit.

getReason()

Returns: String

Human-readable reason recorded against the debit transaction. Falls back to a default message naming the node's identifier when no reason has been configured.

getRecipientMvel()

Returns: String

MVEL or kcode expression that is evaluated to resolve the profile or organisation that points are debited from. When not set, the lead's own profile is used as the recipient.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.