Condition Items

This section describes the condition items that you can use in an IF-THEN statement. Three tables show the condition items by type:

Table 1 for messages
Table 2 for MSUs
Table 3 for messages and MSUs

With these exceptions, the text in these tables describes each condition item in alphabetic order:

Display actions for messages are ignored unless the message is sent to the command facility for display.
Display actions for MSUs are ignored unless the MSU contains an alert that is sent to the hardware monitor for display.

There are five types of MSUs:

Control point management services units (CP-MSUs)
Multiple domain support message units (MDS-MUs)
Network management vector transports (NMVTs)
Record maintenance statistics (RECMSs)
Record formatted maintenance statistics (RECFMSs)

Table 1. IF Condition Items for Messages
Condition Item	Compare Item	Maximum Length	Description
ACTIONDL	Parse template	7 char	Tells why message was deleted
ACTIONMG	Bit String	1 bit	Indicates action message
AREAID	Parse template	1 char	MVS™ message area ID
ATF (DSIAMMCH)	Parse template	See DSIAMMCH	Matches message text to a regular expression
AUTOTOKE¹	Parse template	8 chars	MVS message processing facility automation token
CART¹	Parse template	8 bytes	Command and response token
CORRELATED	Bit String	1 bit	Indicates the message is correlated
CORRFAIL	Bit String	1 bit	Indicates the correlation failed
DESC	Bit string	16 bits	MVS message descriptor codes
IFRAUWF1	Bit string	32 bits	MVS WTO information
JOBNAME	Parse template	8 chars	MVS originating job
JOBNUM	Parse template	8 chars	MVS assigned job number
KEY	Parse template	8 chars	Key associated with a message
MCSFLAG	Bit string	16 bits	MVS multiple console support flags
MSGAUTH	Bit string	2 bits	Authorized program indicator
MSGCATTR	Bit string	16 bits	MVS message-attribute flags
MSGCMISC¹	Bit string	8 bits	MVS miscellaneous routing flags
MSGCMLVL	Bit string	16 bits	MVS message-level flags
MSGCMSGT¹	Bit string	16 bits	MVS message-type flags
MSGCOJBN	Parse template	8 chars	Originating job name
MSGCPROD¹	Parse template	16 chars	MVS product level
MSGCSPLX	Parse template	8 chars	Name of sysplex sending message
MSGDOMFL¹	Bit string	8 bits	MVS delete operator message (DOM) flags
MSGGBGPA¹	Parse template	4 bytes	Background presentation attributes
MSGGDATE	Parse template	7 chars	Date associated with a message
MSGGFGPA¹	Parse template	4 bytes	Foreground presentation attributes
MSGGMFLG¹	Bit string	16 bits	MVS general message flags
MSGGMID	Parse template	4 chars	MVS message ID
MSGGTIME	Parse template	11 chars	Time that the message was issued
MSGID	Parse template	255 chars	Message ID
MSGSRCNM¹	Parse template	17 chars	Source name from source object
MVSRTAIN	Bit string	3 bits	MVS automation message retention facility (AMRF) AMRF retain flags
NVDELID	Parse template	24 char	NetView® program deletion ID
ROUTCDE	Bit string	128 bits	MVS routing codes
SESSID	Parse template	8 chars	Terminal access facility session ID
SYSCONID	Parse template	8 chars	System console name
SYSID	Parse template	8 chars	ID of originating MVS system
TEXT	Parse template	255 chars	Message text
TOKEN	Parse template	255 chars	In a message text, a string delimited by blanks
Note: ¹ This condition item does not have a value unless the message being processed was originally a message data block (MDB). This occurs when the MVS message is destined for a NetView operator.

Table 2. IF Condition Items for MSUs
Condition Item	Compare Item	Maximum Length	Description
CORRELATED	Bit String	1 bit	Indicates the MSU is correlated
CORRFAIL	Bit String	1 bit	Indicates the correlation failed
HIER	Parse template	See HIER.	Resource hierarchy associated with an MSU
HMASPRID²	Parse template	9 chars	Returns the alert sender product ID
HMBLKACT²	Parse template	5 chars	Returns the block ID and action code of an MSU
HMCPLINK²	Bit string	1 bit	Returns an indicator that specifies whether a complex link exists
HMEPNAU²	Parse template	16 chars	Returns the network addressable unit (NAU) name of the entry point node where the MSU originated for MSUs forwarded using the SNA-MDS/LU 6.2 alert forwarding protocol or the NV-UNIQ/LUC alert forwarding protocol.
HMEPNET²	Parse template	16 chars	Returns the netid name of the entry point node where the MSU originated for MSUs forwarded using the SNA-MDS/LU 6.2 alert forwarding protocol.
HMEPNETV²	Bit String	1 bit	Returns an indicator that specifies whether the entry point node where the MSU originated was a remote node NetView program. This function applies only to MSUs forwarded using the SNA-MDS/LU 6.2 alert forwarding protocol.
HMEVTYPE²	Parse template	4 chars	Returns the event type of an MSU
HMFWDED²	Bit string	1 bit	Returns an indicator that specifies whether an MSU was forwarded from another node over the NV-UNIQ/LUC alert forwarding protocol
HMFWDSNA²	Bit string	1 bit	Returns an indicator that specifies whether an MSU was forwarded from a remote entry point node using the SNA-MDS/LU 6.2 alert forwarding protocol
HMGENCAU²	Parse template	1 char	Returns the general cause code of an MSU, in hexadecimal
HMONMSU²	Bit string	1 bit	Returns an indicator that specifies whether an MSU was submitted to automation by the hardware monitor
HMORIGIN²	Parse template	8 chars	Returns the name of the resource sending the MSU
HMSECREC²	Bit string	1 bit	Returns an indicator specifying whether the hardware monitor performs secondary recording
HMSPECAU²	Parse template	2 chars	Returns the specific component code of an MSU, in hexadecimal
HMUSRDAT²	Parse template	5 chars	Returns the user data from subvector 33 of an MSU
MSUSEG	Parse template or bit string	See MSUSEG.	MSU data
Note: ² This condition item returns a null value if the MSU was not submitted for automation by the hardware monitor.

Table 3. IF Condition Items for Messages and MSUs
Condition Item	Compare Item	Maximum Length	Description
ACQUIRE	Parse template	See ACQUIRE.	Value determined by the edit specification
ATF	Parse template or bit string	See ATF.	Value determined by a specified ATF program
ATF(DSICGLOB)	Parse template	See DSICGLOB.	Value of a common global variable
ATF(DSITGLOB)	Parse template	See DSITGLOB.	Value of a task global variable
ATTENDED	Bit string	1 bit	Attended task indicator
AUTOMATED	Bit string	1 bit	Significant action indicator
AUTOTASK	Bit string	1 bit	Autotask indicator
CURRDATE	Parse template	8 chars	Current® date
CURRTIME	Parse template	8 chars	Current time of day
CURSYS	Parse template	8 chars	Current MVS operating system name
DISTAUTO	Bit string	1 bit	Distributed autotask indicator
DOMAIN	Parse template	5 chars	Current NetView program domain name
DOMAINID	Parse template	8 chars	Originating NetView program domain
HDRMTYPE	Parse template	1 char	Message type
IFRAUIND	Bit string	16 bits	AIFR indicator flags
IFRAUIN3	Bit string	8 bits	Indicator-bit field
IFRAUI3X	Bit string	32 bits	Indicator bits
IFRAUSB2	Parse template	2 chars	AIFR user field
IFRAUSC2	Bit string	128 bits	AIFR user field
IFRAUSDR	Parse template	8 chars	Name of originating NetView program task
IFRAUSRB	Bit string	16 bits	AIFR user field
IFRAUSRC	Parse template	16 chars	AIFR user field
IFRAUTA1	Bit string	48 bits	AIFR control flags
INTERVAL	Bit string	1 bit	Occurrence interval detection
LINEPRES	Parse template	4 bytes	Presentation attributes of first text buffer
LINETFLG	Bit string	16 bits	Presentation override flag (bit 16) and other flags
MVSLEVEL	Parse template	8 chars	Current MVS product level
NETID	Parse template	8 chars	VTAM® network identifier
NETVIEW	Parse template	4 chars	NetView program version and release
NUMERIC	Parse template	255 chars	Numeric value of a variable
NVCLOSE	Bit String	1 bit	NetView program CLOSE processing flag
OPID	Parse template	8 chars	Operator or task ID
OPSYSTEM	Parse template	7 chars	Operating system
SYSPLEX	Parse template	8 chars	Local MVS sysplex name
TASK	Parse template	3 chars	Type of task
THRESHOLD	Bit string	1 bit	Occurrence threshold detection
VALUE	Parse template	255 chars	Value of a variable
VTAM	Parse template	4 chars	VTAM level
VTCOMPID	Parse template	14 chars	VTAM component identifier
WEEKDAYN	Parse template	1 char	Day of the week

This is an alphabetical list of the condition items.

ACQUIRE ('edit_specification')

A condition item that enables you to extract AIFR data using the syntax and function provided by the PIPE EDIT stage.

Only the first line of the returned message buffer is used for comparison. The AIFR path ) continues unaltered through the automation process.

While edit_specification must be enclosed in single quotation marks (in the form 'edit_specification'), you cannot use single quotation marks within the edit_specification itself.

For specific information about the edit_specification, refer to the IBM Z® NetView Programming: Pipes.

ACTIONDL [(pos [len])]

The reason for deleting the NetView program action message. The reason is expressed in an EBCDIC string that is 1-8 characters in length.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

If the value of ACTIONDL is not null (''), the automation table is processing a DOM (Delete Operator Message), as contrasted to a message or an alert.

Valid values are as follows:

