Fired when a profile becomes associated with the current request without logging in, eg after submitting a contact form or checking out as a guest. Raised by the platform where an anonymous visitor has just been identified as, or turned into, a profile: contact form submission, comment posting, guest checkout creating a purchaser profile, and from JS through userManager.fireProfileActiveEvent(website, profile). It is dispatched synchronously within that request. Its main use is to tie the visitor's anonymous tracking identity to the now-known profile - the tracking app and the websocket application both listen for it and match the request's tracking cookie, whose value is also carried in the attributes map when the tracking-id constructor is used. It is a trigger event with event id "profileActive", keyed on the website id as trigger item 1.

Implements: TriggerEvent


Properties

PropertyReturnsDescription
attributesMap<String,Object>The mutable attribute map for this event. Contains the visitor tracking id keyed by the tracking cookie name when the event was created with one, otherwise empty. Listeners may add their own entries.
branchBranchThe branch of the website being served, used by listeners to check whether their app is active for this request. May be null.
eventIdStringThe persistent identifier for this event type, always "profileActive". Used by the trigger system to select handlers.
sourceProfileProfileThe profile that became active on this request.
triggerItem1StringThe id of the website the profile became active on, as a string, for trigger matching.
triggerItem2StringNot used by this event, always null.
triggerItem3StringNot used by this event, always null.
triggerItem4StringNot used by this event, always null.
triggerItem5StringNot used by this event, always null.
websiteWebsiteThe website the profile became active on. Must not be null, the organisation of the event is read from it.

Inherited from TriggerEvent

Properties

PropertyReturnsDescription
serialisablebooleanWhether this event's attributes were built to survive being persisted, ie every value is a plain serialisable value rather than a persistent entity or some other object that only makes sense inside the firing transaction. Only the firing app can know this, so it declares it - see EventBuilder. An agent that subscribes to an event does not run when it fires. The event is written to storage as JSON, buffered with others, and read back minutes later in a different session, so a value that cannot be written and read back is not merely awkward, it breaks the whole delivery. The agent framework therefore ignores any event which does not say yes here.

Methods

isSerialisable()

Returns: boolean

Whether this event's attributes were built to survive being persisted, ie every value is a plain serialisable value rather than a persistent entity or some other object that only makes sense inside the firing transaction. Only the firing app can know this, so it declares it - see EventBuilder. An agent that subscribes to an event does not run when it fires. The event is written to storage as JSON, buffered with others, and read back minutes later in a different session, so a value that cannot be written and read back is not merely awkward, it breaks the whole delivery. The agent framework therefore ignores any event which does not say yes here.


Methods

getWebsite() · getBranch() · getSourceProfile() · getEventId() · getTriggerItem1() · getTriggerItem2() · getTriggerItem3() · getTriggerItem4() · getTriggerItem5() · getAttributes()

getWebsite()

Returns: Website

The website the profile became active on. Must not be null, the organisation of the event is read from it.

getBranch()

Returns: Branch

The branch of the website being served, used by listeners to check whether their app is active for this request. May be null.

getSourceProfile()

Returns: Profile

The profile that became active on this request.

getEventId()

Returns: String

The persistent identifier for this event type, always "profileActive". Used by the trigger system to select handlers.

getTriggerItem1()

Returns: String

The id of the website the profile became active on, as a string, for trigger matching.

getTriggerItem2()

Returns: String

Not used by this event, always null.

getTriggerItem3()

Returns: String

Not used by this event, always null.

getTriggerItem4()

Returns: String

Not used by this event, always null.

getTriggerItem5()

Returns: String

Not used by this event, always null.

getAttributes()

Returns: Map<String,Object>

The mutable attribute map for this event. Contains the visitor tracking id keyed by the tracking cookie name when the event was created with one, otherwise empty. Listeners may add their own entries.

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