Represents one named step in a funnel's sequential lead-progression pipeline, for example cold, then warm, then hot. A funnel defines an ordered list of stages via addStage; a Goal node can then reference a stage by name, in its stageName or onAchievedStageName, to move a lead into it when the node is entered or achieved. stageNum looks up a stage's zero-based position in that ordering. Persisted in the funnel definition XML as a "stage" element.

Group: Journeys

Implements: Serializable


Properties

PropertyReturnsDescription
colourStringColour used to represent the stage in the funnel editor and reporting, for example a hex code.
descStringHuman-readable description of the stage, shown in the funnel editor and reporting.
iconStringFont Awesome icon name used to represent the stage in the funnel editor.
nameStringThe stage's unique code, used to reference it from a Goal's stageName or onAchievedStageName and to look up its position in the funnel's stage ordering.
notesStringFree-text notes about the stage, for internal reference.

Methods

getName()

Returns: String

The stage's unique code, used to reference it from a Goal's stageName or onAchievedStageName and to look up its position in the funnel's stage ordering.

getDesc()

Returns: String

Human-readable description of the stage, shown in the funnel editor and reporting.

getNotes()

Returns: String

Free-text notes about the stage, for internal reference.

getColour()

Returns: String

Colour used to represent the stage in the funnel editor and reporting, for example a hex code.

getIcon()

Returns: String

Font Awesome icon name used to represent the stage in the funnel editor.

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