'': Null; the message is not a DOM.
ASID: The message was deleted because the address space ended that issued the message.
INVALID: The DOM contained an unrecognizable combination of bit settings.
LOCAL: The message was deleted by an operator overstrike or by the CONSOLE DELETE stage.
NETVIEW: The message was deleted by the NetView program DOM command using the NVDELID option, or internally by the NetView program.
SMSGID: The message was deleted by an MVS DOM-by-SMSGID. A single message was deleted by its specific identifier.
TCB: The message was deleted because the task ended that issued the message.
TOKEN: The message was deleted by an MVS DOM-by-token.

Maximum length: 7 characters

Type: Message

Usage notes for ACTIONDL::

MVS might convert TCB and ASID conditions to DOM-by-SMSGID.
SMSGID is the most frequent type of MVS DOM.
Related condition items are ACTIONMG and NVDELID. Also see DOMACTION.

ACTIONMG

Indicates whether the message is treated by the NetView program as an MVS action message. Values for ACTIONMG are:

1: The message is an action message.
0: The message is not an action message.

Maximum length: 1 bit

Type: Message

Usage notes for ACTIONMG::

Action messages are WTORs or those marked with a Descriptor code that matches one of those specified on the MVSPARM.ActionDescCodes CNMSTYLE statement.
Related condition items are ACTIONDL and NVDELID. Also see DOMACTION.

AREAID [(pos [len])]

The one-letter identifier (A–Z), on the multiple console support console that displays the message.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

The value of AREAID evaluates to null ('') if the value is B'0' or blank. You can test for these cases by comparing to the null ('') keyword.

Maximum length: 1 character

Type: Message

ATF ([BIT] 'cmdstring')

Identifier for a program that is called to perform an automation-table function (ATF).

For a description of how to write your own ATF programs, refer to the IBM Z NetView Programming: Assembler.

The condition item is a value that the program returns.

The compare item is either a bit string or a parse template.

BIT

Indicates that the compare item is a bit string. If you do not specify BIT, the compare item is a parse template.

cmdstring

The command string that calls the program.

The text of the string up to the first blank (or the whole string, if there are no blanks) is the program name. Any text after the first blank is passed as parameters to the called program.

The program name must be specified with a literal quoted string. However, variable values can be passed as ATF program parameters using the VALUE (varname) syntax.

After the program name is specified, the parameters can be specified by any combination of literals and VALUE specifications.

Variables that are passed must meet these criteria:

Variables that were passed as ATF must be previously defined in the statement or BEGIN hierarchy.
Variables that have not been set are treated as a null literal.
A variable cannot be subscripted with position or length.

Maximum length: 256 bytes

Type: Both

Usage notes for ATF:

These criteria apply to ATF and cmdstring:
- The length of cmdstring with its parameters is limited to 256 bytes (less the length of BUFHDR).
- The ATF program name in cmdstring has a maximum length of 8 characters.
- The length of the value returned by the ATF is limited to 256 bytes (minus the length of BUFHDR).
The interface is based on a parameter list whose address is in register 1.
The register contains pointers to the control work block (CWB) and to the AIFR being automated.
The ATF return codes in register 15 are:

Code

Meaning

0

Normal

1–8

Indicates an error that causes the comparison to be evaluated as false

9 or greater

Indicates an error that results in error message CNM588E and a comparison evaluation of false
When you successfully activate an automation table with the AUTOTBL command, the NetView program loads all of the ATF programs your table uses.
The NetView program does not reload the ATF program into main storage every time a message or MSU goes through the automation table.
The NetView program samples provide OPERID (CNMS4295) as an example of an ATF program.
ATF does not support a length specification.
You can assign ATF to a variable and then use that variable (including pos and len) in a VALUE conditional statement.

ATF ([BIT] 'DSIAMMCH regex')

DSIAMMCH is an ATF program that is supplied with the NetView program. If a message's text data matches the specified regular expression, DSIAMMCH returns a value of 1. Otherwise, the return value is 0. If the entire command string is longer than 256 characters minus the length of BUFHDR, the command string is truncated. DSIAMMCH returns a value of 0.

The compared item is either a bit string or a parse template. The reason why you can use a parse template is that a regular expression is a string of EBCDIC characters.

The regular expression must be enclosed within its own delimiters. For more information about how to write a regular expression, see the IBM Z NetView Application Programmer's Guide.

Relevant messages pertaining to a regular expression in error will be output by the NetView program at Automation Table compile time.

regex: The regular expression to match against this message's text data. The regular expression, including its delimiters and any following options, must be no more than 223 characters in length. See the IBM Z NetView Application Programmer's Guide for more details about writing a regular expression.

Maximum length: 223 character

Type: Both

ATF ([BIT] 'DSICGLOB varname')

DSICGLOB is an ATF program that is supplied with the NetView program. If a command list or command processor has previously established a value for the common global variable, DSICGLOB returns that value. If the value is longer than 256 characters minus the length of BUFHDR, the value is truncated. If no value has been established for the variable, DSICGLOB does not return a variable value.

The compare item is either a bit string or a parse template. Use a parse template because the value of a global variable is a string of EBCDIC characters.

For information about how to specify varname, see the description of cmdstring for generic ATFs.

Any error encountered by the ATF program forces the condition item to evaluate as false and elicits a CNM588E message containing a return code:

Code: Meaning
100: A variable name is not valid.
104: The variable name used is too long.
108: No variable name is specified.
112: A NetView program storage failure.
116: A NetView program internal error.

BIT: Indicates that the compare item is a bit string. If you do not specify BIT, the compare item is a parse template.
varname: The name of the common global variable. The name can be 1-250 characters in length, and must be a valid global variable name. Refer to the IBM Z NetView Programming: REXX and the NetView Command List Language for restrictions on variable names.

Maximum length: 256 characters

Type: Both

Note: If the automation table calls DSICGLOB for a NetView program message sent to the immediate message area of the operator's screen (TVBINXIT bit is on), DSICGLOB does not return a variable value, and the condition evaluates as false.

ATF ([BIT] 'DSITGLOB varname')

DSITGLOB is an ATF program that is supplied with the NetView program. If a command list or a command processor has previously established a value for the task global variable, DSITGLOB returns that value. If the value is longer than 256 characters minus the length of BUFHDR, the value is truncated. If no value has been established for the variable, DSITGLOB does not return a variable value.

The compare item is either a bit string or a parse template. Use a parse template because the value of a global variable is a string of EBCDIC characters.

For information about how to specify the varname, see the description of cmdstring for generic ATFs.

Any error encountered by the ATF program forces the condition item to evaluate as false and elicits a CNM588E message containing a return code:

Code: Meaning
100: A variable name is not valid.
104: The variable name used is too long.
108: No variable name is specified.
112: A NetView program storage failure.
116: A NetView program internal error.

BIT: Indicates that the compare item is a bit string. If you do not specify BIT, the compare item is a parse template.
varname: The name of the task global variable. The name can be 1-250 characters in length, and must be a valid global variable name. Refer to the IBM Z NetView Programming: REXX and the NetView Command List Language for restrictions on variable names.

Maximum length: 256 characters

Type: Both

Usage notes for ATF:

The task global variable returned by DSITGLOB is the one for the task that invoked the automation table. If you cannot predict which task invokes the automation table and causes the evaluation of the ATF, use a common global variable and the DSICGLOB ATF instead.
If the automation table calls DSITGLOB for a NetView program message sent to the immediate message area of the operator's screen (TVBINXIT bit is on), DSITGLOB does not return a variable value, and the condition evaluates as false.

ATTENDED [(pos [len])]

Describes the NetView program task that is automating a message or MSU. It is a bit string with a value of 1 or 0. The values for ATTENDED are:

1

Indicates that the task is one of the following situations:

An OST with a display
An NNT with a corresponding OST
An autotask with an associated MVS console assigned using the AUTOTASK command
A distributed autotask

0

Indicates that the task is one of the following situations:

An autotask without an associated MVS console assigned using the AUTOTASK command
Another type of task, such as a DST or an OPT task

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 1 bit

Type: Both

Usage notes for ATTENDED:

If the associated operator is an autotask, the presentation data is not eligible for display unless the autotask is associated with an active MVS console.
You can use ATTENDED in conjunction with DISTAUTO or AUTOTASK condition items to further define the characteristics of the task that is automating the message or MSU. For example, if ATTENDED is 1, DISTAUTO is 0, and AUTOTASK is 1, the task is an autotask with an associated MVS console.

AUTOMATED [(pos [len])]

Describes the automation indicator of the AIFR containing the message or MSU.

It is a one-bit indicator that specifies whether the AIFR has been automated by a previous significant action. Values for AUTOMATED are as follows:

1: The AIFR has been automated.
0: The AIFR has not yet been automated.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Automation treats an AIFR as AUTOMATED if a match occurs other than the ALWAYS or CONTINUE(YES) statements, unless the AUTOMATED action is used to override these defaults.

Maximum length: 1 bit

Type: Both

AUTOTASK [(pos [len])]

Condition item which describes the NetView program task that is automating the message or MSU. This is a one-bit indicator that specifies whether a task is an autotask. Values for AUTOTASK are:

1: The task is an autotask.
0: The task is not an autotask.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 1 bit

Type: Both

AUTOTOKE [(pos [len])]

Indicates the 1 to 8 character name of the MVS message processing facility (MPF) automation token.

If you specify AUTO(YES) or AUTO(NO) in the MPF table, the values YES and NO are not automation tokens.

AUTOTOKE has a value only if the message was originally a message data block (MDB).

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 8 characters

Type: Message

CART [(pos [len])]

Specifies the 8-byte MVS command and response token (CART). The CART might contain characters that cannot be displayed.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

The value of CART evaluates to null ('') if the field contains only binary zeros. You can test for this case by comparing the null ('') keyword.

Maximum length: 8 bytes

Type: Message

CORRELATED

Condition item that checks if a message or MSU is correlated. This is a one-bit indicator. Values for CORRELATED are:

1: The message or MSU is correlated.
0: The message or MSU is not correlated.

