Goal that advances a funnel lead when a voucher of a matching type is issued, or changes to a configured status. Matches against VoucherFunnelEvent instances raised across the vouchers app. The event's voucher type must match this goal's configured voucher type, and the event's action must match the configured goal type (issued or state changed). An issued voucher matches unconditionally and has its id recorded as the ATT_VOUCHER_ID attribute; a state change only matches when the lead's current voucher id, if any, agrees with the voucher that changed and, if a status is configured, the voucher's new status equals it. On a match, the lead advances to the configured next node.
Group: Journeys
Extends: Goal
Implements: Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| description | String | Human-readable summary of this goal, shown in the funnel editor, built from the configured voucher type name. |
| goalType | String | Which voucher lifecycle action this goal matches: the name of a VoucherFunnelEvent.VoucherAction value such as ISSUED or STATE_CHANGED. |
| nextNodeId | String | Id of the funnel node the lead advances to when this goal's voucher conditions are met. |
| voucherStatus | String | Voucher status required for a state-change match, compared case-sensitively against the voucher's status after the change. Blank or null matches any state change. |
| voucherType | String | Name of the voucher type this goal matches against, compared case-insensitively to the event voucher's type name. |
Methods
getDescription()
Returns: String
Human-readable summary of this goal, shown in the funnel editor, built from the configured voucher type name.
getNextNodeId()
Returns: String
Id of the funnel node the lead advances to when this goal's voucher conditions are met.
getVoucherType()
Returns: String
Name of the voucher type this goal matches against, compared case-insensitively to the event voucher's type name.
getGoalType()
Returns: String
Which voucher lifecycle action this goal matches: the name of a VoucherFunnelEvent.VoucherAction value such as ISSUED or STATE_CHANGED.
getVoucherStatus()
Returns: String
Voucher status required for a state-change match, compared case-sensitively against the voucher's status after the change. Blank or null matches any state change.