The Tealeaf Portal provides a powerful search mechanism for finding relevant visitor sessions. You can use the search mechanism in the Portal to look for text that appears in the request or response data, as well as metadata included in each session.
Based on the criteria that you specify, the cxImpact search utility returns a list of matching sessions.
You can also search for sessions through the CX RealiTea Viewer, a desktop application for session replay.
Timestamps in search and reporting
Generally, the timestamps listed in the Portal are reported in the Tealeaf time zone, which is displayed in the upper-right corner of every Portal page.
For example, when you drill down from a report displayed in the Report Builder, the displayed time zones in the list of sessions are consistent with the times reported in the source report. However, for active search and for reports on active sessions, time information is reported in the time zone selected for the current user.
For example, if you are located in the Pacific time zone, creating and executing a search of today's sessions results in a list of sessions whose timestamps match to the current date in the Pacific time zone. In this manner, you can identify activity that is going on right now by comparing times in active data in the Portal to the time of your local desktop.
Time zone information is displayed in the Portal according to the following table.
Portal Activity | Time zone Used |
---|---|
Active Sessions |
User time zone |
Active Search |
User time zone |
Completed Search |
Time zone is specified in the search criteria. By default, the selected time zone is set to the User time zone. You can configure to search according to a different time zone. |
All Sessions Search |
Same as Completed Search. |
Report Drill-down |
Tealeaftime zone |
Working in the Search page
In the Search page, you can configure a search using the selected search template to look for active, completed, or all sessions that match the criteria you specify.
Each user can select the search template to use.
Search templates are created and configured by your Tealeaf administrator.
The following sections describe each functional area of the Search page.
Search Template
From the Search page, you can choose the search template appropriate for the search you are specifying. Typically, search templates are provided based on the type of session for which you are searching: Active, Completed, or All Sessions. You can also open saved searches, which automatically select the template that was used to create them. Search templates are defined and assigned by your Tealeaf administrator.
The currently selected search template is displayed as a hyperlink above the search panels. To select a different search template, click the search template hyperlink. The Template Selector is displayed:
Select the template to use in the Template Selector.
After you complete your search, the Search page remembers the last template that you used for the current type of search. If you switch from Active search to Completed search, for example, the Search page loads the last template used for Completed search.
Depending on whether you select an Active, Completed, or All Sessions search template, the available options for the following search features may change:
- Available search fields
- Search options
- Search scope
Search Template Types
Tealeaf monitors a visitor's interaction with a web application during a session. Tealeaf provides default templates for active, completed, and all session searches.
Template type | Description |
---|---|
Active |
From captured data packets, Tealeaf assembles requests from visitors to a web application and responses from the application to the visitor's browser. The requests and responses are combined into Tealeaf entities called hits. A sequence of hits for a specific visitor can be assembled into a representation of the visitor's session with the web application. While the visitor is interacting with your web application, the session is considered active, as hits are added to the session based on the visitor's continuing experience with the site.
Because sessions remain active only for a short period of time, the list of active sessions is constantly changing with new sessions starting and older sessions being completed and moved to the archive. If you are trying to solve a problem that is occurring with the web application right now, search active sessions for the most relevant session data. Note: The number of active sessions that you can search at any time is limited to a maximum of 150,000. Under various conditions, this maximum may be reduced, such as heavy usage of user-defined session attributes or memory resource limitations in the search process.
|
Completed |
When the visitor is no longer interacting with the site either due to a logout action or inactivity for a period of time, the session is no longer active, and Tealeaf closes the session. Tealeaf considers the session complete and saves it to the archive, which is also known as the Long-Field Canister (LTC), where additional indexing and processing functions are completed.
|
All Sessions |
Tealeaf users can search active sessions, completed sessions, or both.
|
Search Options
Each Search Template has its own search options. Depending on the type of search template that you select, the following options are displayed:
Search option | Description |
---|---|
Search Time Zone |
The Search Time Zone option is for Completed Sessions search only. For Completed searches, you can select the time zone to use for your search. When a different time zone is selected, the date and times that are applied to the search are defined regarding the selected time zone. By default, the applied time zone is the local time zone for the Tealeaf user. |
Session List Template |
Select the session list template to use with the current search. To use the one auto-assigned with the base search template, select |
Sort Results By |
The method by which to sort the returned sessions. This setting also determines the order in which sessions are matched against the search, which can impact the sessions that are returned if the search is aborted. The available options vary depending on whether you are using an Active or Completed search template. |
Search Servers |
Select one or more servers whose Search Servers are queried when the search is executed. |
Automatic Search Timeout |
The Automatic Search Timeout option is for Completed Sessions search only. The length in time that the search must run before stopping and returning any matched sessions. By default, this value is set to |
Automatic Stop Limit |
The Automatic Stop Limit option is for Completed Sessions search only. The maximum number of sessions that are found before the search is stopped and any matches are returned. This value is applied to each server. So, if your search is spanning four servers, the maximum limit is defined as four times this value. |
The Search Range field
When searching completed sessions, you can use the Search Range field to search for completed sessions within a specified range of time.
To search the widest possible date range of all sessions stored in all active Canister and Selective Archive servers, select Available Dates.
TltStsLastUse
session attribute.Tealeaf administrators can define the set of active Canister and Selective Archive servers in the Portal Management page.
Search fields
In the left panel of the Search Page, you can select the search fields to include in your search. You can include up to six search fields. Depending on the selected search template, one or more of the following groups of fields is available in the Search Fields panel.
Search field type | Description |
---|---|
Basic Search Fields | Free text search of each request or response in a session or search for specific events or both. |
Session Info | As hit data is captured, Tealeaf begins assembling and updating data pertaining to the individual session. |
Page Info | When a hit is captured, Tealeaf evaluates its contents and assembles information pertaining to the page or the entire hit. |
The Configuration window
In the Search Configuration window, you can specify the scope of the search and enter or select specific data for each of your selected search fields.
The Search scope
From the Search Scope field, you can select how the populated search fields are logically bound in the search.
Notes on AND Searches
When an event fires, it is recorded in the report database with the reference values at the time the event fired. When you drill into a hit-based report, a search is run to return relevant results, which may return session counts that do not match expectations based on the report data.
If you specify an AND search with only a single search term, the Portal automatically converts it to a single-term search so that sessions are returned.
Text searching is session-based. When a search is run, any session containing the dimension value and the event is returned, even if the dimension value on the hit where the event fired is different from the dimension value in the search. For this reason, a higher number of sessions may be displayed when drilling into the initial session list.
For example, suppose you have two 4-page sessions:
- Session 1 has page 1 with dimension value
App1
. On page 4, the value isApp2
whenEvent 1
fires. - Session 2 has page 1 with dimension value
App2
. On page 4, the dimension value isApp1
whenEvent 1
fires.
Suppose that you are viewing a report that identifies the occurrence of App2
on the first page of the session. When you click the drill-down link, the Portal essentially specifies the following search:
Event=Event 1 and Application=App2
Since search is session-based, the logical and
is applied to the entire session, not to the individual hit. When this search is run, both of Session 1 and Session 2 are returned, as Event 1
and App2
is displayed somewhere in the session.
The report data displays a count of 1 for Event 1
with dimension value App2
. However, when you drill down, two sessions are returned, because both sessions have dimension value App2
and Event 1
.
For the above example, you can generate search results through the Portal search interface that are consistent with the report data by specifying the search terms and the following conditions:
- Apply a logical
AND
- Specify the data/time range appropriately
- Apply
And on same page
in the search specification, if filtering a dimension value other than Path. By default,And on same page
is applied to searches by using the Path filter.Note: And on same page searches are available only for completed sessions.
Working with Search Configuration
Each search template has a list of search fields that are associated with it. You can add a search field by selecting the field in the list.
- You can add up to 10 search terms to a search.
- Fields can be selected more than once and specified independently.
- Fields left empty when the search is submitted are ignored. If no fields are specified, all sessions that are meeting the other constraints are returned.
- Searches by using Boolean search terms can be applied to a single session fragment only, as the underlying search engine is unaware of fragmentation. If the session contains multiple fragments, search results can be inaccurate. Through RTV, you can retrieve search results for one search term and then perform a search of the returned sessions for the other term.
NOT
operator, such as does not include
, on a search for field values can slow response time. The underlying search engine must retrieve all possible values for the field and then apply the NOT
to generate results.Depending on the type of search field, different configuration options are available.
Search optimization tips
If your search is taking a long time to complete, there are some things you can do to optimize its performance.
When you configure a search, the following tips can help return faster and better results:
- Searches of completed sessions are faster than active sessions because completed sessions are indexed.
- Avoid doing free text searches of the request or the response. Use keywords and provided search fields instead.
- For completed session searches, try to minimize the date range to only the relevant dates.
Search processing
When you click the Search button, the Tealeaf system performs a set of actions in sequence as described in the following list.
- The Portal passes the search query to the Report Server.
- The Report Server examines the query.
If the search spans multiple Search Servers, the Report Server farms out pieces of the request to the Search Server on each relevant Canister Server.
- Each Search Server examines its part of the request and determines the session indexes that must be searched.
- Those indexes are searched for matches.
- Information about matching sessions is retrieved from the indexes and sent back to the Report Server.
- The Report Server collates the results and delivers them back to the Portal for display to the user.
If you are searching across multiple servers, duplicate search hits and sessions are removed. The number of returned sessions reflects the number of unique sessions that returned, capped by the maximum permitted number of returned sessions. The number of sessions that are found is not adjusted to reflect any duplicate sessions that were found yet not returned due to the maximum number of sessions setting.
You can select individual Search Servers to query as part of your search criteria
Search keywords
Tealeaf includes search keywords. Review the search keywords available in Tealeaf and to understand how they are implemented in each storage mechanism.
Keyword | STC | LTC | In Default? | Description |
---|---|---|---|---|
All Text | C | Performs text search of indexed items in completed sessions, including text in request and response and event-based data. | ||
Annotation Authors | annoobject/name | C | Username of person who created an annotation is indexed along with the annotation. This search field lets you search for annotations by username. | |
Annotations | annoobject/text | C | In RTV, you can add annotations to pages during replay. These annotations are stored in a separate table and are indexed (caveat: sessions moved to an archive machine are not indexed). This search field lets you search the text of the annotation you entered. | |
AppData | request/appdata | request/appdata | A, C | [appdata] section of the request |
Bot Session | isbot | Is the session generated by a bot?
To capture data for this keyword, extended user agent detection must be enabled. |
||
Browser | browser | tltstsbrowser | The browser identifier as reported by the browser user agent. This value is stored in the Browser hit attribute.
To capture data for this keyword, extended user agent detection must be enabled. |
|
Browser OS | browseros | The operating system as reported by the browser user agent.
To capture data for this keyword, extended user agent detection must be enabled. |
||
Browser Type | browsertype | tltstsbrowsertype | A | Type of browser |
Browser Version | browserversion | The version of the visitor's browser
To capture data for this keyword, extended user agent detection must be enabled. |
||
Client IP (IPv4 legacy) | ipaddr | tltstsipaddr | A, C | Visitor's Internet Protocol address (aaa.bbb.ccc.ddd)
|
Client IP (IPv6) | ipv6_remote_addr | C | Visitor's Internet Protocol address in IPv6 format (aaaa.bbbb.cccc.dddd.eeee. ffff.gggg.hhhh) | |
Client UI Application | request/appdata/TLT_CUI _APPLICATION_NAME | TLT_CUI _APPLICATION_NAME | The application name as reported by UI Capture. To capture data for this keyword, extended user agent detection must be enabled, and the CX UI Capture for AJAX must be deployed and enabled. | |
Client UI URL | request/appdata/TLT_CUI_URL | TLT_CUI_URL | The URL as reported by UI Capture. To capture data for this keyword, extended user agent detection must be enabled, and the CX UI Capture for AJAX must be deployed and enabled. | |
Domain | domain | TltStsDomain | A, C | Domain from which the visitor is visiting |
Env | request/env | request/env | Search for data in the [env] section of the request. | |
Events | uniqueid | tltstsuniqueid | A, C | Search for named events in active and completed sessions. |
Events with dimensions | factidwithdims | hit//TLFID_{0}/TLDimHash{1} | A, C | Search for events by name with dimensions. |
Event Count | numevents | Counts of occurrences of events. | ||
Event Values | hit//TLFID_{0}/TLFactValue | Values of Tealeaf events | ||
Fact Count | numfacts | Count of recorded facts in the session | ||
First Page | frstpage | tltstsfirstpage | A, C | The first page of the session |
Form Field | request/urlfield | request/urlfield | A, C | Form field data in the request |
Hit Count | numhits | tltstsnumhits | A, C | The number of hits in the session |
Last Page | lastpage | tltstslastpage | A, C | Last page of the session |
Page Generation Time (usecs) | request/timestamp/WS_generation | A | Time required to generate the page on the visitor's browser in milliseconds | |
Page Size (bytes) | request/env/responsedatasize | A | Size of the page in bytes | |
Page URL | request/env/url | url | A, C | URL of the page |
Referring URL | referer | http_referer | C | URL of the page from which the visitor accessed the current one |
Server IP Address (IPv4 legacy) | request/env/LOCAL_ADDR | local_addr | A, C | The Internet Protocol address of the web server.
Maintained for legacy purposes. Use |
Server IP Address (IPv6) | request/env/IPV6_LOCAL_ADDR | ipv6_local_addr | C | The Internet Protocol address of the web server in IPV6 format. |
Session Attribute | customvarX | tltstscustomvarX | Search for user-defined session attribute with index number X.
Session attributes are defined through the Event Manager and are updated based on Tealeaf events. |
|
Session Duration (secs) | tltstssesnduration | The length of the session in seconds | ||
Session Index | sesnidx | tltstssesnidx | A, C | Identifier of a session within a canister. Typically it is a number like 1 or 469683648. |
Status Code | statuscode | C | The HTTP status code for the page | |
Text In Request | request | request | A, C | Active: Searches entire request for matching strings Completed: Search indexed values in name/value pairs of the request. |
Text In Response | response | response | A, C | Active: Searches entire response for matching strings Completed: Search the response text that is not HTML tags. This content is indexed. |
TLT Application | tlt_application_name | The value of the TLT Application field, as defined in Tealeaf. | ||
TLT Host | tlt_host_name | The value of the TLT Host field, as defined in Tealeaf.
To capture data for this keyword, the Tealeaf Reference session agent must be deployed in your Windows™ pipeline. |
||
TLT Path | tlt_url | The value of the TLT Path field, as defined in Tealeaf.
To capture data for this keyword, the Tealeaf Reference session agent must be deployed in your Windows pipeline. |
||
TLT Server | tlt_server | The value of the TLT Server field, as defined in Tealeaf.
To capture data for this keyword, the Tealeaf Reference session agent must be deployed in your Windows pipeline. |
||
TLT Session ID | sesnid | tltstssesnid | A, C | The value of the session identifier |
TLTVID | tltvid | tltststltvid | The value of the visitor identifier | |
Traffic Type | tltststraffictype | tltststraffictype | A,C | The type of traffic, such as MOBILE , BOT , or BROWSER . |
User ID | userid | tltstsuserid | A, C | The user identifier, as defined by the web application |