Standard user-created events
For a standard, user-created event in which you want to enable Tealeaf users to full Portal access for searching and reporting purposes, apply the following configuration to the event definition.
Setting | Value | Notes |
---|---|---|
Active |
true |
|
Searchable & Reportable |
true |
|
Display in Portal |
true |
|
Display in Session List |
true |
Typically, this setting is used to display only the most important events in the session list. If too many events are listed, the event list becomes cluttered. |
Building block events
A building block event is an event that is used only within the Canister for purposes of defining or populating other event objects. For example, you can use an event to populate a session attribute. Because the data is stored in the attribute, you may not want to store the data as an event, as well.
- In the event list, building block events that were provided by Tealeaf are identified by the
[BB]
addition to the event name. - Building block events allow you to track significant items in the session without incurring the recording costs of writing them to the session record.
To configure a building block event, apply the following configuration to the event definition:
Setting | Value |
---|---|
Active |
true |
Searchable & Reportable |
false |
Display in Portal |
false |
Display in Session List |
false |
Tealeaf standard events
Tealeaf provides a set of events to monitor important session activities in the Canister as they are detected. You can use these events to write session information to attributes or to capture contextual information as needed.
Note: Tealeaf Standard Events are read-only and cannot be modified. These events are stored in the Tealeaf Standard Events
event group. Most Tealeaf standard events cannot be displayed in the Portal or in session lists.
Setting | Value |
---|---|
Active |
true |
Searchable & Reportable |
true |
Display in Portal |
either |
Display in Session List |
either |
Outdated events
An outdated event is an event that was previously active, capturing data, and recording it to the database, but it is no longer active in the system.
For example, suppose you previously created an event to capture shopping cart values. But due to a change in the web application, these values are now calculated through a different method using a different event. To ensure continuity in reporting, you may want to disable the earlier event but retain it for reporting purposes, so that you can report these events side-by-side.
Outdated events can be configured using the following scenario:
Setting | Value | Notes |
---|---|---|
Active |
false |
|
Searchable & Reportable |
true |
|
Display in Portal |
true |
Typically, historical events are displayed in the Portal as long as search and reporting functions require access to the data. When the session is trimmed from the Canister, this setting can be disabled. |
Display in Session List |
false |
Historical events may cause unnecessary clutter to the session list. |