Skip to main content

Search, replay, and session administration

Search, replay, and session administration

Available template properties

The following properties are available in the default templates for Active and Completed sessions.

The available properties for a search template are listed below. Each property on the template is a default setting, which users can change at the time of the search, if enabled by permissions:

Property Description
Name The name of the template.
Search Type The type of sessions that can be searched using the template: Active, Completed, or All Sessions.
Date Span The date range over which the search template covers.
Scope How selected fields are applied to the search:
  • AND - Same Session - The search returns sessions that match all specified fields.
  • AND - Same Page - The search returns sessions that have individual pages matching all fields.
  • OR - Any Session - The search returns sessions that match any of the fields.
Sort By How the matching sessions are sorted.
Timeout The maximum amount of time allotted for the search.
Auto Stop The search automatically stops after opening the number of sessions defined by this property.
Session List Template The Session List template in which to display the results returned when a search is executed with this search template.
Search Servers The search servers to select for searching by default.
Notes If specified, the notes appear as an informational textbox above the search fields on the search page.

To insert a newline in the Notes textbox, enter \n. These text strings appear as-is in the Notes textbox. You can press Enter in the textbox to make the notes more legible.

Available search fields

Note: Depending on the type of search template, some search fields may not be available. For All Sessions search templates, you may add search fields only if they are applicable to both active and completed search templates.
Note: Fields that have been encrypted using privacy rules in the CX Passive Capture Application or Windows™ pipelines cannot be decrypted in the Portal.
  • These encrypted fields can be decrypted only during replay.
  • As an alternative, you can leave the configured fields in unencrypted state in the session data and then define privacy rules specifically to be applied during session replay, permitting the display of the unencrypted data in the Portal, as needed.

Text

For completed sessions, you can search for text strings contained in requests, responses, and other derived data. The text strings can include different search patterns to further restrict the search.

Note: Free text searches can be expensive to complete. These search fields should be included only where other indexed search field options are not available.
Text string type Description
All Text When searching completed sessions, you can search for a text string in any part of the session data, including the request, the response, and any derived data such as events or custom user-defined fields. This data is indexed using the dtSearch software program, so any of the search options provided by dtSearch are available. The following patterns are supported:
  • * Wild character. For example, C* matches both CC and CAT.
  • { } Matches any character contained within the bracket.
  • ^ Represents the beginning of the line. For example, ^T searches for any line starting with a T.
  • $ Represents the end of the line. For example, error$ returns any line ending with error.
  • \ indicates to emphasize the subsequent character in the search.
Text in Request You can search for a text string in the request portion of a hit in completed sessions. The above patterns are supported.
Text in Response You can search for a text string in the response portion of a hit in completed sessions. The above patterns are supported.

Events

During processing of sessions, Tealeaf events are triggered based on visitor session data. The data derived from events is stored with the actual hit and session information and may be searched like captured data.

Events may be associated with one or more dimensions, which enable the reporting of event data across multiple axes.

  • Users of the search template may select the dimension or dimensions associated with the event to search as part of the query.
  • Dimensions are created in the Event Manager.

Input type for events

Search fields for events may be configured to use one of the following input types:

Input types Description
Event Selector Template user may select any accessible event.
Pulldown Template user may select an event from a pull-down menu that you populate. You may also specify default values.
Radio buttons Template user may select an event by clicking a radio button from a set that you define. You may also specify default values.

Event values

You can specify fields that enable search for specific event values. Users may select the event and value for which to search or use the default ones you specify.

Field Description
Default Event Click the link to select the event to use as the default event for this search field.
Default Value Enter the default value with which to populate the search term. No data validation of the default value is performed.

Event values may be specified using different kinds of input types.

Values for events are stored in a data entity called a fact in the request buffer.

Search field properties

You can modify the following properties for your new or edited search field:

Property Definition
Title The title of the search field.
Input Type The types of input the search field can use. This value affects how the search field is displayed and the users who are allowed to use it.
  • Free Text - The user is presented with a textbox and can freely enter text. The textbox is populated with the contents of the Default Value property.
  • Pulldown - The user is presented with a drop-down of specified values from which to select. The default selected item is specified by the Default Value property. The items in the drop-down are controlled by the Values property.

    You can specify empty values. If the user selects the label corresponding to an empty value, the field is not submitted as part of the search.

  • Radio Button - The user is presented with a list of radio buttons of specified values from which to select. The default selected item is specified by the Default Value property. The items in the drop-down are controlled by the Values property.

    You can specify empty values. If the user selects the label corresponding to an empty value, the field is not submitted as part of the search.

  • Prebuilt Query - You can enter a preconfigured query in one of the following text boxes:
    • Query - If the search field is selected to be included in the search by a user of the template, this query is used in the search.
    • Inverse - If the search field is selected to be not included in the search by a user of the template, this query is used in the search. If this query is not specified and the user selects not included, a negated version of the Query value is used.
  • Form Field Input - This value is only used with the Form Field keyword. When it is used, the user is presented with two text boxes: one for a field and one for a value. The text boxes are populated with the values of the Field and Value properties, respectively.
    • Hide Field Input - If this is enabled, the field input for a form field is hidden, and the default is used. This feature can be used to restrict a form field search to a specific field and to permit only an input for the value.
  • Event Selector - This Input Type value is only used with the Events keyword. When it is used, it provides the user with the Event Selector pop-up when the field is selected.
Keyword The actual search keyword to use when this field is selected.
MD5 Hashing For search fields that match against text, this option hashes the value the user inputs before generating the query. This feature allows a user to enter plain text to match against an indexed field that has been MD5 hashed to clean or obfuscate data.
Default Value The default value to use when the search field is selected. This value changes depending on the Input Type. For event and event value fields, you can select the default event for the field.
Values When the Pulldown and Radio Button Input Types are selected, the Values property is enabled and contains a list of the displayed values from which the user can choose.
Description Description for the field. The maximum length is 1024 characters. This description is displayed as a tooltip for the field.

Selecting keywords

The available items correspond to search keywords used when building the actual query. For example Event corresponds to tltstsuniqueid in Completed Search Templates.

Some keywords are not compatible with the current template type. When you select an incompatible keyword, the Keyword: marker indicates that there is an issue. Mouse over the Question Mark (?) icon to review the issue.

If you have an incompatible keyword, you cannot save the search field until the issue is corrected.

Search field modes

A search field added to a template has a mode: Available, Recommended, and Required.

Note: To select the mode for a field, click the icon next to the search field.
Mode Description
Available The field is not displayed but can be used in a search. This is the default mode of a search field that is added to a template.
Active The field is displayed and populated with a pre-configured default value. An active field can be removed from a search. An empty active field will not be included in a search.
Required The field is displayed and populated with a pre-configured default value. A required field cannot be removed from a search. A required field must contain a value or valid selection when the search is performed.

Related articles

community icon

Join the community

Ask questions, share best practices, and connect with fellow marketers.

Ask a question

Academy

Read how-to articles, guides, and more to help you on the path to success.

Learn more