Depending on the configuration options you select in the event definition, the event and its data may be displayed in various areas of the Portal. In this section, you can review the controls available for making events accessible through the Portal, including search and reporting functions, followed by several configuration scenarios.
The two primary configuration options are the following:
Active
Is the event evaluated in the Canister? If an event is made inactive, the event is no longer evaluated in the Canister. As a result, the event does not exist in any sessions for as long as the event is inactive.
Searchable & Reportable
Is the event data recorded in the Tealeaf databases to make it available for searching and reporting? Whether the events are available for searching and reporting is configured by two extra settings:
Display in Portal
Display in Session List
These two settings can be configured independently of each other:
Active |
Searchable & Reportable |
Net effect |
---|---|---|
true |
true |
The event is configured to be evaluated in the Canister, and the results that are stored in the database for Portal access. For events that you want Tealeaf users to have full access, configure both of these settings to be true . |
true |
false |
The event is evaluated in the Canister, but the results are not stored in the database. These events, called building block events, can be used in the creation and evaluation of other event objects, such as session attributes. |
false |
true |
This configuration is used for events that are no longer to be actively evaluated in the Canister but should be available for search and reporting reasons in the Portal because they contain historical data that may still be useful to Portal users. |
false |
false |
The event is not evaluated in the Canister, is not usable by other event objects, and is not available through the Portal. Effectively, the event is removed from the system. |
Configuring events to be searchable and reportable in the Portal
When the Searchable & Reportable
setting is enabled, the following settings can now be configured in the Event Summary.
- If
Searchable & Reportable
is disabled for an event, it cannot be displayed in the Portal, and the following settings are not available for selection. Events that are configured in this manner are considered to be building block events. Display in Portal
- When this setting is enabled, the event can be displayed in the Portal in the following areas:- Selectable event in the Report Builder.
- Selectable event and its values for which to search in the Portal.
- Event is displayed in Browser-Based Replay.
Display in Session List
- This setting is available only ifDisplay in Portal
is enabled. When this option is selected, the icon for the event is displayed in the collection of event icons in the Events column of the session list.
Note: These settings do not completely control the availability of facts in the Portal. Event availability in RTV is configured independently.
Availability of facts in the Portal
When an event is configured to be active and searchable & reportable, the facts that are associated with the event may be written into the request of the hit where they occurred.
- Associated with each occurrence of an event may be one or more facts.
A fact contains the event, its value, and the dimensions and values for one report group. If the event is associated with multiple report groups, multiple facts are written to the request in each firing of the event.
- Events that are not configured to be searchable & reportable do not generate facts in the request.
Only some facts can be marked for indexing and search.
- The
Tracked Event Occurrence
setting for the event defines the first, last, or all occurrences of the event in the session to track. Depending on the value for this setting, the Searchable flag in the fact that is recorded in the request is set totrue
, thus making the fact available for indexing and search. So, you can search for the event name, event value, and dimension values that are recorded in that fact instance. - If the occurrence of the fact does not match the Tracked Event Occurrence setting and
Flag Every Occurrence for Replay
is set totrue
, the Searchable flag in the fact that is written into the request is set tofalse
. The fact information is displayed during replay but is otherwise not searchable.
Since facts are written to the request, they cannot be separated from session data and exist in the data for as long as the session is retained.
- Other components and services, such as cxConnect for Data Analysis, can acquire fact information independent of whether the fact is configured for display in the Portal.
- If the
Display in Portal
setting is disabled, the fact data cannot be retrieved by searching for events through the Portal. However, you may be able to retrieve the data by searching the request for fact data.
Note: To disable a fact, you must remove the report group that is associated with the event.
Event availability in RTV
In the event properties, the two properties that are listed in the left columns in the table determine availability and behaviors in the Portal and in RTV. Note that the behaviors are slightly different.
Note: As in the Portal, you can still search for, replay, and report on inactive events in RTV. The events do not fire, but they are available for your use. See the third row in the table.
Active | Display in Portal | Fires? |
---|---|---|
true |
true |
Y |
true |
false |
Y |
false |
true |
N |
false |
false |
N |
Note: If an event was deleted, it cannot be fired, displayed in the Portal, or searched for. For all functional purposes, the event no longer exists.