Maximum length: 1 bit

Type: Both

CORRFAIL

Condition item that checks if correlation failed. This is a one-bit indicator. Values for CORRFAIL are:

1: An internal error prevented correlation.
0: A problem was not encountered with correlation.

Maximum length: 1 bit

Type: Both

CURRDATE [(pos [len])]

Indicates the 1-8 character current date (yyyy/mm/dd).

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 8 characters

Type: Both

CURRTIME [(pos [len])]

Indicates the 1-8 character current time of day (hh:mm:ss).

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 8 characters

Type: Both

CURSYS [(pos [len])]

Indicates the 1-8 character current MVS operating system name.

The system name returned by CURSYS can be different than the system name returned by SYSID:

CURSYS is the name of the system where the automation table is processing.
SYSID is the name of the system where the message originated.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 8 characters

Type: Both

DESC [(pos [len])]

Identifies 1–16 MVS descriptor codes assigned to the message. Refer to the MVS library for information about code values.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 16 bits

Type: Message

DISTAUTO [(pos [len])]

Indicates whether a task is a distributed autotask started with the RMTCMD command. The DISTAUTO condition item describes the task that is automating the message or MSU. The values for DISTAUTO are as follows:

1: The task is a distributed autotask.
0: The task is not a distributed autotask.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 1 bit

Type: Both

DOMAIN [(pos [len])]

Specifies the 1-5 character name of the current NetView program domain.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 5 characters

Type: Both

DOMAINID [(pos [len])]

Specifies the 1-8 character domain name of the NetView system that originated the message or MSU.

For messages, DOMAINID gives the name of the NetView system that first processed the message. Note that for messages BNJ030I and BNJ146I, which are generated based on alerts, the DOMAINID indicates the name of the NetView syhstem that generated these messages.

For forwarded alerts from a hardware monitor to another NetView program, DOMAINID gives the name of the distributed NetView program that originally processed and forwarded the alert. For other MSUs, DOMAINID gives the name of the local NetView program that is doing the automation-table search.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 8 characters

Type: Both

HDRMTYPE [(pos [len])]

Specifies the 1-character buffer type of the received message or MSU. Buffer types are described in NetView Message Type (HDRMTYPE) Descriptions.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 1 character

Type: Both

HIER [(indexnum)]

Specifies the NetView program hardware monitor hierarchy data associated with an MSU. The compare item is a parse template.

indexnum: The index number (1-5) of a specific resource name-type pair.

HIER is set only if the MSU is received from the hardware monitor. If you specify an indexnum, the value of HIER is the single, specified name-type pair in the form aaaaaaaa1111, where aaaaaaaa is the 8-character name and 1111 is the 4-character type. The names and types are padded on the right with blanks, if necessary. If an alert has fewer than indexnum resources, the value is null. If you do not specify an indexnum, the value of HIER is equal to a concatenation of all existing name-type pairs. For example, if there are three name-type pairs, the value is in this format:

aaaaaaaa1111bbbbbbbb2222cccccccc3333

There can be up to five name-type pairs. If an MSU does not have hierarchy information, the value of HIER is null. See Using the Resource Hierarchy for HIER examples.

HIER does not support a length specification. You can assign HIER to a variable, and then use that variable (including pos and len) in a VALUE conditional statement.

Maximum length: 60 characters

Type: MSU

HMASPRID [(pos [len])]

Returns the 9-character alert-sender product ID. This is the same alert-sender product ID returned with the prodid parameter on the SRFILTER command. The ID can be either of these items:

A hardware product ID that has from 1 to 4 characters
A software product ID has from 1 to 9 characters

Trailing blanks are not truncated.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

HMASPRID returns a null if an MSU is either:

Not a generic record
Note: The term generic refers to all MSUs that contain subvector 92. Generic MSUs include:
- Alerts that contain subvector 92
- Resolutions, which contain subvector 92
Not submitted to automation by the hardware monitor

Maximum length: 9 characters

Type: MSU

Applies to: All MSUs submitted to automation by the hardware monitor

Example 1: Searching for a Device

IF HMASPRID = '3745' THEN
      EXEC(CMD('CLISTA') ROUTE(ONE AUTO1));

This example specifies that if a hardware monitor MSU is generic and from a 3745 device, the automation table calls the CLISTA command list and routes it to operator AUTO1.

Example 2: Specifying a Generic MSU

IF HMASPRID ¬= '' THEN
      EXEC(CMD('CLISTA') ROUTE(ONE AUTO1));

This example specifies that if a hardware monitor MSU is generic, the automation table calls the CLISTA command list and routes it to operator AUTO1.

HMBLKACT[(pos [len])]

Returns a 5-character value, including a 3-character block ID and a 2-character action code. This value is identical to the code value of the SRFILTER command. Values are returned only for nongeneric alerts (X'0000') and RECMSs and RECFMSs that are not statistics-only.

Refer to the NetView program online help for information about the SRFILTER command.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

HMBLKACT returns a null if an MSU is:

A generic alert (X'0000')
Note: The term generic refers to all MSUs that contain subvector 92. Generic MSUs include:
- Alerts that contain subvector 92
- Resolutions, which always contain subvector 92
A resolution (X'0002')
A PD statistic (X'0025')
Link configuration data (X'1332')
A statistics-only RECMS
Note: Statistics-only RECMS refers to record maintenance statistics that contain only statistical data. These records have a recording mode of X'81', X'86', and X'87' in byte 8, offset 1 of the RECFMS. For X'87', only RECMSs that represent temporary errors (not permanent) are considered statistics-only.
A statistics-only RECFMS
Note: Statistics-only RECFMS refers to record formatted maintenance statistics that contain only statistical data. These records have a type of 1, 4, and 5 in byte 8, offset 1 of the RECFMS.
Not submitted to the automation table by the hardware monitor

Maximum length: 5 characters

Type: MSU

Applies to: All MSUs except those that cause a null value to be returned

Example 1: Checking for a Block ID and Action Code That is Not Null

IF HMBLKACT ¬= '' THEN COLOR(RED);

This example checks for MSUs with a block ID and action code that is not null, and colors them red.

Example 2: Checking for a Specific Block ID and Action Code

IF HMBLKACT = HEX'FFD03' THEN COLOR(RED);

This example checks for MSUs with a block ID of X'FFD' and an action code of X'03', and colors them red.

Example 3: Checking for a Specific Block ID

IF HMBLKACT = HEX('FFD') . &
   HMBLKACT = MYVAR THEN
     EXEC(CMD('CLISTA 'MYVAR) ROUTE(ONE AUTO1));

This example checks for MSUs with a block ID of X'FFD'. It does not check for a specific action code. The automation table calls the CLISTA command list for MSUs with a block ID of X'FFD'. The block ID and action are passed to the CLISTA command list in variable MYVAR, and the command list is routed to operator AUTO1.

HMCPLINK[(pos [len])]

Returns a one-bit indicator, either 1 or 0, that specifies whether a complex link exists.

Indicator: Description
1: Indicates that a complex link exists. If a complex link exists, there might be resource levels that do not appear in the resource hierarchy returned by the HIER condition item. Use a system schematic to determine the complete hierarchy configuration when a complex link is present. For more information about the HIER condition item, see HIER.
Hardware monitor panels, such as the Most Recent Events panel, indicate a complex link exists by placing an asterisk (*) in the pictorial resource hierarchy at the top of the panel, and displaying message BNJ1538I on the message line near the bottom of the panel.
0: Indicates that a complex link does not exist or that the hardware monitor did not submit the MSU to automation.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 1 bit

Type: MSU

Applies to: All MSUs submitted to automation by the hardware monitor

Example 1: Checking for a Complex Link

IF HMCPLINK = '1' THEN COLOR(RED);

This example specifies that hardware monitor MSUs with a complex link are colored red.

Example 2: Checking for an MSU with No Complex Link

IF HMONMSU = '1' &
   HMCPLINK = '0' THEN COLOR(RED);

This example checks for an MSU that was forwarded by the hardware monitor and that has no complex link, and colors it red.

HMEPNAU[(pos [len])]

Returns the network addressable unit (NAU) name of the entry point node where the MSU originated. For local MSUs, HMEPNAU returns the local NAU (domain) name. For MSUs that were forwarded from a remote node entry point, the NAU name of the remote entry point is returned. This is true for both alert forwarding mechanisms: LU 6.2 and LUC.

For LU 6.2 forwarded alerts, the NAU name returned is the NAU name of the entry point node in which the MS application resides which first sent (forwarded) the alert to the ALERT-NETOP application. If the NetView program cannot determine with complete certainty that the NAU name returned is the entry point NAU name (for example, it might be an intermediate node name) then the NAU name returned is preceded by an asterisk (*), for example, *nauname.

See Centralized Operations for more information about forwarding mechanisms.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 16 characters

Type: MSU

Applies to: All MSUs submitted to automation by the hardware monitor

Example: Searching for MSUs Forwarded from a Remote Entry Point Checking for an MSU Forwarded from NETA.CNM01 Using LU 6.2

IF HMFWDSNA = '1' &
   HMEPNET  = 'NETA' &
   HMEPNAU = 'CNM01' THEN COLOR(RED);

This example specifies that hardware monitor MSUs that have been forwarded from remote entry point node NETA.CNM01 using the SNA-MDS/LU 6.2 alert forwarding protocol are to be colored red.

HMEPNET[(pos [len])]

Returns the netid name of the entry point node where the MSU originated. For local MSUs, HMEPNET returns the local netid name. For MSUs that were forwarded using LUC alert forwarding, HMEPNET returns an asterisk (*), because the NetView program cannot determine the netid name.

