A journey action that awards reward points from a named points bucket when a lead reaches this node. The recipient defaults to the lead's own profile but can be redirected to another profile or organisation with recipientMvel; the amount is either the fixed numPoints or a value computed from numPointsMvel, and both the amount and the recorded reason can be plain MVEL expressions or kcode expressions. Configured as the "grantRewards" node type in the funnel editor.
Group: Journeys
Extends: AbstractGoalAction
Properties
| Property | Returns | Description |
|---|---|---|
| numPoints | Double | Fixed number of points to award, used when numPointsMvel is not set. |
| numPointsMvel | String | MVEL or kcode expression that computes the number of points to award, evaluated against the lead's profile with the current lead, funnel and root folder in scope. Takes precedence over numPoints when set. |
| pointsBucketName | String | Name of the reward points bucket that points are drawn from, looked up via PointsManager.findPointsBucket. No points are awarded when this is blank. |
| reason | String | Text recorded as the reason for the awarded reward. May be a plain string or a kcode expression that is evaluated against the lead before use. Defaults to "Awarded by goal " followed by this node's id when no reason has been configured. |
| recipientMvel | String | MVEL or kcode expression that resolves the recipient of the awarded points, evaluated with the lead and triggering event in scope. It may resolve to a profile or organisation, a base entity id, a username or an email address. When blank the lead's own profile is used as the recipient. |
| tagName | String | Name of the points tag to record against the awarded reward, looked up within the lead's admin domain. May be null, in which case the reward is not tagged. |
Methods
getPointsBucketName()
Returns: String
Name of the reward points bucket that points are drawn from, looked up via PointsManager.findPointsBucket. No points are awarded when this is blank.
getNumPoints()
Returns: Double
Fixed number of points to award, used when numPointsMvel is not set.
getNumPointsMvel()
Returns: String
MVEL or kcode expression that computes the number of points to award, evaluated against the lead's profile with the current lead, funnel and root folder in scope. Takes precedence over numPoints when set.
getTagName()
Returns: String
Name of the points tag to record against the awarded reward, looked up within the lead's admin domain. May be null, in which case the reward is not tagged.
getReason()
Returns: String
Text recorded as the reason for the awarded reward. May be a plain string or a kcode expression that is evaluated against the lead before use. Defaults to "Awarded by goal " followed by this node's id when no reason has been configured.
getRecipientMvel()
Returns: String
MVEL or kcode expression that resolves the recipient of the awarded points, evaluated with the lead and triggering event in scope. It may resolve to a profile or organisation, a base entity id, a username or an email address. When blank the lead's own profile is used as the recipient.