A report group is a mechanism for organizing one or more dimensions under a common heading. Tealeaf events can be associated with a report group, which enables segmented reporting that is based on the presence of individual dimensions or dimension values within associated report groups.
Notes about report groups
- Report groups have significant implications on the scope of reporting data for an event.
- To display only the dimensions from a specific report group in the main panel, select the report group entry in the left navigation panel.
- The
All Dimensions
entry can be selected to display all available dimensions. - To filter the list of dimensions in the Report Groups Panel, enter a string in the Filter Dimensions textbox. The filter is applied in real time to display only the matching dimensions. Leading and trailing blank spaces are not removed from the filter.
- Some report groups that are provided by Tealeaf cannot be edited.
- Saving a draft saves the item to the session cache on the server. Changes must be committed before they are applied to the incoming session data.
- After you save a report group that includes dimensions, you cannot change its report group template.
- When you delete a report group, the group is removed from any dimensions that were assigned to it. The dimensions are otherwise unchanged.
Note: If you licensed cxOverstat, don't modify the report groups that are provided with cxOverstat.
Add dimensions to a report group
When you edit a report group, you can change the dimensions that belong to it. A report group can contain up to 4 dimensions.
For report groups used by cxOverstat events, you can add up to 8 dimensions.
Note: After a dimension is added to a report group and saved to the database, it cannot be removed from the report group. Dimensions that are provided by Tealeaf cannot be edited.
Report group templates
A report group template is a preconfigured set of dimensions that can be added to a report group.
- The Template drop-down is visible only if you licensed a product or module that enables extra report group templates.
Note: Use of the cxOverstat report group templates requires cxOverstat, a separately licensed product for the CX platform. You cannot use these report group templates to create report groups for use with non cxOverstat events.
For some types of events, a predefined set of dimensions must be added for the event to function. For example, cxOverstat-related events require specific sets of dimension in order to work.
Note: cxOverstat is a separately licensed product for the CX platform. For more information, contact your Acoustic representative.
Template Type | Description | Maximum Number of Dimensions |
---|---|---|
Standard |
Standard cxImpact report group template. This template is empty of dimensions. | 4 |
Usability - Click |
This template is used for events tracking heat map and link analytics-related activities for cxOverstat. | 8 |
Usability - Attention Map |
This template is used for events tracking attention map-related activities for cxOverstat. | 8 |
Usability - Form Analytics |
This template is used for events tracking form analytics-related activities for cxOverstat. | 8 |
Tealeaf report groups
Tealeaf provides the following special report groups as part of the installation.
No Dimension Report Group
The No Dimension Report Group
report group is the automatically added to all events. It records the event's value. It can't be removed or changed.
The No Dimension Report Group
report group is hidden in the Dimensions tab and elsewhere in the basic Event Manager. References to the report group may be available in the following areas:
- Event JavaScript™
- In the Event Tester, which is referenced as
(No Dimension Report Group)
URL/Host/App/Server
Tealeaf provides four predefined dimensions to track contextual information about the activities of visitors to your web application:
URL
Host
App
Server
On a large and busy website, the values that correspond to these items might overshadow the valid data of interest. For example, unique URLs may include a wide variety of query parameters. To ensure that the reporting data are clear and concise, dimension values are restricted or normalized to a subset of the values observed by the pipeline.
Note: These values are extracted in the pipeline from the capture stream by the Tealeaf Reference session agent, which must be deployed in your pipeline to capture these values. The Tealeaf Reference session agent provides extra configuration options, including the capture of user interface events on the client and user agent detection.
Note: The target page should not be whitelisted as an accepted URL for the URL dimension of the URL, Host, App, Server report group.
Tealeaf supports the capture of any detectable or assignable values to any user-defined dimension.
Enable URL, host, app, server dimensions
When Tealeaf is initially installed or upgraded, these dimensions are pre-defined for you. To enable the capture of values to them, extra configuration may be required.
Before you begin, you must deploy the Tealeaf Reference session agent in your pipeline.
Note: Management of the URL dimension can be especially important for managing database size.
To enable the logging of values for Tealeaf-provided dimensions:
- In the Dimensions tab, select the
URL/Host/App/Server
report group in the left panel. Repeat the next three steps for each of the four dimensions: - Right-click one of the dimensions and select Edit Dimension.
- In the Edit Dimension dialog, check whether logging of reference values was enabled.
When logging is enabled, the Logging Values date stamp indicates that values is logged for the dimension until the listed date. This date stamp corresponds to the current date plus the number of days that reference log values are retained in the database.
- Click Save Draft.
- When you save drafts that enable logging for all four dimensions, you must save the changes to the server. In the Dimensions tab, click Save Changes.
Logging of the values for the reference dimensions is now enabled.
- In most cases, a sufficient cross-sample of these values is accumulated in the database within 24 hours.
- These values are extracted from the capture stream, which is converted into SQL, and submitted to the database once per hour. After initially enabling the logging of these values, you should wait at least an hour before continuing with the following steps.
After at least one hour was elapsed since logging was enabled, you can add values to each dimension from the logged reference values.