To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Defines a role a participant can fill on a Lead, in addition to the fixed system roles implied by Lead's own profile/organisation/assignedToOrg/assignedToProfile fields (see Lead.ROLE_* constants and FunnelManager.getLeadRoleDefs, which merges those system roles with the custom ones defined here). Written in a funnel's configuration as a leadRoleDef element, which is also the JSON type name used when the funnel is exchanged as JSON.
Group: Journeys
Properties
| Property | Returns | Description |
|---|---|---|
| accessKeys | List<String> | Arbitrary access or permission identifiers granted to whoever fills this role. May be null or empty when the role grants no additional access. |
| allowedGroupNames | List<String> | For a KIND_PROFILE role, the portable names of the groups a participant must belong to at least one of in order to fill this role. May be null or empty when there is no group restriction. |
| allowedOrgTypeNames | List<String> | The organisation types eligible to fill this role. For a KIND_PROFILE role this is combined with allowedGroupNames and constrains the participant's own organisation; for a KIND_ORGANISATION role it constrains the participant organisation itself. May be null or empty when there is no type restriction. |
| multiValued | boolean | Whether a lead can have more than one participant filling this role. |
| participantKind | String | Whether a participant filling this role is a profile or an organisation, one of KIND_PROFILE or KIND_ORGANISATION. |
| roleKey | String | Identifier for this role, matched against LeadParticipant.roleKey to find which participants fill it. |
| system | boolean | Whether this role is one of the fixed roles synthesized from Lead's own legacy fields (see Lead.ROLE_* and FunnelManager.getLeadRoleDefs), rather than a role defined by a funnel's configuration. |
| title | String | Display label for this role shown in admin UIs. |
Methods
getRoleKey()
Returns: String
Identifier for this role, matched against LeadParticipant.roleKey to find which participants fill it.
getTitle()
Returns: String
Display label for this role shown in admin UIs.
getParticipantKind()
Returns: String
Whether a participant filling this role is a profile or an organisation, one of KIND_PROFILE or KIND_ORGANISATION.
isMultiValued()
Returns: boolean
Whether a lead can have more than one participant filling this role.
isSystem()
Returns: boolean
Whether this role is one of the fixed roles synthesized from Lead's own legacy fields (see Lead.ROLE_* and FunnelManager.getLeadRoleDefs), rather than a role defined by a funnel's configuration.
getAccessKeys()
Returns: List<String>
Arbitrary access or permission identifiers granted to whoever fills this role. May be null or empty when the role grants no additional access.
getAllowedGroupNames()
Returns: List<String>
For a KIND_PROFILE role, the portable names of the groups a participant must belong to at least one of in order to fill this role. May be null or empty when there is no group restriction.
getAllowedOrgTypeNames()
Returns: List<String>
The organisation types eligible to fill this role. For a KIND_PROFILE role this is combined with allowedGroupNames and constrains the participant's own organisation; for a KIND_ORGANISATION role it constrains the participant organisation itself. May be null or empty when there is no type restriction.
© 2025 Kademi Ltd