This event is triggered whenever a visitor’s session ends or expires.
Class name |
|
JMS name |
|
Display name | Session ends |
Message context | Session |
Message scope | Individual |
Message source | Component: Class: |
Component that calls the message source |
|
How this event is triggered | This event is triggered by the |
How to turn this event off | Set to false the |
The message that triggers this event contains the following properties:
Property | Type | Scenario editor label |
---|---|---|
|
|
|
The profile repository item corresponding to the visitor whose session is expiring. | ||
|
|
|
The profile ID of the visitor whose session is expiring. | ||
|
|
|
The ID of the session that is expiring. | ||
|
| Does not appear. |
The ID of the current site. The value is provided by the Site Context Manager. This parameter applies to multisite environments. |
Note: In some previous versions of the Scenarios module, this message did not contain a sessionId
property. To determine the session for an EndSession
event, the Scenarios module used instead the session ID from the request (context.request.session.id
). However, in some circumstances, it is possible for the session to expire before the EndSession
message is sent, which means that the session ID is lost, the Scenarios module cannot identify it, and scenarios that use it will not be triggered. For this reason, it is highly recommended that you use the sessionId
property in this message (context.message.sessionId
) whenever you need to identify a session for an EndSession
event. For example, use this property in data mappers that you are using to record EndSession
event data.