Arguments

The keywords describing an event rule are the following XML tags:
eventRule
It includes:
  • A number of required and optional rule attributes.
  • One event condition.
  • One action.
The rule attributes are:
  • Required attributes:
    name
    The name of the event rule. You can specify up to 40 characters, blank and special characters included. It is a label making easier to identify each rule in the XML file. Configuration files do not contain this data.
    ruleType
    Always set to filter.
    isDraft
    Values can be yes or no. Specify no to activate the corresponding rule definition. Specify yes to deactivate the corresponding rule definition or to check its syntax without activating it. The default is no.
  • Optional attributes:
    description
    A description of the rule. It can be of up to 120 characters.
eventCondition
The event condition is made up by the following attributes:
eventProvider
Identifies the event monitoring provider that can capture a type of event. SMF only is currently supported.
eventType
Specifies the type of event that is to be monitored. Table SMF events lists the valid types. Click the event types to see their properties.
Table 1. SMF events
Event type Event trigger
ReadCompleted A data set is closed after it was opened in read mode.
ModificationCompleted A data set is closed after it was opened in write mode. This event is sent also when you create an empty data set.
filteringPredicate
To filter the event conditions that are to be monitored. It is made up by:
attributeFilter
The attribute filter is a particular attribute of the event that is to be monitored:
  • It is defined by the following elements:
    name
    The attribute, or property name, of the event that is to be monitored. Refer to Parameters of ReadCompleted and ModificationCompleted event types for a list of the supported property names.
    operator
    Always set to eq (equal).
  • It includes a list of:
    value
    The value on which the operator must be matched. You can specify up to 15 values.
    Items in the value list works with the same behavior as the OR operator in the boolean logic.
Items in the attributeFilter list works with the same behavior as the AND operator in the boolean logic.
action
The action that is to be triggered if the event is detected. Event rule definitions with events but no actions are syntactically accepted, although they may have no practical significance. You may save such rules as draft, by specifying isDraft="yes", and add actions later before they are deployed.
  • Is defined by the following required attributes:
    actionProvider
    The name of the action provider that can implement one or more configurable actions. Tracker only is currently supported.
    actionType
    Specifies the type of action that is to be triggered when a specified event is detected. SpecialResourceEvent only is currently supported.
    responseType
    Specifies when the action is to run. Always set to onDetection, meaning that the action starts as soon as all the events defined in the rule have been detected.
  • Includes the following optional attributes:
    description
    A description of the action. It can be of up to 120 characters. It is a label making easier to identify each action in the XML file. Configuration files do not contain this data.
  • Includes a list of one or more parameters, or property names. Every parameter is defined by:
    parameter name=" "
    See Parameters of SpecialResourceEvent action type for a list of the supported parameters, or property names.
    value
    See Parameters of SpecialResourceEvent action type for a list of possible values or value types.
Parameters of ReadCompleted and ModificationCompleted event types shows the relationship between name and value of attributeFilter .
Table 2. Parameters of ReadCompleted and ModificationCompleted event types
attributeFilter name Type Required Wilcard allowed Length (min-max) Default value
FileName string ✓ ✓ 1 44
Destination string ✓ 1 8
Userid string ✓ 1 8 *
Jobname string ✓ 1 8 *
Note: For parameters with wildcard allowed, you can use the following wildcards:
*
To match any sequence of characters.
?
To match any single character. For example, if you specify AB?, ABC is a match, AB or ABCD are not a match.
%
For compatibility with earlier versions, it is supported for the same function as ?.
The following list provides a detailed description of the parameters:
FileName
Specifies the data set name to be monitored for actions on special resources. For details about how the tracker requests to change the resource availability, based on the specified FileName value, see Effects on special resource availability.
Destination
The destination of the action provider, that is the tracker where the specified data sets are located. Specify $$$$$$$$ to identify a local destination.
Userid
Specifies a generic character string to be compared with the SMFxxUID field, which contains the user identification associated with the job, started task, or TSO user that requested the activity against the data set that resulted in the data set close.
Note: The SMF user ID field may contain a blank value. Refer to z/OS® System Management Facilities for more information about the SMFxxUID or SMFxxUIF field.

If you need to control SR availability events based on the user ID and the SMF value is blank in your installation, consider using the IEFUJI exit to insert the user ID. You are recommended to specify SETUID=YES on the EQQEXIT macro when you generate the IEFUJI exit: this sets the JMRUSEID field, which SMF then copies to the SMF user ID field.

If you want to update the JMRUSEID field yourself, the user ID is most easily taken from the ACEEUSRI field in the ACEE, pointed to from the ASXB, pointed to from the ASCB. This can be located as follows: 

PSAAOLD  ===> ASCB
ACSBASXB ===> ASXB
ASXBSENV ===> ACEE
ACEEUSRI ===> userid
The DSECTs needed are mapped by these macros:
Area Macro Library
PSA IHAPSA SYS1.MACLIB
ASCB IHAASCB SYS1.MACLIB
ASXB IHAASXB SYS1.MODGEN
ACEE IHAACEE SYS1.MACLIB

The JMR, mapped by IEFJMR, is already available in the EQQEXIT expansion in IEFUJI.

Jobname
Specifies a generic character string to be compared with the SMF14JBN, SMF15JBN, or SMF64JMN field, which contains the name of the job, started task or TSO user that requested the activity against the data set that resulted in the data set close.

If the data set is to be processed by FTP, JOBNAME corresponds to the ** USERID ** under which the data set is received. That is, the USERID supplied when the remote host opened the FTP session to PUT the data set, or when a local user (or batch job) opened the FTP session to GET the data set.

Parameters of SpecialResourceEvent action type shows the parameters for SpecialResourceEvent action type. All of them are optional.
Table 3. Parameters of SpecialResourceEvent action type
Property name Type Default value
Availability string

Value can be Yes or No

 Yes
LifeSpanAction string

Value can be Yes, No, or Reset

 Reset
LifeSpanTime numeric (1–999999)
Detailed parameter descriptions follow:
Availability
Specifies that the special resource, which the action refers to, must be set to available (Yes) or unavailable (No).
LifeSpanAction
Specifies the value to which the global availability of the special resource is reset, after the interval of time specified by LifeSpanTime has expired. Allowed values are:
Yes
Sets the global availability to Yes
No
Sets the global availability to No
Reset
Sets the global availability to blank

This keyword is valid only if LifeSpanTime is specified.

LifeSpanTime
Specifies the interval of time, in minutes, after which the global availability of the special resource is reset to the value specified by LifeSpanAction.