To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
A funnel goal that is attained when a lead's progress on a learning module matches a configured action, such as starting, completing or renewing. Matches on ModuleProgressEvent, filtering it against the configured website, program code, course code, module code and progress action (an empty filter matches any value, and a null action matches any action). When it matches, the event is stashed on the current request so onEnter can record the resulting module status id on the lead and, for a MODULE_COMPLETE action with attachCertificate set, attach the learner's certificate PDFs to the lead's files.
Group: Journeys
Extends: Goal
Implements: Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| action | ModuleProgressAction | The module progress action this goal matches against, eg MODULE_COMPLETE or RENEWAL. |
| attachCertificate | Boolean | Whether a certificate PDF should be attached to the lead's files when this goal matches a MODULE_COMPLETE action. |
| courseCode | String | The course code this goal matches against. |
| description | String | A short label describing which module progress action this goal matches. |
| moduleCode | String | The module code this goal matches against. |
| nextNodeId | String | The id of the journey node to move to when this goal is attained. |
| progressCode | String | The program code this goal matches against, corresponding to the program code carried on the matched ModuleProgressEvent. |
| websiteName | String | The name of the website the module must belong to for this goal to match. |
Methods
getDescription()
Returns: String
A short label describing which module progress action 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, corresponding 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.
getAction()
Returns: ModuleProgressAction
The module progress action this goal matches against, eg MODULE_COMPLETE or RENEWAL.
getAttachCertificate()
Returns: Boolean
Whether a certificate PDF should be attached to the lead's files when this goal matches a MODULE_COMPLETE action.
© 2025 Kademi Ltd