Event Definition Dialog Controls
Wild Card Characters in Events
The figure below is the Event Definition dialog.
Refer to Using Vantage Dialogs to learn about Vantage dialogs. Each control on the dialog is explained in the text that follows.
Event Definition Dialog Controls
Search for Event String:
This control is used to specify the actual event Vantage should "watch for". The event can be any character string that will be displayed on the console of the resource being monitored. The wild card characters #, ? and @ can be used in the event string. Refer to Wild Card Characters in Events to learn about using wild card characters. It is important to be very specific when defining events, as information typed in this control is case sensitive, i.e., ABORTED is not the same as Aborted. Click the control and type the event string.
Starting At Column:
This control allows specification of the column in which the event should be detected. The default for the Starting At Column is 0. A 0 means that the event will be detected anywhere it appears in the data stream. If it is necessary to define an event that will begin in a specific column and the event is to be detected only if it begins in this column, click the control and type the column number.
Span N Lines:
This control allows specification of the number of lines the event may span. The Span N Lines control is used if the event may to span more than one line. If the event spans more than one line it must be detected within 256 bytes from the beginning of the event. Click the control and type the number of lines in which the event should be detected.
Execution Priority:
This control is used to specify when the event response should be executed. The default execution priority is "Wait Until EOL" which means that the event response will not be executed until Vantage receives the EOL Char defined for the resource. The "Immediately" selection means that the event response will be executed immediately upon event detection without waiting for the EOL char. Click to select a value other than the default.
Execution Frequency:
The "Execution Frequency" control allows "throttling" of responses to control the number or frequency of executed event responses. The default, "Always Execute Response", will execute the event response every time the event is detected. "Never Execute Response" will not execute the response but will log the detection of the event. "Execute Response Every nth Occurrences" means that one event response will be executed for every 'n' occurrences of the event. The "Only Execute Response x Times In y Minutes" allows execution of an event response a specific number of times in a specific period of time. Click the appropriate control or click and type to select a value other than the default.
Log Executed:
If the event is to be throttled this control allows a choice as to how many occurrences of the event's detection will be logged to the broker's log file. The default, Log Executed, will log the event only if it results in the execution of the event response.
Log All:
If the event is to be throttled this control will change the default to log every occurrence of the event regardless of whether the event response was executed. Click to select a value other than the default.
On Resource or Group:
This control allows selection of the resource or Group of resources upon which the event is to be detected. Click to select the resource or group name.
Event Response:
This control enables selection of the action Vantage should take when the event is detected. With the exception of the NED Filter event responses, clicking an event response will open a separate dialog that will prompt for more information.
The NED Filter event responses do not require an additional dialog so, when all controls are as desired, click Add to add a new NED Filter event or click Modify to modify an existing event.
Select one of the underlined phrases below to see an example and explanation of a specific event response dialog.
Refer to Message Definition , Message With Reply Definition , Voice Definition , Command Definition , Command File Definition , Report Definition , Report With File Definition , API Exec Definition , E-Mail Definition , NED Filter No Logging , or NED Filter With Logging to learn more about the event response.
See also Configuring Remote Access and Operating Vantage
Wild Card Characters in Events
Wild card characters can be used to speed event definition. Three wild card characters are available and have the following significance:
? - one alphanumeric character
# - one numeric character
@ - one or more alphanumeric/special character(s) or space(s)
If one of the special characters must be detected literally, the special significance must be escaped (ignored) by preceding the character with a \ when defining the event. To illustrate the use of wild card characters, please assume the following lines of output.
6:06/#J15121/349/JOB #J7099, LOGXLJ,MANAGER.SYS Abended
8:21/#J15121/349/JOB #J7135, YECORR,YGUMINT.TEAK Abended
8:47/#J15121/349/JOB #J7140, YOYO,YGUMINT.TEAK Abended
To define an event that will detect the line above that contains the text "YECORR,YGUMINT.TEAK" the event could be defined as follows:
J?? \#J@, ??C???,
J?? will find a string beginning with a J followed by two alphanumeric characters and a space.
\# will detect a literal # character. Preceding the # character with a \ means that the special meaning of the # is ignored.
J@, will detect the letter J followed by any characters ending in a comma.
??C???, will detect a string beginning with two alphanumeric characters followed by a C and three more alphanumeric characters and ending in a comma.
Adding or modifying an event that contains a special character will display a warning dialog asking that you verify your intentions. Click No to accept the special meaning of the wild card characters. Click Yes to escape the special characters and have the characters detected literally.
