The Event wizard provides a step-by-step method of configuring the properties and relationships for individual events. You can edit existing events or create new events through the Event wizard.
The following types of special events can be configured in Basic Mode through the Event Wizard.
- Distance Events
- Sequence Events
You can also configure special actions for events.
In Advanced Mode, events can be edited in the Event Engine Script form in which they are stored. Click Advanced Mode. For Standard Events, you can view the underlying JavaScript™ in a read-only version of Advanced Mode.
Note: After the event is saved to the server for the first time, the defined display name is used to generate the internal identifier for the event and for recording occurrences of the event in session data. If the display name is changed, the internal names for event objects cannot be updated to reflect the change. If the display name is changed, the display names that are used in the event and event occurrence definitions are updated.
To track movement of event values, Searchable & Reportable
must be enabled. If an event is changed to disable this option, the associated Top Mover is also disabled. Re-enabling the option does not re-enable the Top Mover. When this is enabled, the data is available to other Tealeaf components.
Firing trigger
The Evaluate value defines the point during the session when the event is evaluated. The selected trigger impacts the available conditions that can be used in the event. Changing the trigger can force the removal of one or more incompatible conditions.
Fires on trigger | Description |
---|---|
First Hit of Session |
The first hit of a new session is captured
Some session-level data was not populated when the first hit of the session is captured. For example, system session attributes are populated, while user-defined session attributes are not and cannot be used as conditions for events within this trigger. Note: Step attributes cannot be used on the |
Every Hit |
Each time that a hit is captured |
Every Step |
For step-based events, you can configure an event to be evaluated on each step. Step-based eventing enables the evaluation of data that is captured from one of client-side capture solutions. |
After Every Step |
For step-based events, you can configure an event to be evaluated after each step was evaluated. Step-based eventing enables the evaluation of data that is captured from one of the client-side capture solutions. |
After Every Hit |
After each hit was captured and evaluated |
Last Hit |
A hit is captured and determined to be the last one of the sessions |
End of Session |
After the session closed. Events that are assigned to this trigger are given the timestamp and hit number of the last page of the session, which is the end of the session by definition.
End of session events are limited to First Occurrence for the Tracked Event Occurrence, as defined in the Event Summary. Note: End of Session events cannot access hit attributes or other hit-based data. References to these objects are removed from the event definition. |
The trigger is used with the event condition to determine when the event fires. For example, if the trigger is set to First Hit of Session
, the event can be evaluated for firing only when the first hit of a new session is detected and not at any other time of the session. When the first hit is detected, the conditions of the event are evaluated; the event fires only if the conditions are met and the hit is the first one of the sessions. The event never fires on any other page.
Note: The trigger for the event must be specified with the availability of the conditions that trigger the event, since both must evaluate to true
for the event to be fired.
Order of evaluation
The following event triggers are listed in the order of evaluation for events.
First Hit of Session
- when the session beginsEvery Hit
- when the hit is detectedEvery Step
- when the step is detectedAfter Every Step
- when the step is detected
After Every Hit
- when the hit is unloadedLast Hit
- the last hit of the sessionEnd of Session
- when the session closes
For any event, the specified Conditions must be configured so that they can be evaluated within the selected trigger. For example, an event that is configured to fire on First Hit of
Session
must use conditions that can evaluate to true
at the moment of evaluation of the first hit of the session. Otherwise, the event never fires. The trigger and the conditions of the event must both be true
for the event to fire.
End of session trigger
Events that you want to be evaluated in the End of Session
trigger have the following extra conditions that are applied to them.
- The last event of a session to be evaluated is always the
Fact Count for Session
event. It is evaluated after distance events and sequence events.Note: Any fact that is configured to have a dependency on the
Fact Count for Session
event have its dependencies voided, and the results of the evaluation is alwaysfalse
. - Hit attributes are not available in the
End of Session
trigger. Report groups that reference hit attributes are not available in this trigger.
Event occurrence tracking
In the Event Summary, you can configure the occurrences of the event in a session to track. The tracked occurrence affects the fact occurrence that returned when a fact is referenced.
Note: For any event that is triggered off step-based data, you should configure it to track occurrences at the individual hit level. Do not use session-level tracking, as those options only operate on the first or last hit of the session.
Type | Description |
---|---|
First Per Session |
Track the first detected value in the session. Do not track any subsequent values in the session. |
Last Per Session |
Track the last detected value in the session.
Note: When this option is selected, you cannot search for this event in active sessions, since the meaning of "last" is not known until the session is closed. |
Every Occurrence |
Track each occurrence in the session as a separate fact value and increment the count each occurrence. |
Suppose a fact is set to track the last occurrence (Last Per Session
), and this fact occurs on hits 1, 5 and 7. If a session-end event references this fact's value or dimension values, it retrieves the values that were recorded on hit 7 because that is the last occurrence of the event. Conversely, if the event is set to track the first occurrence (First Per
Session
), then the session end event receives the values that were recorded on hit 1.
Event value types
Select the value type to record.
Type | Description |
---|---|
Numeric |
Record the event occurrence and a separate numeric value. Non-numeric values are recorded as 0 .
For Numeric or Text events, you may select the hit attribute, session attribute, or event value to record for the current event. Click Select Item to Record and make your selection accordingly. |
Text |
Record the event occurrence and a separate text value.
For Numeric or Text events, you may select the hit attribute, session attribute, or event value to record for the current event. Click Select Item to Record and make your selection accordingly. |
Count Only |
Count of instances that were recorded for reporting. For example, if the tracked value is the last one, the count is set to 1 . |
Distance |
The distance value to record.
Note: This option is only available if you configured distance-based event conditions. |