For MSUs that were forwarded using LU 6.2 alert forwarding, the netid name returned is the name of the entry point node where the MS application resides. If the NetView program cannot determine a netid name, HMEPNET returns an asterisk (*). If the NetView program can determine the netid name, but cannot with complete certainty determine that the netid name is the entry point netid name (for example it might be an intermediate node netid name) then HMEPNET returns the netid name preceded by an asterisk (*), for example *netidnam.

See Centralized Operations for more information about forwarding mechanisms.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 16 characters

Type: MSU

Applies to: All MSUs submitted to automation by the hardware monitor

Example: Checking for an MSU Forwarded from NETA.CNM01 Using LU 6.2

IF HMFWDSNA = '1' &
   HMEPNET  = 'NETA' &
   HMEPNAU = 'CNM01' THEN COLOR(RED);

HMEPNETV[(pos [len])]

Returns a one-bit indicator, either 1 or 0, that specifies whether the entry point node where the MSU originated was a remote node NetView program. This function applies only to MSUs forwarded using the SNA-MDS/LU 6.2 alert forwarding protocol.

Indicator: Description
1: Indicates that the entry point was a NetView program.
0: Indicates that the entry point was not a NetView program or that the MSU was not forwarded using the SNA-MDS/LU 6.2 alert forwarding protocol.

See Centralized Operations for more information about forwarding mechanisms.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 1 bit

Type: MSU

Applies to: All MSUs submitted to automation by the hardware monitor

Example: Searching for MSUs Forwarded from a Remote Node Entry Point Using LU 6.2

IF HMEPNETV = '1' THEN COLOR(RED);

This example specifies that hardware monitor MSUs, which have been forwarded from a remote entry point NetView program using the SNA-MDS/LU 6.2 alert forwarding protocol, are to be colored red.

HMEVTYPE[(pos [len])]

Returns a 4-character event type of the MSU. Trailing blanks are not truncated from the returned value.

The event types are:

AVAL

BYPS

CUST

DLRC

HMV

HELD

IMPD

IMR

INST

INTV

NTFY

PAFF

PERF

PERM

PROC

REDL

RSLV

RSNT

SCUR

SNA

TEMP

UNKN

USER

Refer to the NetView online help (HELP NPDA 'event_type') for more information.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

HMEVTYPE returns a null if an MSU is:

Not submitted to automation by the hardware monitor
A PD statistic (X'0025')
Link configuration data (X'1332')
A statistics-only RECMS
Note: Statistics-only RECMS refers to record maintenance statistics that contain only statistical data. These records have a recording mode of X'81', X'86', and X'87' in byte 8, offset 1 of the RECFMS. For X'87', only RECMSs that represent temporary errors (not permanent) are considered statistics-only.
A statistics-only RECFMS
Note: Statistics-only RECFMS refers to record formatted maintenance statistics that contain only statistical data. These records have a type of 1, 4, and 5 in byte 8, offset 1 of the RECFMS.

Maximum length: 4 characters

Type: MSU

Applies to: All MSUs submitted to automation by the hardware monitor

Example 1: Searching for Event Type PERM

IF HMEVTYPE = 'PERM' THEN COLOR(RED);

This example specifies that MSUs with an event type of PERM are colored red.

Example 2: Searching for Event Type SNA

IF HMEVTYPE = 'SNA' . THEN COLOR(RED);

These examples specify that MSUs with an event type of SNA are colored red. You do not have to check for the trailing blank.

Example 3: Extracting an Event Type

IF HMEVTYPE ¬= '' &
   HMEVTYPE = MYVAR THEN
     EXEC(CMD('CLISTA 'MYVAR) ROUTE(ONE AUTO1));

This example extracts the event type from the hardware monitor MSU, passes it to the CLISTA command list in variable MYVAR, and routes the command list to operator AUTO1.

HMFWDED[(pos [len])]

Returns a one-bit indicator, either 1 or 0, that specifies whether an MSU was forwarded from another node.

Indicator

Description

1

Indicates an MSU was forwarded from another node through one of these alerts:

NV-UNIQ/LUC alert forwarding protocol
SNA-MDS/LU 6.2 alert forwarding protocol

0

Indicates that the MSU was not forwarded through another node, was forwarded over LU 6.2, or that the hardware monitor did not submit the MSU to automation.

An indicator of 0 is returned in these instances:

Local MSUs are received through the CNM interface.
Local MSUs are received from the operating system.
MSUs are received through the program-to-program interface.
MSUs are received through the SNA-MDS/LU 6.2 alert forwarding protocol.

Note: RECMSs and RECFMSs that are forwarded from entry points over LUC or LU 6.2 are not submitted to automation at the receiving focal point. RECMSs and RECFMSs are submitted to automation at the entry point, but not at the receiving focal point.

See Centralized Operations for more information about forwarding mechanisms.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 1 bit

Type: MSU

Applies to: All MSUs submitted to automation by the hardware monitor

Example 1: Searching for MSUs Forwarded from an Entry Point

IF HMFWDED = '1' THEN COLOR(RED);

This example specifies that hardware monitor MSUs that have been forwarded from an entry point NetView program are to be colored red.

Example 2: Searching for MSUs Not Forwarded from an Entry Point

IF HMONMSU = '1' &
   HMFWDED = '0' THEN COLOR(RED);

This example checks for an MSU, which was forwarded by the hardware monitor but not from an entry point NetView program, and colors it red.

HMFWDSNA[(pos [len])]

Returns a 1-bit indicator, either 1 or 0, that specifies whether an MSU was forwarded from a remote entry point node using the SNA-MDS/LU 6.2 alert forwarding protocol.

Indicator: Description
1: Indicates that an MSU was forwarded from a remote entry point node using the SNA-MDS/LU 6.2 alert forwarding protocol.
0: Indicates that an MSU was not forwarded from a remote entry point node using the SNA-MDS/LU 6.2 alert forwarding protocol or that the hardware monitor did not submit the MSU to automation.

Refer to Centralized Operations for more information about forwarding mechanisms.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 1 bit

Type: MSU

Applies to: All MSUs submitted to automation by the hardware monitor

Example: Checking for an MSU Forwarded from NETA.CNM01 Using LU 6.2

IF HMFWDSNA = '1' &
   HMEPNET  = 'NETA' &
   HMEPNAU = 'CNM01' THEN COLOR(RED);

HMGENCAU[(pos [len])]

Returns the 1-character hexadecimal general cause code of an MSU.

The general cause code indicates:

The general classification
The exception condition that caused the MSU to be created

For more information about general cause codes, refer to the information about basic alert (X'91') MS subvectors in the Systems Network Architecture library.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

HMGENCAU returns a value only for nongeneric alerts (X'0000') and RECMSs and RECFMSs that are not statistics-only. HMGENCAU returns a null if an MSU is:

A generic alert (X'0000')
Note: The term generic refers to all MSUs that contain subvector 92. Generic MSUs include:
- Alerts that contain subvector 92
- Resolutions, which always contain subvector 92
A link event (X'0001')
A resolution (X'0002')
A PD statistic (X'0025')
Link configuration data (X'1332')
A statistics-only RECMS
Note: Statistics-only RECMS refers to record maintenance statistics that contain only statistical data. These records have a recording mode of X'81', X'86', and X'87' in byte 8, offset 1 of the RECFMS. For X'87', only RECMSs that represent temporary errors (not permanent) are considered statistics-only.
A statistics-only RECFMS
Note: Statistics-only RECFMS refers to record formatted maintenance statistics that contain only statistical data. These records have a type of 1, 4, and 5 in byte 8, offset 1 of the RECFMS.
Not submitted to automation by the hardware monitor

Maximum length: 1 hexadecimal character

Type: MSU

Applies to: All MSUs except those that cause a null value to be returned

Example 1: Checking for a General Cause Code That is Not Null

IF HMGENCAU ¬= '' &
   HMGENCAU = MYVAR THEN
     EXEC(CMD('CLISTA 'MYVAR) ROUTE(ONE AUTO1));

This example checks for a general cause code that is not a null, passes it to the CLISTA command list variable MYVAR, and routes the command list to operator AUTO1.

Example 2: Checking for a Specific General Cause Code

IF HMGENCAU = HEX('01') THEN COLOR(RED);

This example specifies that a hardware monitor MSU with a general cause code of X'01' is to be colored red.

HMONMSU[(pos [len])]

Returns 0 or 1 to indicate whether an MSU was forwarded to automation from the hardware monitor.

Indicator: Description
1: Indicates an MSU was forwarded from the hardware monitor.
0: Indicates that an MSU was not forwarded from the hardware monitor. It might have been submitted to automation by the generic receiver (NVAUTO), or by a user application that issued DSIAUTO or CNMAUTO.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 1 bit

Type: MSU

Applies to: All MSUs

Example 1: Checking for MSUs Submitted by the Hardware Monitor

IF HMONMSU = '1' THEN COLOR(RED);
IF HMONMSU ¬= '' THEN COLOR(RED);

These examples specify that MSUs submitted by the hardware monitor are to be colored red.

Example 2: Checking for MSUs Not Submitted by the Hardware Monitor

IF HMONMSU = '' THEN ;
IF HMONMSU = '0' THEN ;

These examples specify that MSUs not submitted by the hardware monitor are not sent to automation.

HMORIGIN[(pos [len])]

Returns the name of the resource sending the MSU.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Trailing blanks are not truncated from the value returned. The resource name returned by HMORIGIN is the same name displayed on the hardware monitor Alerts-Dynamic, Alerts-Static, and Alerts-History panels when ALT_ALERT=ORIGIN is specified in BNJMBDST.

Refer to the IBM Z NetView Administration Reference for more information about the ALT_ALERT statement.

If a complex link does not exist in a resource hierarchy, the resource name returned with HMORIGIN is the same as the resource name returned with the HIER condition item. If a complex link does exist, the resource names might not be the same. Use the HMCPLINK condition item to determine whether a complex link exists. For more information, see HMCPLINK and HIER.

HMORIGIN returns a null if the hardware monitor does not submit the MSU to automation.

