Change File for Label: instanceName dialog box

File/Pipe Name

displays the full path and name of the file, script, binary, or named pipe being monitored

Logical Name

displays the logical name for the LOGMON instance that you want to change.
The instance logical name is stored in the pconfig variable located at /PMG/CONFIG/label/actLogicalName. An event is generated with the logical name and the file name of the instance.
If the instance type is Static, both the logical name (which you just specified) and the LOGMON instance name are displayed. If you do not specify a logical name, the pconfig variable remains blank.
If the instance type is Rolling or Dynamic, then the logical name is added to the file name displayed.

Contains Environmental Variables

Select this check box to enter a path defined by an environment variable that is resolved at runtime. For example, if you enter %HOME%/log.txt in the File/Pipe Name text box and select this check box, the KM substitutes the path defined by %HOME%. If the box is unchecked, the KM tries to find a path called %HOME%.

File Type

specifies the file type that you selected from the Text File, Script, Named Pipe, XML File or Binary File type options.

Filter Program

If the file type is Binary File, this text box specifies a filter program to read the monitored binary.

Always Read at Beginning

Select this check box if you want the product to always read the entire binary file, rather than just the information added since the last time the file was scanned.

File Disposition

If multiple files match the File/Pipe name (for example, if you use a regular expression), select whether you want to monitor only the Latest file or All of the files.

Generate Alarm if File not modified in

Select this check box if you want the LOGMON instance to ALARM if the monitored file is not modified periodically.

Minutes

When the Generate Alarm if File not modified check box is selected, this text box specifies the time in minutes after which an alarm will occur if the file is not modified.

Default setting for search criteria

This section in the dialog box displays the defined search criteria settings at the global level. These are default settings and are common to all the search criteria, unless you override the same for a search criterion in the Configure Search Criteria: instanceName dialog box.

Threshold #1

displays 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 search string must occur 3 times in the monitored file before the KM goes into the state specified by the State list.

State

specifies the state that the KM will 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 to 3 and select Alarm from the State list.

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. For example, if you set the Threshold #1 to alarm when 3 occurences 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 text box.

State

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

Custom Event Message

(optional) specifies the message text that you want displayed when your search string conditions are satisfied
To change how the KM handles custom events, see Changing configuration settings by adding variables.

Custom Event Origin

specifies the customized origin for events
If you do not specify the origin, the product uses the instance name as the default origin of events.
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.

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.

Number of Lines in Log Entry

specifies the the number of lines that you want to be displayed when a match is found
For example, if you want to determine when a disk is full and where the disk is mounted, enter Error: Disc Full as the search string and 2 as the value of Number of Lines in Log Entry. When a disk is full, a message similar to the following one is displayed in LOGMatchString text parameter:
Id=id1
031605: Error: Disc Full
Id=;MatchedLines
/hd001 mounted as /opt
SUMMARY:id1=1;
Note: If either, the search string or the nullify string, occurs again within the number of lines selected to be displayed, the KM does not find the instances of the search strings for all the search identifiers.

Nullify Alarm/Warn String

displays the string that is used to nullify the alarm for the dual-search feature
You can configure dual search for an instance so that the KM goes into the alarm state when any of the search criteria is found in the monitored file and nullifies the alarm when the nullify string is found in the monitored file. You must specify the first string in the String1 text box (in the Configure Search Criterion: instanceName dialog box) and the nullify string in the Nullify Alarm/Warn String text box.
For example, if you specify 'Alarm up' in the String1 field and 'Alarm down' in the Nullify Alarm/Warn String field, the KM goes into alarm state when 'Alarm up' is found in the monitored file and the alarm is nullified when 'Alarm down' is found in the monitored file.

Once closing root-tag is found, Delete instance after… Minutes

specifies an interval in minutes during which the product does not delete an instance even if the closing root-tag is found.
After the specified time elapses, the product will delete the instance for which the closing root-tag is found.

Return to OK if no match found on next scan

indicates whether the KM state returns to OK if the search conditions are not met on the next scan

Scan Priority

displays the scan priority for the file

Accept

Click this button to save the properties and close the dialog box.

Cancel

Click this button to close the dialog box.