Configure Search Criterion for XML file dialog box


Note

The XML Files monitor type is not supported any more.


The Configure Search Criterion for XML file dialog box allows you to configure multiple search patterns while adding an instance. In addition, you can modify the search criterion using this dialog box. To access this dialog box, either click Continue in the Add File for Label: instanceName dialog box or navigate to Modify > Search Criteria from the LOGT application class menu. For more information about accessing application class menus, see Accessing KM menu commands.

Procedures related to this dialog box

Items on this dialog box

Item

Description

XML File Name

Displays the log full file path that will be monitored against the multiple regular expressions that you provided

Search Criterion

This section in the dialog box allows you to define search criterion settings for an individual search criterion. Using this section, you can override the settings for a search criterion defined in the Add File for Label: instanceName dialog box.

Search Identifier

Enter an identification label for the search criterion. This must be unique for an XML instance. You can use the same search identifier in other XML instances, but not in the same XML instance.
You can only use alphanumeric characters such as a-z, A-Z, 0-9, and up to a maximum of 20 characters.
This label appears in the search list and helps you identify the search criterion.

XML Search String

Enter the combination of XML elements and values that you want to find in the monitored file. For configuring XML search strings, see Rules-for-entering-XML-search-strings.

Override default settings

Select this check box to override the default setting for the search criterion that you have specified in the Add file for Label: instanceName dialog box.

Threshold #1

Enter the number of search string matches that must occur before producing a specified state. For example, if the Match Count field value is 3, the text search string must occur 3 times in the monitored file before the KM goes into the state specified by the State list.
This threshold overrides the default threshold specified in the Add file for Label: instanceName dialog box, if you select the Override default setting check box.

State

Select the state that you want the product to exhibit when the Threshold-Match Count value is reached - None, OK, Warn, or Alarm. For example, if you want the KM to go into Alarm if the search string is found 3 times in the monitored file, then you would set the value of Threshold #1: Match Count to 3 and select Alarm from the State list.
This state overrides the default state specified in the Add file for Label: instanceName dialog box, if you select the Override default setting check box.

Threshold #2

If you want the KM to exhibit a second state when a different number of search strings occurs, enter the number of matched search strings in this text box.
Threshold #2 should always be higher than Threshold #1.
For example, if you set the Threshold #1 Match Count to alarm when 3 occurrences of the search string are found and you want the KM to warn when 1 occurrence of the search string is found, enter 1 in the Threshold #2: Match Count text box.
This threshold overrides the default threshold specified in the Add file for Label: instanceName dialog box, if you select the Override default setting check box.

State

Select the state that the KM will exhibit when the Threshold#2 Match Count value is reached - None, OK, Warn, or Alarm.

Custom Event Message

Enter the message that you want to get displayed when the search criteria are satisfied. For more information, see Customizing event messages.
This message overrides the default message provided in the Add file for Label: instanceName dialog box.

Custom Event Origin

Specify the customized origin for events. If you do not specify an origin, the KM uses the default origin, which is APPCLASS.INSTANCE.textFileName. You can use built-in macros (except the %x-y macro) as the customized origin for events.
For more information about built-in macros, see Customizing event messages.
This origin overrides the default origin provided in the Add file for Label: instanceName dialog box.

Ignore duplicate events for next ... Minutes

specifies an interval in minutes during which the product does not generate an event after the first match and its corresponding event
After the specified time elapses, the search criteria generate an event for the next match.

Search list

The search list displays the entered search criteria. It also displays whether the search criteria is valid or invalid. Each search string added gets appended to the list of search strings. The product populates the search strings in the list with every update.

Add

Select this option to add a new search criterion to the search list.

Delete

Select this option to delete a search criterion from the search list.

Modify

Select this option to view and modify a search criterion from the search list.

Discard changes

Select this check box if you want to revert all changes made in this dialog box and use the original search list.

Update

Updates the search list with the addition, modification, or deletion of a search criterion

Related topic

LOG

 


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*