Template types

Each system or custom template file can contain multiple templates. Depending on the type of sessions (active or completed), you must edit the appropriate template.

RTV cannot be used to complete All Sessions searches. You must search by using an Active search template or a Completed search template.

The template file contains comments that explain how to edit the file and the meaning of the names. The default template declaration nodes look like:

<Template Name="Default" Type="standard">
<Template Name="Default" Type="active">

Standard templates are used for searches of completed sessions under standard indexing. Active templates are used for searches of active sessions; indexing does not apply.

The following examples show templates to search for text (login ID) and numbers (hit count).

Text field example

This example specifies a text field to include in a completed search template. The field value indicates the index field to search for values that are specified by the user.

<FieldSearch title="Login ID" description="Login ID" 
  field="TltStsLoginID" type="text" operator="contains" selected="true" />

where:

• type, in this example, is text.
• operator: Specifies the operator to apply to the field. For this text example, the search operator is contains.
• selected: When set to true, the field is preselected when the search tab is opened by the RTV user.

Numeric field example

This example specifies a numeric field to include in a completed search template. The field value indicates the index field to search for values that are specified by the user.

<FieldSearch title="Hit Count" description="TltStsNumHits"
            field="TltStsNumHits" type="numeric" operator="all" 
            maxValue="4096" />

Where:

• type, in this example, is numeric.
• operator: Specifies the operator to apply to the field. Accepted values:
  • all (recommended setting)
  • =
  • not
  • >=
  • <=
  • between
  • not between
• maxValueThe maximum value for the numeric value.
  • By default, this setting is configured to be the largest value possible for a signed 32-bit integer, which corresponds to the upper bound accepted by the search engine.
  • If you know that a value is never greater than a specific number, the search is more efficient if you set maxValue to that number.

Customizing session attribute fields in the search template

You can add search fields for specific session attributes. A session attribute is a user-defined variable that is populated by an event. Tealeaf supports the creation of up to 64 session attributes.

• Session attributes are specified at the search template level by using search keywords that include a zero-based index number to the specific attribute. Numbering is as follows: 0, 1, 2, and on through 63.
• Session attributes can also be added to Portal search templates.

Complete the following steps to add a session attribute to the default completed search template for RTV:

1. Open the system-wide SearchBuilder template file and find the appropriate template to edit.
2. Locate the section labeled <Template Name="Default" Type="standard">.
3. Locate the grouping that holds all of the User Defined Fields depending on the type of search. If the following does not exist, insert it:

   
   <Group title="Session Attributes" description="Session Attributes">

4. Insert the following XML into the template, changing it as needed for these examples.

   • 
     <FieldSearch title="Login ID" description="Login ID"
                 field="tltstscustomvar0" type="text" 
                 operator="contains" HTMLcolsize="40"/>
     

   • 
     <FieldSearch title="Session Attribute 03" 
             description="Session Attribute 03"
             field="customvar3" type="text" operator="contains" HTMLcolsize="40"/>
     

     Attribute	Description
     title	This value appears in the RTV Search Builder.
     description	This value appears when the search term is moused over.
     field	This value identifies the index term for the session attribute. The above value (tltstscustomvar0) is the reference LTC index keyword for Session Attribute 00.
     type	The session attribute's type of value. Accepted values are text and numeric.
     operator	The operator for the search field
     HTMLcolsize	(optional) The width of characters of the textbox for data entry

   • Edit the attributes as needed.
   • Save the file.
   • Close and open RTV to see your changes.
   • In RTV, load the search template from the server.

Session attribute search configuration terms

Depending on the type of search template you are configuring, you must specify session attribute search configuration terms by using the following keywords.

Request search configuration

You can configure RTV search fields to scan fields or sections of the request, or the entire request.

For example, critical session data can be inserted into the [appdata] section of the request, since this section is automatically indexed. In the examples below, you can see how to configure RTV to search the request, the [appdata] section, or a specific field in the [appdata] section.

Field to search entire request

<FieldSearch title="All Request" description="All Request" 
  field="request" type="text" operator="contains" selected="true" />

Field to search the [appdata] section

<FieldSearch title="AppData" description="AppData" 
  field="request/appdata" type="text" operator="contains" selected="true" />

Field to search for a value in the MobileDeviceType variable in the [\appdata] section

<FieldSearch title="Mobile Event" description="Mobile Event" 
  field="request/appdata/mobiledevicetype" type="text" 
  operator="contains" selected="true" />

Form field search configuration

Field Search specifies a form field to include in the template.

<FieldSearch title="FormField" description="FormField" 
  field="formfield" type="formfield" />

IP address field configuration

For completed session search templates, you can insert the following fields to enable RTV users to search for IP addresses among completed sessions.

<FieldSearch title="IP address" description="ipv6_remote_addr"
field="ipv6_remote_addr" type="text" operator="contains" />
<FieldSearch title="IP address (legacy)" description="TltStsIPaddr"
field="TltStsIPaddr" type="text" operator="contains" />

Word search configuration

Word search passes the specified search string directly to the search engine, bypassing the field contains value form structuring. When used with the hidden_text type, a search template can contain search entries that are submitted without any user input.

<WordSearch title="ASP Errors" description="ASP Errors" field="freetext"
  type="hidden_text" textValue="(response contains (error w/5 ASP))" />