Parameters
The parameters are explained as follows:
- name
- An optional symbol, starting in column 1, that is the name on
the IWM4MINI macro invocation. The name must conform to the rules
for an ordinary assembler language symbol.
- ,ARRIVALTIME=arrivaltime
- When ARRIVALTIMEP=YES and MODE=RESET are specified, a required
input parameter, which contains the work arrival time in STCK format.
To code: Specify the RS-type address, or address
in register (2)-(12), of a 64 bit field.
- ,ARRIVALTIMEP=CURRENT
- ,ARRIVALTIMEP=YES
- When MODE=RESET is specified, a required parameter, which indicates
whether the work arrival time is passed. This keyword is not applicable
for report-only or bufferpool-only monitoring environments.
- ,ARRIVALTIMEP=CURRENT
- indicates that the current time should be supplied by the service.
- ,ARRIVALTIMEP=YES
- indicates that the work arrival time is passed.
- ,ASID=asid
- When ASSOCIATE=ADDRESS_SPACE and REPORTONLY=YES are specified,
a required input parameter, which contains the address space ID.
To code: Specify the RS-type address, or address
in register (2)-(12), of a 16 bit field.
- ,ASSOCIATE=ENCLAVE
- When BPMGMTONLY=YES and REPORTONLY=NO are specified, a required
parameter, which indicates whether the monitoring environment should
be associated only to an enclave
- ,ASSOCIATE=ENCLAVE
- indicates that the monitoring environment should be associated
to an enclave.
- ,ASSOCIATE=ENCLAVE
- ,ASSOCIATE=ADDRESS_SPACE
- When REPORTONLY=YES is specified, a required parameter, which
indicates whether the monitoring environment should be associated
to an enclave or an address space.
- ,ASSOCIATE=ENCLAVE
- indicates that the monitoring environment should be associated
to an enclave.
- ,ASSOCIATE=ADDRESS_SPACE
- indicates that the monitoring environment should be associated
to an address space.
- ,BPMGMTONLY=NO
- ,BPMGMTONLY=YES
- When REPORTONLY=NO is specified, an optional parameter, which
indicates whether the monitoring environment is for bufferpool management
purposes only (YES) or not (NO). The default is BPMGMTONLY=NO.
- ,BPMGMTONLY=NO
- indicates that the monitoring environment is not for bufferpool
management purposes only.
- ,BPMGMTONLY=YES
- indicates that the monitoring environment is for bufferpool
management purposes only.
- ,CONTINUEP=YES
- ,CONTINUEP=NO
- A required parameter, which indicates whether it is known (YES)
or not (NO) that there exists another monitoring environment for this
same work request.
- ,CONTINUEP=YES
- indicates that the existence of a prior monitoring environment
for the work request is known.
- ,CONTINUEP=NO
- indicates that it is not known whether there exists a prior
monitoring environment for the work request. If MODE(RESET) is specified,
no status is saved. If MODE(RETAIN) is specified, the existing status
is preserved.
- ,DISPTYPE=TCB
- ,DISPTYPE=SRB
- When MODE=RESET is specified, a required parameter, which describes
the nature of the MVS dispatchable units which participate in processing
work requests associated with the delay monitoring environment established
by this service.
- ,DISPTYPE=TCB
-
indicates that work requests run in TCB mode under a TCB
within the current home address space. Note that in cross-memory mode,
this may be different from the current primary address space.
- ,DISPTYPE=SRB
-
indicates that work requests run in SRB mode within the current
home address space.
- ,DISPTYPE=SAVEDTYPE
- ,DISPTYPE=TCB
- ,DISPTYPE=SRB
- When MODE=RETAIN is specified, a required parameter, which describes
the nature of the MVS dispatchable units which participate in processing
work requests associated with the delay monitoring environment established
by this service.
- ,DISPTYPE=SAVEDTYPE
-
indicates that the information saved when MODE(RESET) was
used is still applicable.
- ,DISPTYPE=TCB
-
indicates that work requests run in TCB mode under a TCB
within the current home address space. Note that in cross-memory mode,
this may be different from the current primary address space.
- ,DISPTYPE=SRB
-
indicates that work requests run in SRB mode within the current
home address space.
- ,DURATION=EXECUTION
- ,DURATION=BEGIN_TO_END
- When MODE=RESET is specified, an optional parameter, which indicates
the duration of the work request over which the delays are to be represented.
The default is DURATION=EXECUTION.
- ,DURATION=EXECUTION
- indicates that the monitoring environment will reflect delays
from the point where an application or transaction program is given
control, i.e. the execution phase. Typically a monitoring environment
with this scope would be passed to IWM4MNTF to pass the execution
time for the work request.
- ,DURATION=BEGIN_TO_END
- indicates that the monitoring environment will reflect delays
from the arrival of the work request into the MVS sysplex until its
completion. Ordinarily use of this option would be in close proximity
to the time when the work request is classified. Typically a monitoring
environment with this duration would be passed to Iwmrpt to report
the total elapsed time for the work request.
- ,DURATION=PREV_VALUE
- ,DURATION=EXECUTION
- ,DURATION=BEGIN_TO_END
- When MODE=RETAIN is specified, an optional parameter, which
indicates the duration of the work request over which the delays are
to be represented. The default is DURATION=PREV_VALUE.
- ,DURATION=PREV_VALUE
- indicates that the duration for delays has been specified on
a previous invocation.
- ,DURATION=EXECUTION
- indicates that the monitoring environment will reflect delays
from the point where an application or transaction program is given
control, i.e. the execution phase. Typically a monitoring environment
with this duration would be passed to IWM4MNTF to pass the execution
time for the work request.
- ,DURATION=BEGIN_TO_END
- indicates that the monitoring environment will reflect delays
from the arrival of the work request into the MVS sysplex until its
completion. Ordinarily use of this option would be in close proximity
to the time when the work request is classified. Typically a monitoring
environment with this duration would be passed to Iwmrpt to report
the total elapsed time for the work request.
- ,ENCLAVETOKEN=enclavetoken
- When ASSOCIATE=ENCLAVE, BPMGMTONLY=YES and REPORTONLY=NO are
specified, a required input parameter, which contains the enclave
token.
To code: Specify the RS-type
address, or address in register (2)-(12), of a 64 bit field.
- ,ENCLAVETOKEN=enclavetoken
- When ASSOCIATE=ENCLAVE and REPORTONLY=YES are specified, a required
input parameter, which contains the enclave token.
To
code: Specify the RS-type address, or address in register
(2)-(12), of a 64 bit field.
- EWLM=NO
- An optional parameter, which indicates if this work manager
intents to participate in cross platform Enterprise Workload Management
(eWLM). The default is EWLM=NO.
- EWLM=NO
- The work manager interacts only with WLM and no interaction
with eWLM takes place.
- ,EWLM_PACORR=ewlm_pacorr
- ,EWLM_PACORR=NO_EWLM_PACORR
- When MODE=RESET is specified, an optional input parameter, which
contains the cross platform Enterprise Workload Management (EWLM)
parent correlator associated with the work request.
Note:
- If EWLM_PACORR is specified and the correlator does not contain
a valid ARM correlator, reason code IwmRsnCodeInvalidEWLMCorr is returned
to the caller. Refer to Table 78 for further information.
If the corrrelator is a valid ARM correlator, but cannot be understood
by EWLM (no EWLM format), it is silently ignored.
- Parameters EWLM_PACORR and EWLM_PACTKN are mutually exclusive.
The default is NO_EWLM_PACORR. indicates
that no EWLM parent correlator is passed.
To
code: Specify the RS-type address, or address in register
(2)-(12), of a character field.
- ,EWLM_PACTKN=ewlm_pactkn
- ,EWLM_PACTKN=NO_EWLM_PACTKN
- When MODE=RESET is specified, an optional input parameter, which
contains the cross platform Enterprise Workload Management (EWLM)
parent correlator token associated with the work request.
If EWLM_PACTKN is specified and the correlator
token does not contain a valid correlator token, reason code IwmRsnCodeInvalidEWLMCorr
is returned to the caller (see Return Codes section). The default
is NO_EWLM_PACTKN. indicates that no EWLM correlator token is passed.
To code: Specify the RS-type address, or address
in register (2)-(12), of a character field.
- ,EXSTARTTIME=exstarttime
- When EXSTARTTIMEP=YES, BPMGMTONLY=NO and REPORTONLY=NO are specified,
a required input parameter, which contains the start execution time
in STCK format.
To code: Specify the
RS-type address, or address in register (2)-(12), of a 64 bit field.
- ,EXSTARTTIMEP=NO
- ,EXSTARTTIMEP=CURRENT
- ,EXSTARTTIMEP=YES
- When BPMGMTONLY=NO and REPORTONLY=NO are specified, a required
parameter, which indicates whether the execution start time value
is passed.
- ,EXSTARTTIMEP=NO
- indicates that the execution start time value is not passed.
If
MODE(RETAIN) is specified, EXSTARTTIMEP(NO) will preserve the existing
execution start time, if any.
- ,EXSTARTTIMEP=CURRENT
- indicates that the current time should be supplied by the service.
- ,EXSTARTTIMEP=YES
- indicates that the start execution time value is passed.
- ,FROM=NONE
- ,FROM=LOCALMVS
- ,FROM=SYSPLEX
- ,FROM=NETWORK
- When CONTINUEP=YES is specified, a required parameter.
- ,FROM=NONE
- indicates that there is no other environment.
- ,FROM=LOCALMVS
- indicates that such an environment should exist on the current
MVS.
- ,FROM=SYSPLEX
- indicates that such an environment should exist in the current
syplex, but is not expected to be on the current MVS image.
- ,FROM=NETWORK
- indicates that such an environment may exist, but is not expected
to be in the current sysplex.
- ,FROM_SUBSYSNM=from_subsysnm
- ,FROM_SUBSYSNM=NO_SUBSYSNM
- An optional input parameter, which contains the subsystem name
from where the request came in. The default is NO_SUBSYSNM which indicates
that no FROM_SUBSYSNM is provided.
If MODE(RETAIN) is specified,
NO_SUBSYSNM will preserve the existing FROM_SUBSYSNM, if any.
To code: Specify the RS-type address, or address
in register (2)-(12), of an 8-character field.
- ,LU62TKN=lu62tkn
- ,LU62TKN=NO_LU62TKN
- An optional input parameter, which contains LU 6.2 token for
the work request. This is not a SNA term, but it is comprised of the
following fields which are defined by SNA for the FMH5.
- Logical Unit of Work Identifier length byte, in binary, which
may have the values 0 or 10-26 decimal (inclusive)
- Logical Unit of Work Identifier
- Length byte for the network qualified LU name, in binary, which
may have the values 1-17 decimal (inclusive)
- Network qualified LU network name (1-17 bytes)
- Logical Unit of Work Instance Number, in binary (6 bytes)
- Logical Unit of Work Sequence Number, in binary (2 bytes)
- Conversation Correlator Field (0 to 9 bytes)
- Length byte for the Conversation Correlator, in binary, which
may have the values 0-8 decimal (inclusive)
- Conversation Correlator of the sending transaction (1-8 bytes)
The Conversation Correlator Field (which includes its length
byte) may be dropped when its length byte is 0. The default is NO_LU62TKN.
indicates that no LU 6.2 token was passed.
If MODE(RETAIN)
is specified, NO_LU62TKN will preserve the existing LU6.2 token, if
any.
To code: Specify the RS-type
address, or address in register (2)-(12), of a character field.
- ,LU62TKN_FMT=LU_NO_CC_27
- ,LU62TKN_FMT=FULL_LU_NO_CC_27
- ,LU62TKN_FMT=FULL_LU_0_CC_28
- ,LU62TKN_FMT=FULL_LU_CC_36
- ,LU62TKN_FMT=OTHER
- When LU62TKN=lu62tkn is specified, a required parameter,
which indicates the format/length of the LU 6.2 token.
- ,LU62TKN_FMT=LU_NO_CC_27
- indicates that a fixed length token of 27 bytes is provided,
with no conversation correlator (not even its length byte). The LU
name may be 1-17 bytes. Bytes at the end of the token are padded with
hexadecimal zeros, if necessary, to form a full 27 bytes.
- ,LU62TKN_FMT=FULL_LU_NO_CC_27
- indicates that the fully qualified LU name (17 bytes) is used,
but no conversation correlator (not even its length byte) is provided.
This format is architected to be 27 bytes long.
- ,LU62TKN_FMT=FULL_LU_0_CC_28
- indicates that the fully qualified LU name (17 bytes) is used,
and the conversation correlator length byte is present and has the
value 0. This format is architected to be 28 bytes long.
- ,LU62TKN_FMT=FULL_LU_CC_36
- indicates that the fully qualified LU name (17 bytes) is used,
and the conversation correlator is provided with a length of 8 (maximum
allowed). This format is architected to be 36 bytes long.
- ,LU62TKN_FMT=OTHER
- indicates that the format of the LU 6.2 token is different from
those specified by the remaining keywords.
- ,LU62TKN_LEN=lu62tkn_len
- When LU62TKN_FMT=OTHER and LU62TKN=lu62tkn are specified,
a required input parameter, which contains the length of the LU62
token. Valid values are in the range 1-36 decimal (inclusive).
To code: Specify the RS-type address, or address
in register (2)-(12), of a one-byte field.
- ,MODE=RESET
- ,MODE=RETAIN
- A required parameter, which indicates how previous attributes
established for a monitoring environment should be treated. This does
not refer to (or include) attributes established in IWM4MCRE.
- ,MODE=RESET
- indicates that previous attributes should be discarded.
- ,MODE=RETAIN
- indicates that previous attributes should be retained unless
explicitly specified.
- ,MONTKN=montkn
- A required input parameter which contains the delay monitoring
token.
To code: Specify the RS-type
address, or address in register (2)-(12), of a 32 bit field.
- ,MONTKN64=montkn64
- A required input parameter which contains the long delay monitoring
token.
To code: Specify the RS-type
address, or address in register (2)-(12), of a 64 bit field.
- ,OWNER_DATA=owner_data
- ,OWNER_DATA=NO_OWNER_DATA
- An optional input parameter, which contains data maintained
by the user/owner of the monitoring environment. The format is undefined
to MVS. The default is NO_OWNER_DATA which indicates that no owner
data is provided.
If MODE(RETAIN) is specified, NO_OWNER_DATA will
preserve the existing owner data, if any.
To
code: Specify the RS-type address, or address in register
(2)-(12), of a 32 bit field.
- ,OWNER_TOKEN=owner_token
- ,OWNER_TOKEN=NO_OWNER_TOKEN
- An optional input parameter, which contains a token maintained
by the user/owner of the monitoring environment. The format is undefined
to MVS. The default is NO_OWNER_TOKEN which indicates that no owner
token is provided.
If MODE(RETAIN) is specified, NO_OWNER_TOKEN
will preserve the existing owner token, if any.
To
code: Specify the RS-type address, or address in register
(2)-(12), of a 32 bit field.
- ,PLISTVER=IMPLIED_VERSION
- ,PLISTVER=MAX
- ,PLISTVER=0
- ,PLISTVER=1
- ,PLISTVER=2
- An optional input parameter that specifies the version of the
macro. The values are:
- IMPLIED_VERSION, which is the lowest
version that allows all parameters specified on the request to be
processed. If you omit the PLISTVER parameter, IMPLIED_VERSION
is the default.
- MAX, if you want to indicate the latest
version currently possible.
- 0, which supports all parameters except
those specifically referenced in higher versions.
- 1, which supports both the following parameters
and those from version 0:
| | |
---|
BPMGMTONLY
|
EWLM_PACORR
|
EWLM_PACTKN
|
- 2, which supports both the following parameters
and those from version 0 and 1:
| | |
---|
FROM_SUBSYSNM
|
MONTKN
|
MONTKN64
|
To code: Specify one of the following:
- IMPLIED_VERSION
- MAX
- A decimal value of 0, 1, or 2
- ,REPORTONLY=NO
- ,REPORTONLY=YES
- An optional parameter, which indicates whether the monitoring
environment is for reporting purposes only (YES) or not (NO). The
default is REPORTONLY=NO.
- ,REPORTONLY=NO
- indicates that the monitoring environment is not for reporting
purposes only.
- ,REPORTONLY=YES
- indicates that the monitoring environment is for reporting purposes
only.
- ,RETCODE=retcode
- An optional output parameter into which the return code is to
be copied from GPR 15. If you specify 15, GPR15, REG15, or R15 (within
or without parentheses), the value will be left in GPR 15.
To code: Specify the RS-type address of a
fullword field, or register (2)-(12) or (15), (GPR15), (REG15), or
(R15).
- ,RSNCODE=rsncode
- An optional output parameter into which the reason code is to
be copied from GPR 0. If you specify 0, 00, GPR0, GPR00, REG0, REG00,
or R0 (within or without parentheses), the value will be left in GPR
0.
To code: Specify the RS-type address
of a fullword field, or register (0) or (2)-(12), (00), (GPR0), (GPR00),
REG0), (REG00), or (R0).
- ,SCOPE=SHARED
- ,SCOPE=SINGLE
- A required parameter, which indicates the scope of work passed.
- ,SCOPE=SHARED
- indicates that multiple work requests, possibly from different
service classes, could be described.
- ,SCOPE=SINGLE
- indicates that only a single work request is described.
- ,SERVCLS=servcls
- ,SERVCLS=NO_SERVCLS
- When BPMGMTONLY=NO and REPORTONLY=NO are specified, an optional
input parameter, which contains the service class token. The default
is NO_SERVCLS. indicates that no service class token was passed.
If
MODE(RETAIN) is specified, NO_SERVCLS will preserve the existing service
class token, if any.
To code: Specify
the RS-type address, or address in register (2)-(12), of a 32 bit
field.
- ,SOURCELU=sourcelu
- ,SOURCELU=NO_SOURCELU
- An optional input parameter, which contains the LU name associated
with the requestor. This may be the fully qualified NETID.LUNAME,
i.e. network name (1-8 bytes), followed by a period, followed by the
LU name for the requestor (1-8 bytes). It may also be the 1-8 byte
local LU name, with no network qualifier. The SOURCELU field may be
from 1-17 characters. In the assembler form, the macro will determine
the length of the field as follows:
- if the field is specified by register notation, it will be assumed
to be 17 characters (padded with blanks) and a full 17 characters
will be copied.
- if the field is specified using an RS form name, then the length
will be determined using the L' assembler function. When the length
is less than 17 characters, the macro will pad with blanks. When the
length is greater than or equal to 17 characters, the macro will copy
the first 17 bytes.
In the PL/AS form, the rules for the PL/AS compiler will determine
when to pad with blanks, i.e. less than 17 characters implies padding,
17 or more implies a 17 character copy.
This is intended to be
the same value as used in IWMCLSFY, and may be distinct from the LU
name contained within the LU 6.2 token. For environments where the
LU name may be available on some, but not all flows, provision of
a data area initialized to all blanks is equivalent to specification
of NO_SOURCELU when MODE(RESET) is specified. Providing an area of
all blanks when MODE(RETAIN) is specified will cause that to be used.
The default is NO_SOURCELU. indicates that no source LU name was passed.
If
MODE(RETAIN) is specified, NO_SOURCELU will preserve the existing
source LU name, if any.
To code: Specify
the RS-type address, or address in register (2)-(12), of a character
field.
- ,TCB=tcb
- ,TCB=NO_TCB
- When DISPTYPE=TCB and MODE=RESET are specified, an optional
input parameter, which defines the TCB within the current home address
space which will serve the work request. Note that this name is not
the pointer to the TCB, but the name of the data area containing the
TCB. A typical invocation might replace xTCB with TCB.
Ordinarily
the input TCB specified should be the TCB under which the work request
(e.g. transaction program) runs and under which the delay information
is recorded (in spite of the fact that task switches may occur). The
default is NO_TCB which indicates that no TCB is currently associated
with the. monitoring environment for this work request.
To code: Specify the RS-type address, or address
in register (2)-(12), of a character field.
- ,TCB=tcb
- ,TCB=NO_TCB
- When DISPTYPE=TCB and MODE=RETAIN are specified, an optional
input parameter, which defines the TCB within the current home address
space which will serve the work request. Note that this name is not
the pointer to the TCB, but the name of the data area containing the
TCB. A typical invocation might replace xTCB with TCB.
Ordinarily
the input TCB specified should be the TCB under which the work request
(e.g. transaction program) runs and under which the delay information
is recorded (in spite of the fact that task switches may occur). The
default is NO_TCB which indicates that no TCB is currently associated
with the. monitoring environment for this work request.
To code: Specify the RS-type address, or address
in register (2)-(12), of a character field.
- ,TRXCLASS=trxclass
- ,TRXCLASS=NO_TRXCLASS
- An optional input parameter, which contains a class name within
a subsystem. For environments where the transaction class is available
on some, but not all flows, provision of a data area initialized to
all blanks is equivalent to specification of NO_TRXCLASS when MODE(RESET)
is specified. Providing an area of all blanks when MODE(RETAIN) is
specified will cause that to be used. The default is NO_TRXCLASS.
indicates that no class name was passed.
If MODE(RETAIN) is specified,
NO_TRXCLASS will preserve the existing transaction class, if any.
To code: Specify the RS-type address, or address
in register (2)-(12), of an 8-character field.
- ,TRXNAME=trxname
- ,TRXNAME=NO_TRXNAME
- An optional input parameter, which contains the transaction
name. For environments where the transaction name is available on
some, but not all flows, provision of a data area initialized to all
blanks is equivalent to specification of NO_TRXNAME when MODE(RESET)
is specified. Providing an area of all blanks when MODE(RETAIN) is
specified will cause that to be used. The default is NO_TRXNAME. indicates
that no transaction name was passed.
If MODE(RETAIN) is specified,
NO_TRXNAME will preserve the existing transaction name, if any.
To code: Specify the RS-type address, or address
in register (2)-(12), of an 8-character field.
- ,TTRACETOKEN=ttracetoken
- ,TTRACETOKEN=NO_TTRACETOKEN
- An optional input parameter, which contains the transaction
trace token. The default is NO_TTRACETOKEN. indicates that no transaction
trace token was passed.
If MODE(RETAIN) is specified, NO_TTRACETOKEN
will preserve the existing transaction trace token, if any.
To code: Specify the RS-type address, or address
in register (2)-(12), of a 32-character field.
- ,USERID=userid
- ,USERID=NO_USERID
- An optional input parameter, which contains the local userid
associated with the work request. For environments where the user
id is available on some, but not all flows, provision of a data area
initialized to all blanks is equivalent to specification of NO_USERID
when MODE(RESET) is specified. Providing an area of all blanks when
MODE(RETAIN) is specified will cause that to be used. The default
is NO_USERID. indicates that no userid was passed.
If MODE(RETAIN)
is specified, NO_USERID will preserve the existing user id, if any.
To code: Specify the RS-type address, or address
in register (2)-(12), of an 8-character field.
|