StoreGazer Event File Definitions

StoreGazer 4690 Event Parameters

StoreGazer uses two main files to determine which actions to take when a monitored event is triggered. These two files are 'edjgazer:evntfile.dat' and 'edjgazer:actnfile.dat'. When a message occurs on a 4690 controller, and it matches the filter(s) defined by an event rule in the event file, EDJAgent can execute one or more actions. The basic event file structure contains a number of rules, with each rule defining what characteristics to look for in an incoming message.

If a system message meets all of the parameters defined within a rule, the corresponding action(s) will be executed. If an event contains more than one action, the list of actions should be comma-delimited. Each system message will pass through all of the rules defined in the event file. Thus it is possible for multiple actions to be triggered by a single message. The only restriction is that no single action will ever be executed twice by one system message. Listed below are the parameters accepted within the event file, as well as their descriptions.

The following table contains all of the recognized event file parameters.

Rule An identification number used in distinguishing events from each other [Range: 1 to 999]. This parameter always appears at the beginning of a new rule, and is easily distinguished from all other parameters since it must be contained within brackets.
NodeID The ID of the controller the message must occur on. This will typically be CC, since CC is the controller most actively monitored. If this parameter is left out of the rule definition, messages from all controllers that pass through the message pipe will be accepted. There are several wildcards that can be used in this field:
  • AA - Check if the message was logged from the acting master.
  • AB - Check if the message was logged from the acting alternate master.
  • AC - Check if the message was logged from the acting file server.
  • AD - Check if the message was logged from the acting alternate file server.
Message

The message field can be used to provide one or more 4690 messages that the rule will monitor. If multiple messages are required, use a comma-delimited list (Example).

Each message can be preceded by an 'X' to indicate exclusion (Example).

The message field supports the '*' and '?' wildcard characters. (Example).

Event The event number of the system message. Example.
Source The source number of a system message.
Severity The severity of a system message. Any system message with a severity of this or lower will be accepted. Keep in mind that the lower the value of the severity, the more severe the message is. Example.
Terminal

The terminal number field of a system message. It can be used in two different ways

  • If the 'Max Terminal' parameter is not used within this rule, the terminal in the system message must match this field. Example.

  • If this parameter is used along with the 'Max Terminal' parameter, it is used as a floor value to determine if the terminal field of the system message is within the limits of the 'Terminal' parameter and 'Max Terminal' parameter. Example.
Max Terminal This parameter is used with the 'Terminal' parameter. If the terminal number field in the system message is greater than or equal to the value of 'Terminal' and less than or equal to 'Max Terminal', it will pass. Example.
Ascii Data The unique data field of the system message. Example.
Hex Data The hex data field of the system message.
Frequency

This parameter can be used in multiple ways

  • If the frequency is set to 0, this parameter is used in conjunction with the Start/Stop Time parameters. If no matching system messages occur within the provided Start/Stop times, the action(s) will be executed. Example.
  • If the frequency is greater than or equal to 1, it will be used along with the interval parameter. If the system message specified by this rule occurs a defined number of times (frequency) within a defined period of time (interval), the action will be executed. (Example 1) (Example 2).

(Note: If the frequency is set to less than 0, it is treated as if it equals 0. This ensures backwards compatability.)
Interval This parameter provides a time interval (in minutes) that is used with the Frequency parameter. If the system message specified by this rule occurs a defined number of times (frequency) within a defined period of time (interval), the action will be executed. If this value is omitted when using a positive frequency value, it defaults to an infinite period of time. Example.
Start Time/
Stop Time

The Start/Stop Time fields can be used to place time restrictions on rules or to set off timed events. The times can span midnight and are formatted for military time with no separators. Depending on the presence of the 'Frequency' and 'Day' parameters, the Start/Stop Time fields can be used in multiple ways.

  • If the 'Frequency' parameter is non-existent or if it is greater than 0:
    If the specified event occurs between the provided Start and Stop times, the action will be performed. If it occurs outside of these boundaries, it will be ignored. Example.
  • If the 'Frequency' parameter is set to 0:
    If the specified event does not occur between the provided Start and Stop times, the action will automatically be performed as soon as the time expires. Example.
  • If the 'Day' parameter is used:
    The 'Day' parameter can be used in conjunction with either of the above cases to specify a specific day of the week for the event to occur on (Example), or to exclude a day of the week (Example).
Day This parameter can be used to indicate the day(s) of the week that a rule should be monitored (Example). It can also be used to exclude day(s) of the week (Example). The possible values are Sun, Mon, Tue, Wed, Thu, Fri, and Sat.
Date This parameter can be used to specify the date(s) that a rule should (or should not) be monitored. The dates should be provided in a comma-delimited list in mm/dd format. An 'X' may precede the date if date exclusion is required (Example).
Exclude

This directive can be issued to indicate that any system message that passes the current rule should be excluded. It is different from the other parameters in that it does not require a value. It can be set to 'true', '1', etc. This field can be used in multiple ways:

  • If no action id is provided, no actions will be performed on this system message (Example).
  • If one or more action id's are provided, only those actions will be prohibited from running (Example).

(Note: Exclusion messages should be defined before all other messages in the event file.)
Action ID The ID of the Action to be performed (as defined in the Action File). If multiple actions are required, use a comma-delimited list (Example).


EDJ Enterprises, Inc.
3125 Poplarwood Court, Suite G110
Raleigh, NC 27604-1020
919.790.7711 phone
919.790.0123 fax
storegazer@edj.com