Maximum length: 8 characters

Type: MSU

Applies to: All MSUs submitted to automation by the hardware monitor

Example 1: Checking for MSUs from GENALERT

IF HMORIGIN = 'GENALERT' THEN COLOR(RED);

This example specifies that MSUs sent from a resource named GENALERT are to be colored red.

Example 2: Extracting a Resource Name

IF HMORIGIN ¬= '' &
   HMORIGIN = MYVAR THEN
      EXEC(CMD('CLISTA 'MYVAR) ROUTE(ONE AUTO1));

This example extracts the resource name from the hardware monitor MSU, passes it to the CLISTA command list in variable MYVAR, and routes the command list to operator AUTO1.

HMSECREC[(pos [len])]

Returns a 0 or 1 to indicate whether the hardware monitor performs secondary recording for an MSU.

Indicator

Description

1

Indicates that secondary recording is performed for an MSU at the resource level returned by the HIER condition item. For more information, see HIER. See the NetView online help for information about secondary recording.

0

Indicates either:

Secondary recording is not performed for an MSU. HMSECREC always returns a 0 for PD statistics (X'0025') and frame relays (X'1332') because the hardware monitor never performs secondary recording for these MSUs.
The hardware monitor did not submit the MSU to automation.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 1 bit

Type: MSU

Applies to: All MSUs submitted to automation by the hardware monitor

Example: Checking for Secondary Recording

IF HMSECREC = '1' &
   HIER = MYHIER THEN
     EXEC(CMD('CLISTA 'MYHIER) ROUTE(ONE AUTO1));

This example checks for secondary recording on an MSU, passes the HIER resource hierarchy level data in variable MYHIER to the CLISTA command list, and routes the command list to operator AUTO1.

HMSPECAU[(pos [len])]

Returns 4 characters representing the 2-character hexadecimal specific component code of an MSU. A general cause code is returned.

The pos parameter is the position where the comparison begins. The default value is 1.

The len parameter is the length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

The specific component code indicates the type of component, subcomponent, or logical resource that is most closely related to the exception condition that caused the MSU to be created. For more information about specific component codes, refer to the information about basic alert (X'91') MS subvectors in the Systems Network Architecture library.

Values are returned only for nongeneric alerts (X'0000') and for RECMSs and RECFMSs that are not statistics-only. HMSPECAU returns a null if an MSU is:

A generic alert (X'0000')
Note: The term generic refers to all MSUs that contain subvector 92. Generic MSUs include:
- Alerts that contain subvector 92
- Resolutions, which always contain subvector 92
A link event (X'0001')
A resolution (X'0002')
A PD statistic (X'0025')
Link configuration data (X'1332')
A statistics-only RECMS
Note: Statistics-only RECMS refers to record maintenance statistics that contain only statistical data. These records have a recording mode of X'81', X'86', and X'87' in byte 8, offset 1 of the RECFMS. For X'87', only RECMSs that represent temporary errors (not permanent) are considered statistics-only.
A statistics-only RECFMS
Note: Statistics-only RECFMS refers to record formatted maintenance statistics that contain only statistical data. These records have a type of 1, 4, and 5 in byte 8, offset 1 of the RECFMS.
Not submitted to the automation table by the hardware monitor

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 2 hexadecimal characters

Type: MSU

Applies to: All MSUs except those that cause a null value to be returned

Example 1: Checking for a Component Code That is Not Null

