Coding Each AOF Rule Type › Delete-Operator-Message Rules › AOF Variables Available in a DOM Rule

AOF Variables Available in a DOM Rule

You can use all AOF variable types in DOM rules. You can use the following unique AOF event variables in the )PROC section of a DOM rule, and you can manually interrogate the corresponding OPSLOG display field as an aid in debugging or implementing rule logic.

DOM.SYSPLEX

Indication of whether this DOM was routed to this system by sysplex processing

Data Type: Integer, read-only

Possible Values: 0 if the DOM was issued on this system; 1 if it was routed to this system by sysplex processing

Sample Value: 1

Note: Sysplex reissued DOMs are only processed by AOF rules if the AOFMESSAGES parameter is set to a value of MVSGLOBAL.

OPSLOG Browse Column: X'0004' flag of OPSFLAGS when the EVENT column indicates DOM event

DOM.TOKEN

The TOKEN value used to DOM one or more messages that were WTOed using the same TOKEN value. For more information, see the explanations for using the TOKEN keyword with the ADDRESS WTO host command environment and the OPSWTO command processor.

Data Type: 4-byte binary (possibly printable), read-only

Possible Values: Any possible 4-byte token used by the issuer of the WTO

Sample Value: A009

Notes:

• You can use a token to DOM a group of related messages that were WTOed using that same TOKEN value.
• The token may or may not contain a printable value. If it is not printable, you can display its hexadecimal value using the C2X(DOM.TOKEN) REXX construct.
• When the TOKEN field is not binary zeros, then the value of the DOM.WTOID variable will be binary zeros and the value of DOM.WTOIDNUM will be zero.
• When DOM.WTOIDNUM is non-zero, this variable will always contain binary zeros.

OPSLOG Browse Column: TOKEN

DOM.USER

An 8-byte variable providing communication between rules executing for the same DOM event. The variable can contain any installation data that these rules need, and it can store a character string displayable through OPSLOG Browse.

Data Type: User-defined, read/write

Notes:

• Before AOF processing, this variable is initialized to binary zeros. It is then passed to each rule that executes for the same DOM event; each rule can look at or change the variable contents before passing the variable to the next rule for the DOM event.
• The primary purpose for the USER variable is to provide a method to pass a small amount of data between the rules. This data may be binary or mixed case. The USER field may also be used for filtering in the OPSLOG. However, USER data used for OPSLOG filtering must be uppercase and displayable.

OPSLOG Browse Column: USER

DOM.WTOID

The internal sequence ID of the message to be deleted, taken from the DOMCID field of the DOM control block (WTO or WTOR sequence number)

Data Type: 4-byte binary (unprintable), read-only

Sample Value: '00004C94'

Notes:

• The DOM.WTOID value provides information that the OPSSEND function of OPS/REXX uses in transmitting DOM events to other systems.
• Your system assigns sequence numbers to WTO or WTOR messages. You can use these sequence numbers to delete (using DOM) highlighted, non-scrollable messages. Use the sequence of a message as its unique token identifier, but do not use the contents of the sequence number itself.

OPSLOG Browse Column: WTOID

DOM.WTOIDNUM

The internal sequence ID of the message to be deleted, taken from the DOMCID field of the DOM control block (WTO or WTOR sequence number)

Data Type: Integer, read-only

Sample Value: 1694508484

Note: The only difference between this variable and the DOM.WTOID variable is its display format.

OPSLOG Browse Column: WTOID

More information:

AOF Rule Tools