A funnel goal that is attained when a learning module a lead is enrolled in expires, or enters its renewal window. Matches on ModuleProgressEvent, filtering it against the configured website, program code, course code and module code (an empty filter matches any value). Depending on the onRenewal flag, it fires on either the RENEWAL action or the EXPIRED action for a matching module, and records the matched program, course and module details on the lead's attributes.

Group: Journeys

Extends: Goal

Implements: Serializable


Properties

PropertyReturnsDescription
courseCodeStringThe course code this goal matches against.
descriptionStringA short label describing which kind of module transition this goal matches.
moduleCodeStringThe module code this goal matches against.
nextNodeIdStringThe id of the journey node to move to when this goal is attained.
onRenewalbooleanWhether this goal fires on the module's renewal window rather than its expiry.
progressCodeStringThe program code this goal matches against, despite this accessor's "progress" name. Corresponds to the program code carried on the matched ModuleProgressEvent.
websiteNameStringThe name of the website the module must belong to for this goal to match.

Methods

getDescription()

Returns: String

A short label describing which kind of module transition this goal matches.

getNextNodeId()

Returns: String

The id of the journey node to move to when this goal is attained.

getWebsiteName()

Returns: String

The name of the website the module must belong to for this goal to match.

getProgressCode()

Returns: String

The program code this goal matches against, despite this accessor's "progress" name. Corresponds to the program code carried on the matched ModuleProgressEvent.

getCourseCode()

Returns: String

The course code this goal matches against.

getModuleCode()

Returns: String

The module code this goal matches against.

getOnRenewal()

Returns: boolean

Whether this goal fires on the module's renewal window rather than its expiry.

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