Session list templates are used to configure the appearance and the data of the list of sessions returned from a search. The session list templates allow control of the displayed fields of session data, how they should be treated, and other information such as the server metrics.
Search templates can be set to use specific session list templates, or a template can be selected at the time of the search. Much like the search templates, session list templates have a set of properties, but they can also reference session list columns, which are assigned to the templates.
The following options are available when configuring a session list template.
| Property | Description |
|---|---|
Title |
The name of the template. |
Type |
The type of search template:
|
Default Event Label |
Select the event label whose events should be displayed by default in the QuickView page. |
Maximum Matches |
The maximum number of sessions to return from a search. This setting has no effect on how many sessions are found or examined; it only determines the number of sessions available to the user. For performance reasons, you cannot set this value above 10000. This setting should be configured in conjunction with other search limit settings. |
Total Matches |
Displays the total number of matching sessions. |
Replay Sessions |
Enables the replay of sessions from the session list. |
Pages List Drilldown |
Allows examining the pages of a returned session within the Portal. |
QuickView |
Enable the user to open the QuickView page, where the events that fired on each page can be reviewed. |
Session Info Popup |
Allows the user to get a quick list of session attributes from the session list. |
Download All Sessions |
Displays the Download All button, which allows users with RTV installed to open all sessions found in a search. |
Session Segments Button |
Displays the Manage Segments button in the session list, which allows users to access the
Manage Segments page. Note: When this button is enabled in session list templates accessible to
cxReveal users, it is not displayed in the session list because cxReveal users cannot create session segments. cxReveal
administrators may be able to create session segments through the Manage Session Segments
page. |
Analyze Session Segment |
Displays the Analyze Segment button, which can be click to analyze the session segment of a
search directly from the Session List. Note: When this button is enabled in session list templates
accessible to cxReveal users, it is not displayed in the session list because
cxReveal users cannot create session segments. cxReveal administrators may be able to create session segments through the Manage Session Segments
page. |
Server Metrics Table |
Displays the table listing the servers that were searched with elapsed time and number of returned sessions. |
Display Search Query |
Allows the query used in the search to appear on the Search Results page. |
Configuring maximum session display limits
When configuring the number of sessions that are displayed in search results, several Portal settings may affect the result.
Search Database Max Sessions Returned- (For cxReveal database searches only.) This parameter defines the maximum number of sessions that can be returned from a search of the cxReveal database. For cxReveal database searches, other session display limits may be applied to further limit the number of sessions displayed; the number of displayed search results never exceeds this number of database searches.Maximum Matches- In the specified session list template, you can configure the maximum number of sessions that can possibly be displayed in the template.- Regardless of the values of other settings, the
Maximum Matchessetting defines the limit to be displayed in a session list. - For performance reasons, this value cannot exceed
10000.
- Regardless of the values of other settings, the
Session Segment Max Sessions Limit- In the Portal Management page, you can specify the maximum number of sessions that any newly generated segment can contain.Live Max Results LimitorCompleted Max Results Limit- In the Portal Management page, these settings determine the number of sessions that can be displayed for any active or complete session search, regardless of the template setting.Auto Stop Limit- This setting defines the number of sessions that Search Server inspects per Canister before returning results. From an individual Canister, Search Server does not inspect more sessions for matches than the number configured for this setting. By default, this value is set to10000.
The maximum number of sessions displayed in a search result is the minimum of the applicable settings. The Live or Completed limit is applicable depending on the type of search and only in cases where the search generates a new result set.
- Results can be returned into existing result sets, where the maximum limits for the existing result are applied, instead of the current Portal settings.
Limits for searches executed from CX RealiTea Viewer can be configured in the RTV Search setup dialog.
Configuring session counts templates
In some cases, you might only be interested in the number of instances that the search criteria occurred. You can configure a session list template to return only the counts of found results.
- When searching for session counts only, the display of the results is faster; the search itself takes the same length of time.
- Even if you are only returning the session counts in the session list, the list of returned sessions can still be exported through the Portal.
To configure:
- Click the Session List Templates tab.
- Create or select the session list template to use.
- For the Maximum Matches value, enter 0.
- Select Total Matches.
- Select Server Metrics Table.
- Click Save.
Session list columns
Session list columns are used on session list templates, and they control what is displayed in the list of matching sessions. The columns can be used to display session attributes, compare session attributes to specified values, or flag for the existence of specific events or other attributes.
On the Search Template Configuration page, the All Columns button in the Template Search Columns pane displays a popup of the currently available columns.
Session list template columns have the following properties:
| Property | Description |
|---|---|
Title |
The title of the column, displayed on the session list. |
Type |
The type of session list template column:
|
Field |
The session field that the column uses for data. Note: The list of available fields depends
on whether standard or extended indexing is in use. |
Alignment |
Optionally, you can override the default alignment setting for the specific value type to be applied to the session list column by making a selection in the drop-down. |
Operation |
How the data is displayed or used:
|
Compare Value |
The value against which to compare the Field value. |
Events To List |
The set of possible events to list for the Event List Subset field. The listed events are the intersection of the events of each session and the supplied list for the column. To add or remove events, click the Add or Remove buttons above the list. |