IF HMSPECAU ¬= '' &
   HMSPECAU = MYVAR THEN
      EXEC(CMD('CLISTA 'MYVAR) ROUTE(ONE AUTO1);

This example checks for a specific component code that is not null, passes the code to the CLISTA command list in variable MYVAR, and routes the command list to operator AUTO1.

Example 2: Checking for a Specific Component Code

IF HMSPECAU = HEX('0001') THEN COLOR(RED);

This example specifies that an MSU with a component code of X'0001' is colored red.

HMUSRDAT[(pos [len])]

Returns the 5-character user-specified data in subvector 33 of an MSU.

Trailing blanks are truncated from the value returned. This data can be used with hardware monitor filtering. The hardware monitor translates any unprintable data in subvector 33 to underscores (_), and translates lowercase characters to uppercase characters. The characters returned with HMUSRDAT reflect any translation done by the hardware monitor, and might not be the same characters in subvector 33. Use HMUSRDAT to determine whether the hardware monitor has translated any data in subvector 33 to underscores or uppercase.

You can also use MSUSEG to retrieve user-specified data from subvector 33 in an MSU. However, MSUSEG does not translate any characters.

For more information about subvector 33 data, the UDAT option of the GENALERT command, and the U option of the SRFILTER command, refer to the NetView online help

HMUSRDAT returns a null if an MSU:

Does not contain subvector 33. Subvector 33 is never present in RECMS or RECFMS records. Only generic major vectors can contain subvector 33. The hardware monitor accepts and processes subvector 33 information in any of the generic major vectors submitted to automation.
Is a frame relay (key X'1332').
Is not submitted to automation by the hardware monitor.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 5 characters

Type: MSU

Applies to: All MSUs submitted to automation by the hardware monitor

Example 1: Checking for Specific User-Specified Data

IF HMUSRDAT = 'MYDAT' THEN COLOR(RED);

This example checks for hardware monitor MSUs with user-specified data of MYDAT in subvector 33, and colors them red.

Example 2: Checking for User-Specified Data

IF HMUSRDAT ¬= '' &
   HMUSRDAT = MYVAR THEN
     EXEC(CMD('CLISTA 'MYVAR) ROUTE(ONE AUTO1));

This example checks for hardware monitor MSUs with user-specified data in subvector 33, passes the data to the CLISTA command list in variable MYVAR, and routes the command list to operator AUTO1.

IFRAUIND [(pos [len])]

Indicates the AIFR indicator fields IFRAUIND and IFRAUIN2, which contain 16 bits.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Bit 16 indicates whether the message was solicited or unsolicited:

1: Unsolicited
0: Solicited

See NetView Program Information Routing for Automation for a discussion of solicited and unsolicited messages. Refer to the IBM Z NetView Programming: Assembler for a description of all other bits.

The value of IFRAUIND evaluates to null ('') if all bits are B'0'. You can test for this condition by comparing to the null ('') keyword.

Maximum length: 16 bits

Type: Both

IFRAUIN3 [(pos [len])]

The 8–bit AIFR field IFRAUIN3 mapped by DSIIFR.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

The values for bits 1 and 2, which indicate the cross-domain priority, are:

B'00': A default priority
B'01': A low priority
B'10': A high priority
B'11': The receiver is to be tested for the priority

Maximum length: 8 bits

Type: Both

IFRAUI3X [(pos [len])]

The 32 bits of binary flags that are mapped by DSIIFR for a message.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

The values for byte 3 (IFRAUI33) are:

X'80': Automate removal of message.
X'40': DOM is not expected.
X'20': DOM-by-token issued by MVS.
X'10': DOM issued for local copy only.
X'08': AIFR sent to AUTO(YES) console owner.

Maximum length: 32 bits

Type: Both

Usage notes for IFRAUI3X::

The first 8 bits of the 32-bit IFRAUI3X flags are IFRAUIN3 (see IFRAUIN3 for description).
For a detailed description of all the IFRAUI3X fields, browse the assembler macro DSIIFR that was shipped with your NetView program.

IFRAUSB2 [(pos [len])]

The 2-character AIFR user field IFRAUSRB mapped by DSIIFR.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

The value of IFRAUSB2 evaluates to null ('') if the field contains all blanks or binary zeros in any combination. You can test for this case by comparing to the null ('') keyword.

Maximum length: 2 characters

Type: Both

Note: To compare using bits, use the IFRAUSRB condition item.

IFRAUSC2 [(pos [len])]

The 128-bit AIFR user field IFRAUSRC mapped by DSIIFR.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

The value of IFRAUSC2 evaluates to null ('') if all bits are B'0'. You can test for this case by comparing to the null ('') keyword.

Maximum length: 128 bits

Type: Both

Note: To compare using characters, use the IFRAUSRC condition item.

IFRAUSDR [(pos [len])]

The name of the NetView program task that originated the message or MSU. IFRAUSDR is a 1-8 character name.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 8 characters

Type: Both

IFRAUSRB [(pos [len])]

The 16-bit AIFR user field IFRAUSRB mapped in DSIIFR.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

The value of IFRAUSRB evaluates to null ('') if all the bits are B'0'. You can test for this case by comparing to the null ('') keyword.

Maximum length: 16 bits

Type: Both

Note: To compare using characters, use the IFRAUSB2 condition item.

IFRAUSRC [(pos [len])]

The 16-character AIFR user field IFRAUSRC mapped in DSIIFR.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

The value of IFRAUSRC evaluates to null ('') if all bytes are character blanks or binary zeros, in any combination. You can test for this case by comparing to the null ('') keyword.

Maximum length: 16 characters

Type: Both

Note: To compare using bits, use the IFRAUSC2 condition item.

IFRAUTA1 [(pos [len])]

Indicates the AIFR fields IFRAUTA1, IFRAUTA2, IFRAUTA3, IFRAUTA4, IFRAUTA5, and IFRAUTA6. See fields IFRAUTA1 through IFRAUTA6 in DSIIFR for more information.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Check these bits:

Bit: Description
1, 2, 25: The HOLD action
5, 6, 26: The SYSLOG action
7, 8, 27: The NETLOG action
9, 10, 28: The HCYLOG action
11, 12, 29: The DISPLAY action
13, 14, 30: The BEEP action
20: Whether the message is from MVS
24: Whether the message is an action message, such as a WTOR
47: Whether automation vector extensions exist
48: Whether presentation vectors exist in data buffers

Refer to the IBM Z NetView Programming: Assembler for a description of all bits.

The value of IFRAUTA1 evaluates to null ('') if all bits are B'0'. You can test for this condition by comparing to the null ('') keyword.

Maximum length: 48 bits

Type: Both

IFRAUWF1 [(pos [len])]

Indicates the AIFR fields IFRAUWF1, IFRAUWF2, IFRAUWF3, and IFRAUWF4, mapped in DSIIFR, which contain 32 bits of MVS WTO information.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Check these bits:

Bit: Meaning
6: Whether the message is a WTOR
7: Whether the message was suppressed
8: Whether the message was broadcast to all
9: Whether the job name is to be displayed
10: Whether the status is to be displayed
14: Whether the session is to be displayed

The value of IFRAUWF1 evaluates to null ('') if all bits are B'0'. You can test for this condition by comparing to the null ('') keyword.

Maximum length: 32 bits

Type: Message

INTERVAL(occurrence_number)

Returns an indication of whether this condition item has been evaluated against a multiple of occurrence_number times. Use this condition item for specifying actions to take place when a condition occurs periodically. The occurrence_number parameter specifies the interval to be checked. The value can be 1–1000000000.

The values returned by INTERVAL are:

1: Indicates that the condition item being evaluated is a multiple of occurrence_number
0: Returned for all other occurrences

For example, INTERVAL(5) returns a value of 1 when the condition item is evaluated for the fifth occurrence, the tenth occurrence, the fifteenth occurrence, and so on, and returns a value of 0 for every other occurrence.

The count of evaluations is incremented only if the INTERVAL condition item is reached during the sequential search for matches through the automation table. The count of evaluations is not incremented if one of these is true:

The statement with the INTERVAL condition item is not reached because of a prior statement match in the table.
The BEGIN-END conditional logic that resulted in the statement not being evaluated.
A prior condition in the automation-table statement that is linked with the logical-AND (&) operator evaluates as false.

Maximum length: 1 bit

Type: Both

Example: Statement evaluated by the INTERVAL keyword

IF MSGID = 'XYZ123I' &
     INTERVAL(5) = '1' THEN
       <actions>;

In this example, the evaluation count is incremented only if the sequential search through the active automation table reaches the statement and the message ID is XYZ123I. The automation actions are done only for the 5th, 10th, 15th (and so on) XYZ123I messages that reach this statement.

Usage notes for INTERVAL::

Choosing a useful interval value - The NetView program increments the evaluation count before determining whether the count has reached an interval multiple. Do not specify an interval value of 1 because the condition item always evaluates the same. For example, the statement INTERVAL(1) = '1' is always true.
Reset of the evaluation count - The evaluation count is reset to 0 if any of these events occur:
- The active automation table is replaced using the AUTOTBL command.
- The NetView automation-table function is turned off.
- The NetView program ends.

JOBNAME [(pos [len])]

The name of the MVS job where the received message originated. JOBNAME is a 1-8 character name.

Because the JOBNAME is the name of the job that originated the message, it might not always be the same as the name of the job to which the message refers. The names can differ when MVS issues a message about the NetView program job. If the message is issued during job start-up or shutdown, JOBNAME can contain the name of an initiator (instead of the actual job name), and you must extract the job name from the message text rather than from the JOBNAME keyword.

The same information is available with the MSGCOJBN condition item.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

The value of JOBNAME evaluates equal to null ('') if the message was not received from an MVS system, or has no associated job name. You can test for these cases by comparing to the null ('') keyword.

Maximum length: 8 characters

Type: Message

JOBNUM [(pos [len])]

The number assigned by MVS to the job where the received message originated. JOBNUM is an 8-character number that can include an alphabetic prefix and embedded blanks.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

The value of JOBNUM evaluates to equal to null ('') if the message was not received from MVS, or has no associated job number. You can test these cases by comparing to the null ('') keyword.

Maximum length: 8 characters

Type: Message

KEY [(pos [len])]

The key associated with a message. KEY might contain nondisplayable values.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

KEY has a value only if the message was originally a message data block (MDB).

Maximum length: 8 characters

Type: Message

LINEPRES [(pos [len])]

Contains the values for four presentation attributes:

Alarm control
Color
Highlighting
Intensity

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

LINEPRES is a 4-byte value taken from the first buffer of a message or MSU.

If the value for LINEPRES is not null, and bit 16 in LINETFLG is set on, the LINEPRES values are used for message and MSU presentation. These LINEPRES values are taken from one of two sources:

The presentation overrides specified in the message data buffer (MDB)
The presentation overrides as specified by a previous automation-table action

When one or more presentation attributes are set by the automation table (with the COLOR, HIGHINT, or XHILITE actions), all four of the presentation attributes for the message or MSU are copied to the LINEPRES fields and used to display that message or MSU. Attributes that are not set by the automation table are taken from MDB override fields, the fields in MSGGFGPA, or the values specified with the OVERRIDE or DEFAULTS SCRNFMT commands.

If LINEPRES is null, the presentation attributes of the message or MSU are taken from one of three other sources:

The fields in MSGGFGPA
The values specified with the OVERRIDE or DEFAULTS SCRNFMT command
For MSUs, the hardware monitor defaults

Even if LINEPRES is null, other presentation attributes apply to this message when it is displayed. When LINEPRES is null, you can check the fields in MSGGFGPA for presentation attributes.

The four LINEPRES characters have these meanings and possible values:

Byte

Description

1

Control field

Value: Meaning
80: MVS alarm-on indicator
00: MVS alarm-off indicator

Byte 1 is an MVS indicator. The NetView program does not use it. The NetView program indicators that control this alarm are in IFRAUTA1 bits 13, 14, and 30. The IFRAUTA1 alarm indicators can be set by the BEEP action in the automation table.

2

Color field

Value: Meaning
00: The foreground color
F0: Presentation background. Black on display, white on printer.
F1: Blue
F2: Red
F3: Pink (magenta)
F4: Green
F5: Turquoise (cyan)
F6: Yellow
F7: Presentation neutral. White on display, black on printer.

This field can be set by the COLOR action in the automation table. If the value is 00, the specific foreground color is determined by the fields in MSGGFGPA or the values specified by the OVERRIDE or DEFAULTS SCRNFMT commands.

3

Highlighting field

Value: Meaning
00: No highlighting
F1: Blinking
F2: Reverse video
F4: Underscore

This field can be set by the XHILITE action in the automation table.

4

Intensity field

Value: Meaning
E4: Normal intensity
E8: High (bright) intensity

This field can be set by the HIGHINT action in the automation table.

Maximum length: 4 bytes

Type: Both

LINETFLG [(pos [len])]

Is a 16-bit value taken from the first text buffer of any message or MSU.

Bit 16 of LINETFLG indicates whether the presentation attributes described in LINEPRES apply to this message or MSU. These are the values for bit 16:

Value: Meaning
0: Attributes returned by LINEPRES do not apply to the message or MSU.
1: Presentation attributes have been set to override the attributes in MSGGFPA, and do apply to this message or MSU.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 16 bits

Type: Both

MCSFLAG [(pos [len])]

The 16-bit MVS multiple console support flag.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Check these bits:

Bit: Meaning
2: The message is to be queued to the console if it is active
3: The message is a command response WTO
5: The message is a reply to a WTOR
6: The message is to be broadcast to all active consoles
7: The message is to be queued to hardcopy only
8: The message is to be queued unconditionally to the console
9: The message is not to be time-stamped
14: The message is not to be queued to hardcopy

The MCSFLAG values in REXX, high-level language (HLL), and NetView command list language (CLIST) return only eight of the possible 16 bits for MCSFLAG. The automation-table condition item MCSFLAG returns all 16 bits. Table 4 shows the difference between the automation-table condition item and the REXX, command list, and HLL variables. Do not use the bits that are not described for the automation table.

Table 4. The MCSFLAG Condition Item Compared to REXX, Command List, and HLL
Bit	MCSFLAG Condition Item	REXX, CLIST, and HLL
1		REG0
2	REG0	QREG0
3	RESP	RESP
4		REPLY
5	REPLY	BRDCST
6	BRDCST	HRDCPY
7	HRDCPY	NOTIME
8	QREG0	NOCPY
9	NOTIME
10
11
12
13
14	NOCPY
15
16

The value of MCSFLAG evaluates to null ('') if all bits are B'0'. You can test for this case by comparing to the null ('') keyword.

Maximum length: 16 bits

Type: Message

MSGAUTH [(pos [len])]

Indicates whether a message was issued from an authorized program. MSGAUTH is a two-bit indicator. The compare item is a bit string.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Values for MSGAUTH are:

B'00': The message is not from MVS
B'01': Not used
B'10': A WTO from an unauthorized program
B'11': A WTO from an authorized program

The value of the first bit of MSGAUTH evaluates to null ('') if the message is not from MVS. The value of the second bit evaluates to null ('') if the message is from an unauthorized MVS program. The value of both bits evaluates to null if the message is not from MVS. You can test for these cases by comparing to the null ('') keyword.

Maximum length: 2 bits

Type: Message

MSGCATTR [(pos [len])]

Indicates the MVS message-attribute flags. MSGCATTR is a 16-bit field.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Check these bits:

Bit: Meaning
1: The message was suppressed
2: The message is a command response
3: The message was issued by an authorized program
4: The message is to be retained by the automation message retention facility (AMRF)

MSGCATTR has a value only if the message was originally a message data block (MDB).

Maximum length: 16 bits

Type: Message

MSGCMISC [(pos [len])]

Indicates the MVS miscellaneous routing flags. MSGCMISC is an 8-bit field.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Check these bits:

Bit: Meaning
1: Whether undeliverable messages are to be displayed
2: Whether only undeliverable messages are to be displayed
3: Whether messages are to be queued by ID only
4: Whether the message has been marked in the message processing facility (MPF) table as eligible for NetView program automation

MSGCMISC has a value only if the message was originally a message data block (MDB).

Maximum length: 8 bits

Type: Message

MSGCMLVL [(pos [len])]

Indicates the MVS message-level flags. MSGCMLVL is a 16-bit field. The compare item is a bit string.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Check these bits:

Bit: Meaning
1: A WTOR
2: An immediate action message
3: A critical eventual action message
4: An eventual action message
5: An informational message
6: A broadcast message

MSGCMLVL only has a value if the message was originally a message data block (MDB).

Maximum length: 16 bits

Type: Message

MSGCMSGT [(pos [len])]

Indicates the MVS message-type flags. MSGCMSGT is a 16-bit field. These bits apply to messages displayed on an MVS console; these bits are not used by the NetView program.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Check these bits:

Bit: Meaning
1: Job names are to be displayed
2: Status is to be displayed

MSGCMSGT only has a value if the message was originally a message data block (MDB).

Maximum length: 16 bits

Type: Message

MSGCOJBN [(pos [len])]

Indicates the originating job name. MSGCOJBN is a name that contains 1-8 characters. (The same information is available with the JOBNAME condition item.)

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

MSGCOJBN only has a value if the message was originally a message data block (MDB).

Maximum length: 8 characters

Type: Message

MSGCPROD [(pos [len])]

Indicates the MVS product level. MSGCPROD is a 16-character string consisting of a 4-character MVS control program object version level, a 4-character control program name MVS, and an 8-character identifier for the originating system.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

MSGCPROD has a value only if the message was originally a message data block (MDB).

Maximum length: 16 characters

Type: Message

MSGCSPLX [(pos [len])]

The name of the MVS SYSPLEX where the received message originated.

MSGCOJBN is a name that contains 1–8 characters. The pos parameter is the position where the comparison begins and has a default value of 1. The compare item is a parse template.

The value of MSGCSPLX evaluates to equal to null ('') if the message was not received from an MVS SYSPLEX, has no associated SYSPLEX name, or the message was not originally a message data block (MDB). You can test these cases by comparing them to the null ('') keyword.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 8 characters

Type: Message

MSGDOMFL [(pos [len])]

Indicates the MVS DOM flags. MSGDOMFL is an 8-bit field.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Check the following bits:

Bit: Meaning
1: A DOM by message ID (MSGID)
2: A DOM by system ID (SYSID)
3: A DOM by the NetView address-space ID (ASID)
4: A DOM by a job step TCB
5: A DOM by a token

MSGDOMFL has a value only if the message was originally a message data block (MDB).

multiple console support consoles are set up by default as DOM(NORMAL) receivers. As a result, the DOMs that are received from MVS by these consoles have a flag in bit 1. The SYSID, ASID, TCB, and TOKEN bit flags are not usually set on when the DOM is received from an MVS program.

Maximum length: 8 bits

Type: Message

MSGGBGPA [(pos [len])]

Indicates the background presentation attributes. MSGGBGPA is a 4-byte hexadecimal value. The compare item is a parse template.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

These are the byte descriptions:

Byte: Meaning
1: Background control
2: Background color
3: Background highlighting
4: Background intensity

For a description of the values for each byte, see LINEPRES.

MSGGBGPA has a value only if the message was originally a message data block (MDB).

Maximum length: 4 bytes

Type: Message

MSGGDATE [(pos [len])]

The date that the message originator placed in the MDB. MSGGDATE is a 7-character date in the form yyyyddd where yyyy is the year and ddd is the day of the year.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

MSGGDATE only has a value if the message was originally a message data block (MDB).

Maximum length: 7 characters

Type: Message

MSGGFGPA [(pos [len])]

Indicates the foreground presentation attributes. MSGGFGPA is a 4-byte hexadecimal value. The compare item is a parse template.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

The byte descriptions are:

Byte: Meaning
1: Foreground control
2: Foreground color
3: Foreground highlighting
4: Foreground intensity

For a description of the values for each byte, see LINEPRES.

MSGGFGPA has a value only if the message was originally a message data block (MDB).

Maximum length: 4 bytes

Type: Message

MSGGMFLG [(pos [len])]

Indicates the MVS general message flags. MSGGMFLG is a 16-bit field. Bit 1 indicates a DOM. Do not test other bits.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

MSGGMFLG has a value only if the message was originally a message data block (MDB).

Maximum length: 16 bits

Type: Message

MSGGMID [(pos [len])]

The 4-character MVS message identifier. MSGGMID might contain nondisplayable characters.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

MSGGMID has a value only if the message was originally a message data block (MDB).

Maximum length: 4 characters

Type: Message

MSGGTIME [(pos [len])]

The time MVS associates with the message. MSGGTIME is an 11-character (including periods) time in the form hh.mm.ss.th, where hh is the hours, mm is the minutes, ss is the seconds, and th is hundredths of seconds.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

MSGGTIME has a value only if the message was originally a message data block (MDB).

Maximum length: 11 characters

Type: Message

MSGID [(pos [len])]

The message identifier of the received message. MSGID is a 1–255 character ID. The message identifier is usually the first token of the message. If a REPLYID is sent with the message, the REPLYID is not used as the first token.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 255 characters

Type: Message

MSGSRCNM [(pos [len])]

Indicates the 1-17 character source name.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

This source name is an identifier from the source object which was provided by either the DSIMMDB or CNMPMDB application programming interface (API) invocation.

For more information about DSIMMDB, refer to IBM Z NetView Programming: Assembler. For more information about CNMPMDB, refer to IBM Z NetView Programming: PL/I and C.

The source name is selected from the source object by these rules:

The first alias, if any
The first network identifier concatenated to a network addressable unit (NAU) name, with a period (.) between them, if both exist in sequence
The first existing NAU name
The string N/A, if none of the other names in this list are specified in the source object
Null, if there is no source object

For more information about how the source object is defined and the DSIAIFRO mapping, refer to IBM Z NetView Programming: Assembler.

Note: This function has a value only if the message was originally an MDB with an associated source object.

Maximum length: 17 characters

Type: Message

MSUSEG (location [byte [bit]])

Indicates the contents of one segment of an MSU. The compare item can be a bit string or a parse template.

location

The location of the data to be compared. The syntax for the parameter is:

Location Parameter

H: For an MDS-MU, indicates that the first key is to be obtained at the MDS-MU level, rather than the major-vector level. If you use this parameter and the MSU being processed is not an MDS-MU, MSUSEG returns a value of null.
key: The 2-character or 4-character representation of the 1-byte or 2-byte hexadecimal ID of the generalized data stream (GDS) variable or key of the major vector, subvector, subfield, or sub-subfield.
You can use more than one key, separating them with periods. Each additional key specifies a lower-level structure within the structure identified by the preceding key.
occurnum: The occurrence number, counting from 1, of the GDS variable, major vector, subvector, subfield, or sub-subfield. An asterisk (*) means you want any occurrence. For example, used at the subvector level, an occurnum of 2 means you want the second instance of the key subvector. An occurnum of * means you want the first subvector with a key of key, if any, that results in equality with the compare item you have specified. The maximum occurnum is 32767, and the default is 1.

byte

The byte position within the lowest key specified in location. A position of 1, not a 0, designates the first byte. The maximum is 32767, and the default is 1.

bit

The bit position within the byte specified by byte. The bit position can be any number from 1 to 8. Note that a position of 1, not a 0, designates the first bit. If you specify a bit position, the compare item is a bit string. Otherwise, the compare item is a parse template.

MSUSEG does not support a length specification. You can assign MSUSEG to a variable, and then use that variable (including pos and len) in a VALUE conditional statement.

Maximum length: Varies

Type: MSU

Usage notes:

See Writing Automation Table Statements to Automate MSUs for examples of how to use MSUSEG.
The MSUSEG automation-table statement is not interchangeable with REXX's MSUSEG function or the NetView command list language's &MSUSEG control variable. The formats for specifying an MSU location are similar, but other syntax details vary.

MVSLEVEL [(pos [len])]

The 8-character string that identifies the level of MVS that is currently running.

You can use the LISTVAR command to determine the MVS level on your system.

In contrast to the MVSLEVEL condition item, the MSGCPROD condition item identifies the system level of MVS that the message came from.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

The value of MVSLEVEL is null if the currently running system is not MVS.

Maximum length: 8 characters

Type: Both

NETID [(pos [len])]

Indicates the VTAM network identifier. This field has a maximum length of 8 characters.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

If VTAM has never been active when the NetView program is active, the value of NETID is null.

Maximum length: 8 characters

Type: Both

NETVIEW [(pos [len])]

Indicates the version and release of the currently running NetView program. The value of NETVIEW is a 4-character field in the form NVvr where v is the version number and r is the release number.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 4 characters

Type: Both

NUMERIC (variable[pos [len]])

Indicates a variable to convert from a text value to a numeric value and to compare to the numeric value of the literal specified in the parse template.

pos: The position where the text to convert to a numeric begins within the variable value. The default value is 1.
len: The length of the text value to convert to a numeric. This value can be positive or negative; decimal points are not supported. The default value is the remaining portion of the variable beginning with pos.

Maximum length: 255 characters

Type: Both

NVCLOSE [(pos [len])]

Indicates whether the NetView program is currently performing CLOSE processing. It is a 1-bit indicator. Values for NVCLOSE are as follows:

1: The NetView program is performing CLOSE processing
0: The NetView program is not performing CLOSE processing

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Note: Use the NVCLOSE check with caution. If NVCLOSE is used as the only condition item on an automation statement, a looping condition can occur. The intent is to use the NVCLOSE condition item in conjunction with other condition items as shown in this example.

Maximum length: 1 bit

Type: Both

Example:

If you use MYCMD to restart the task referred to in the DSI008I message, this automation statement can prevent attempts to restart tasks during CLOSE processing.

IF MSGID = 'DSI008I' & NVCLOSE ¬= '1' THEN
  EXEC(CMD('MYCMD')ROUTE(ONE AUTO1));

Usage notes for NVCLOSE::

The value of NVCLOSE evaluates to null ('') when CLOSE processing is not currently running. You can test for this case by comparing to the null ('') keyword.
If you have automation running on the PPT task, which determines whether tasks are active, and if the NetView program is using CLOSE STOP processing, a loop can occur. This loop can prevent the NetView program from completing CLOSE STOP processing. For example, if PPT is issuing EXCMD for various tasks, the NetView program does not end until the PPT has completed the task.

NVDELID [(pos [len])]

Indicates a 24-character EBCDIC value for a message that can be used as input by the DOM command to delete an action message.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 24 characters

Type: Message

OPID [(pos [len])]

Indicates the operator or task ID under which the automation table is processing. OPID is a 1-8 character ID.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 8 characters

Type: Both

OPSYSTEM [(pos [len])]

Indicates the operating system for which the NetView program was compiled. This field has a maximum length of 7 characters.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 7 characters

Type: Both

ROUTCDE [(pos [len])]

Identifies one or more MVS routing-code bits assigned to the message. A message can have up to 128 routing-code bits.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Refer to the MVS library for information about code values.

Maximum length: 128 bits

Type: Message

SESSID [(pos [len])]

Indicates the 1-8 character identifier of the NetView terminal access facility (TAF) session that sent the received message.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

The value of SESSID is a string of hexadecimal zeros (X'00') if the message did not come over a TAF session. You can test for this case by comparing to the null ('') keyword.

Maximum length: 8 characters

Type: Message

SYSCONID [(pos [len])]

Specifies the MVS system console name associated with the message. System console names are from 1 to 8 characters in length.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 8 characters

Type: Message

SYSID [(pos [len])]

Indicates the 1-8 character identifier of the MVS system that sent the message.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

One use for SYSID is in a sysplex. You can add SYSID to your existing automation-table statements to block messages from certain systems, or to invoke certain automation-table actions based on the system ID.

This example shows how you can use SYSID to process messages local to your system, whether the message originated from MVS or not. In the example, the local system name is SYSA:

IF (SYSID = 'SYSA' | SYSID = '') THEN
  BEGIN;
    .
    .
    .
  END;

Messages originating from MVS on system SYSA satisfies the check for SYSID because they have a SYSID value equal to 'SYSA'. Messages that did not originate from MVS but are local to system SYSA also match because they have a SYSID equal to null.

Maximum length: 8 characters

Type: Message

SYSPLEX [(pos [len])]

Identifies the name of the MVS SYSPLEX where the received message is being automated. SYSPLEX is a 1-8 character name.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

The value of SYSPLEX evaluates to equal to null ('') if the message is not being automated on an MVS SYSPLEX or has no associated SYSPLEX name. You can test these cases by comparing to the null ('') keyword.

Maximum length: 8 characters

Type: Both

TASK [(pos [len])]

Specifies the type of task under which the automation table is processing. TASK is a 3-character string.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

The values for TASK are:

HCT: A hardcopy task.
DST: A data services task. DST is an optional task that has MOD=DSIZDST specified in the CNMSTYLE member.
OPT: An optional task. The CNMCSSIR task always evaluates to a value of OPT.
OST: An operator station task. Automation tasks evaluate to a value of OST. You can use the AUTOTASK and DISTAUTO condition items to distinguish autotasks from other OSTs.
NNT: A NetView-NetView task.
MNT: The NetView program main task.
PPT: The primary POI task.

Maximum length: 3 characters

Type: Both

TEXT [(pos [len])]

Specifies the text of the received message. TEXT is a 1-25 character string that contains the entire message text, including the MSGID.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

The compare item is a parse template.

Maximum length: 255 characters

Type: Message

THRESHOLD(occurrence_number [time_period])

Returns an indication of whether the threshold condition item has been evaluated against at least occurrence_number of times during the prior time_period. The THRESHOLD condition item is useful for specifying particular actions to take place when a condition has happened at least a specified number of times within a specified time period. See Figure 2 for an example of these occurrence-detection condition items:

occurrence_number

Specifies the number of occurrences within the specified time period that cause the threshold condition to be reached. The value can be 1–1000.

time_period

Specifies the time interval of the threshold. The default is 24 hours. The time period is specified as ddd hh:mm:ss, where:

ddd: The number of days in the range of 0–365. If you specify ddd, you must also specify hh:mm:ss.
hh:mm:ss: The hours (ranging 00–23), minutes (ranging 00–59), and seconds (ranging 00–59).

You cannot specify a time period of zero. If you specify only one numeric value for time_period, without any colon delimiters (:), the NetView program assumes it to be a value for minutes.

Table 5 shows examples of valid THRESHOLD specifications.

Table 5. Examples of Valid THRESHOLD Specifications
SPECIFICATION	OCC.#	DAYS	HOURS	MIN.	SEC.
`THRESHOLD(3) = '1'`	3	1
`THRESHOLD(4 1 00:00:00) = '1'`	4	1
`THRESHOLD(5 1:00) = '1'`	5		1
`THRESHOLD(6 0 1:00:00) = '1'`	6		1
`THRESHOLD(7 10) = '1'`	7			10
`THRESHOLD(8 :30) = '1'`	8				30
`THRESHOLD(9 10 10) = '1'`	9	10		10
`THRESHOLD(10 10 00:10:00) = '1'`	10	10		10

Unless you are accepting the default time period of 24 hours (one day), specify all the elements of time_period (days, hours, minutes, and seconds), even though they are not required, to avoid any misunderstanding of what the time period is.

The values returned by THRESHOLD are:

1: Indicates the number of occurrences within the specified time period is equal to or greater than the value of occurrence_number
0: Returned for all other occurrences

The count of evaluations is incremented only if the THRESHOLD condition item is reached during the sequential search (for matches) of the automation table. The count of evaluations is not incremented if one of these situations is true:

The statement with the THRESHOLD condition item is not reached because of a prior statement match in the table.
The BEGIN-END conditional logic that resulted in the statement was not evaluated.
A prior condition in the automation-table statement that is linked with the logical-AND (&) operator evaluates to false.

In Figure 1, the evaluation count is incremented only if the sequential search through the active automation table reaches this statement and if the message ID is XYZ123I.

The automation actions are done only for the fifth (or more) XYZ123I message that reaches this statement during the automation table search for any 3-hour time period.

Figure 1. Statement Evaluated by the THRESHOLD Keyword

IF MSGID = 'XYZ123I' &
   THRESHOLD(5 0 3:00:00) = '1' THEN
     <actions>;

Maximum length: 1 bit

Type: Both

Usage notes for THRESHOLD::

Elapsed time and the time period - For every evaluation of the THRESHOLD condition, the number of occurrences during the prior time period (specified by time_period) is examined to see if the threshold has been reached. As time passes, prior occurrences might no longer be within time_period.
Choosing a useful occurrence value - The NetView program increments the evaluation count before determining whether the threshold has been reached. Do not specify an occurrence value of 1 because the condition item always evaluates the same. For example, the condition item THRESHOLD(1 x x:xx:xx) = '1' is always true.
Reset of the evaluation count - The evaluation count is reset to 0 if any of these events occur:
- The active automation table is replaced using the AUTOTBL command.
- The NetView automation-table function is turned off.
- The NetView program is ended.
Defining limits on actions - You can define an ending occurrence number (a point at which you no longer want to take a certain action) by combining two THRESHOLD condition items on one statement. If, for example, you want certain actions to occur only on the 3rd through 6th occurrence of message XYZ123I within any one-hour time period, you can use this automation-table statement:
```
IF MSGID = 'XYZ123I' &
   THRESHOLD(3 0 01:00:00) = '1' &
   THRESHOLD(5 0 01:00:00) = '0' THEN
       <actions>;
```
The second THRESHOLD condition item in the statement is evaluated only after the first threshold is met (starting with the third occurrence of the XYZ123I message within a one-hour period). The fifth evaluation of the second THRESHOLD condition item is the seventh occurrence of the XYZ123I message.
Processing of immediate messages - If the automation table evaluates THRESHOLD for a NetView message sent to the immediate message area of the operator's screen (that is, if TVBINXIT is on), the THRESHOLD occurrence count is not incremented, and the condition evaluates as false.

TOKEN [(token-number [pos [len]])]

Indicates a particular word or phrase within the message. The NetView program uses the blank spaces between words and phrases to divide a message into tokens. A token consists of all the characters between two nonadjacent blank spaces. The compare item is a parse template.

token-number: The number of the token you want to compare. It must have a numeric value; the default value is 1.
pos: Indicates the position, within the specified token where comparison begins. The default value is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 255 characters

Type: Message

VALUE (variable [pos [len]])

Indicates the name of the variable whose value is to be used in a comparison.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

Maximum length: 255 characters

Type: Both

VTAM [(pos [len])]

Indicates the version and release of VTAM. VTAM is a 4-character string in the form VTvr or Vvrm, where v is the version number, r is the release number, and m is the modification number.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

The value of VTAM evaluates to null ('') when VTAM is inactive. You can test for this case by comparing to the null ('') keyword.

Maximum length: 4 characters

Type: Both

VTCOMPID [(pos [len])]

Indicates the VTAM component identifier. VTCOMPID is a 14-character string.

You can use the LISTVAR command to determine the VTAM component identifier.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

The value of VTCOMPID evaluates to null ('') when VTAM is inactive. You can test for this case by comparing to the null ('') keyword.

Maximum length: 14 characters

Type: Both

WEEKDAYN [(pos [len])]

Is a numeric value 1–7 representing the day of the week.

pos: The position where the comparison begins. The default is 1.
len: The length of the string to be compared. The default value is the remaining portion of the string beginning with pos.

The possible character values for WEEKDAYN are:

1: Monday
2: Tuesday
3: Wednesday
4: Thursday
5: Friday
6: Saturday
7: Sunday

Maximum length: 1 character

Type: Both