Parameters
The parameters are explained as follows:
- name
- An optional symbol, starting in column 1, that is the name on
the IWM4RPT macro invocation. The name must conform to the rules for
an ordinary assembler language symbol.
- ,ARRIVALTIME=arrivaltime
- When MONTKNI=NO is specified, a required input parameter, which
contains the arrival time for the work unit in STCK format.
To code: Specify the RS-type address, or address
in register (2)-(12), of a 64 bit field.
- ,BLOCK_TIME=block_time
- ,BLOCK_TIME=NO_BLOCK_TIME
- When MONTKNI=NO is specified, an optional input parameter, which
contains the duration where the work request has been blocked. The
format of the field is STCK. A work request is blocked, when the transaction
processing is waiting on an external transaction processing or some
other event to complete. The default is NO_BLOCK_TIME. indicates that
no block time is passed.
To code: Specify
the RS-type address, or address in register (2)-(12), of an 8-character
field.
- ,CONNTKN=conntkn
- A required input parameter, which is returned by IWM4CON.
If
a monitoring token is passed (MONTKNI(YES)), AND this monitoring token
was obtained using a connect token on IWM4MCRE, then the latter connect
token is expected to be the same as that specified for IWM4RPT.
To code: Specify the RS-type address, or address
in register (2)-(12), of a 32 bit field.
- ,ENDTIME=endtime
- ,ENDTIME=CURRENT
- An optional input parameter, which specifies the ending time
for the transaction (typically, when the output is sent or available
to be sent) in STCK format. The default is CURRENT. indicates that
the current time should be used.
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_CHCORR=ewlm_chcorr
- ,EWLM_CHCORR=NO_EWLM_CHCORR
- When MONTKNI=NO is specified, an optional input parameter, which
contains the cross platform Enterprise Workload Management (EWLM)
correlator associated with the work request.
Note:
If this
correlator is not a valid ARM correlator, return code 8 and reason
code IwmRsnCodeInvalidEWLMCorr is returned to the caller (see return
code section below). If the correlator is valid, but cannot be understood
by EWLM (no EWLM format), the correlator is silently ignored and the
work request will not be reported to EWLM.
Parameter
EWLM_CHCORR and EWLM_CHCTKN are mutually exclusive.
The default
is NO_EWLM_CHCORR. indicates that no EWLM correlator is passed.
To code: Specify the RS-type address, or address
in register (2)-(12), of a character field.
- ,EWLM_CHCTKN=ewlm_chctkn
- ,EWLM_CHCTKN=NO_EWLM_CHCTKN
- When MONTKNI=NO is specified, an optional input parameter, which
contains the cross platform Enterprise Workload Management (EWLM)
correlator token associated with the work request. Parameter EWLM_CHCORR
and EWLM_CHCTKN are mutually exclusive. The default is NO_EWLM_CHCTKN.
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.
- ,EWLM_PACORR=ewlm_pacorr
- ,EWLM_PACORR=NO_EWLM_PACORR
- When EWLM_CHCORR=ewlm_chcorr and MONTKNI=NO are specified,
an optional input parameter, which contains the cross platform Enterprise
Workload Management (EWLM) parent correlator associated with the work
request. 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.
- ,EXSTARTTIME=exstarttime
- When EXSTARTTIMEP=YES and MONTKNI=NO are specified, a required
input parameter, which contains the start execution time in STCK format.
Note that this should only be used when IWM4MNTF was NOT used to pass
the execution time for this work request.
To code: Specify
the RS-type address, or address in register (2)-(12), of a 64 bit
field.
- ,EXSTARTTIMEP=NO
- ,EXSTARTTIMEP=YES
- When MONTKNI=NO is specified, a required parameter, which indicates
whether the start execution time value is passed.
- ,EXSTARTTIMEP=NO
- indicates that the start execution time value is not passed.
- ,EXSTARTTIMEP=YES
- indicates that the start execution time value is passed. Note
that this should only be used when IWM4MNTF was NOT used to pass the
execution time for this work request.
- ,MF=S
- ,MF=(L,list addr)
- ,MF=(L,list addr,attr)
- ,MF=(L,list addr,0D)
- ,MF=(E,list addr)
- ,MF=(E,list addr,COMPLETE)
- An optional input parameter that specifies the macro form.
Use
MF=S to specify the standard form of the macro, which builds an inline
parameter list and generates the macro invocation to transfer control
to the service. MF=S is the default.
Use MF=L to specify the
list form of the macro. Use the list form together with the execute
form of the macro for applications that require reentrant code. The
list form defines an area of storage that the execute form uses to
store the parameters. Only the PLISTVER parameter may be coded with
the list form of the macro.
Use MF=E to specify the execute
form of the macro. Use the execute form together with the list form
of the macro for applications that require reentrant code. The execute
form of the macro stores the parameters into the storage area defined
by the list form, and generates the macro invocation to transfer control
to the service.
- ,list addr
- The name of a storage area to contain the parameters. For MF=S
and MF=E, this can be an RS-type address or an address in register
(1)-(12).
- ,attr
- An optional 1- to 60-character input string that you use to
force boundary alignment of the parameter list. Use a value of 0F
to force the parameter list to a word boundary, or 0D to force the
parameter list to a doubleword boundary. If you do not code attr,
the system provides a value of 0D.
- ,COMPLETE
- Specifies that the system is to check for required parameters
and supply defaults for omitted optional parameters.
- ,MONTKN=montkn
- When MONTKNI=YES is specified, 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.
- ,MONTKNI=YES
- ,MONTKNI=NO
- A required parameter, which indicates whether a delay monitoring
token is provided.
- ,MONTKNI=YES
- indicates that a delay monitoring token is provided.
- ,MONTKNI=NO
- indicates that no delay monitoring token is provided.
- ,MONTKN64=montkn64
- When MONTKNI=YES is specified, 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.
- ,OK_THRESHOLD=ok_threshold
- When STATUS=NORMAL_LE_VAL is specified, a required input parameter,
which contains the threshold value at which the work request is considered
to have ended normally.
To code: Specify
the RS-type address, or address in register (2)-(12), of a fullword
field, or specify a literal decimal value.
- ,OK_THRESHOLD=ok_threshold
- When STATUS=NORMAL_GE_VAL is specified, a required input parameter,
which contains the threshold value at which the work request is considered
to have ended normally.
To code: Specify
the RS-type address, or address in register (2)-(12), of a fullword
field, or specify a literal decimal value.
- ,PLISTVER=IMPLIED_VERSION
- ,PLISTVER=MAX
- ,PLISTVER=0
- An optional input parameter that specifies the version of the
macro. PLISTVER determines which parameter list the system generates.
PLISTVER is an optional input parameter on all forms of the macro,
including the list form. When using PLISTVER, specify it on all macro
forms used for a request and with the same value on all of the macro
forms. 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 the parameter list to be
the largest size currently possible. This size might grow from release
to release and affect the amount of storage that your program needs.
If
you can tolerate the size change, IBM recommends that you always specify
PLISTVER=MAX on the list form of the macro. Specifying MAX ensures
that the list-form parameter list is always long enough to hold all
the parameters you might specify on the execute form, when both are
assembled with the same level of the system. In this way, MAX ensures
that the parameter list does not overwrite nearby storage.
- 0, if you use the currently available parameters.
To code: Specify one of the following:
- IMPLIED_VERSION
- MAX
- A decimal value of 0
- ,PSWKEY=pswkey
- When PSWKEYP=VALUE is specified, a required input parameter,
which contains the current PSW key. The low order 4 bits (bits 4-7)
contain the key value. The high order 4 bits (bits 0-3) contain zeros.
To code: Specify the RS-type address, or address
in register (2)-(12), of an 8 bit field.
- PSWKEYP=CURRENT
- PSWKEYP=VALUE
- An optional parameter, which describes how to determine the
current PSW key. The default is PSWKEYP=CURRENT.
- PSWKEYP=CURRENT
- indicates that the current PSW key should be determined.
- PSWKEYP=VALUE
-
indicates that the key is being passed explicitly via PSWKEY.
- ,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).
- ,SERVCLS=servcls
- When MONTKNI=NO is specified, a required input parameter, which
contains the service class token.
To code: Specify
the RS-type address, or address in register (2)-(12), of a 32 bit
field.
- ,STATUS=NORMAL
- ,STATUS=ABNORMAL
- ,STATUS=NORMAL_LE_VAL
- ,STATUS=NORMAL_GE_VAL
- An optional parameter, which indicates whether the portion of
the work request associated with the Report call has completed normally
or not. The default is STATUS=NORMAL.
- ,STATUS=NORMAL
- indicates that work request execution associated with the Report
call has completed normally.
- ,STATUS=ABNORMAL
- indicates that work request execution associated with the Report
call has completed abnormally.
- ,STATUS=NORMAL_LE_VAL
- indicates that work request execution associated with the Report
call has completed normally PROVIDED the work completion code is below
or at (<=) the threshold value given by OK_THRESHOLD.
- ,STATUS=NORMAL_GE_VAL
- indicates that work request execution associated with the Report
call has completed normally PROVIDED the work completion code is above
or at (>=) the threshold value given by OK_THRESHOLD.
- ,WORK_AREA=work_area
- ,WORK_AREA=NO_WORK_AREA
- When MONTKNI=NO is specified, an optional input parameter, which
is used as a work area by WLM when MONTKNI(NO) is specified and either
EWLM_CHCORR or EWLM_CHTKN is specified on the IWM4RPT invocation (in
these cases WORK_AREA is required). The work area must begin on a
doubleword boundary and must be accessible in the current PSW key
when the macro is invoced. The default is NO_WORK_AREA. indicates
that no work area is passed.
To code: Specify
the RS-type address, or address in register (2)-(12), of a 512-character
field.
- ,WORK_COMPCD=work_compcd
- ,WORK_COMPCD=NO_WORK_COMPCD
- When STATUS=NORMAL is specified, an optional input parameter,
which contains the completion/return code for the work request execution
associated with the Report call. The default is NO_WORK_COMPCD. indicates
that NO completion/return code is passed.
To code: Specify
the RS-type address, or address in register (2)-(12), of a fullword
field, or specify a literal decimal value.
- ,WORK_COMPCD=work_compcd
- ,WORK_COMPCD=NO_WORK_COMPCD
- When STATUS=ABNORMAL is specified, an optional input parameter,
which contains the completion/return code for the work request execution
associated with the Report call. The default is NO_WORK_COMPCD. indicates
that NO completion/return code is passed.
To code: Specify
the RS-type address, or address in register (2)-(12), of a fullword
field, or specify a literal decimal value.
- ,WORK_COMPCD=work_compcd
- When STATUS=NORMAL_LE_VAL is specified, a required input parameter,
which contains the completion/return code for the work request execution
associated with the Report call.
To code: Specify
the RS-type address, or address in register (2)-(12), of a fullword
field, or specify a literal decimal value.
- ,WORK_COMPCD=work_compcd
- When STATUS=NORMAL_GE_VAL is specified, a required input parameter,
which contains the completion/return code for the work request execution
associated with the Report call.
To code: Specify
the RS-type address, or address in register (2)-(12), of a fullword
field, or specify a literal decimal value.
- ,WORKREQ_STA=workreq_sta
- ,WORKREQ_STA=IWMEWLMARMSTATUSNONE
- An optional input parameter, which contains the completion status
code of the work request. Available completion status codes (defined
in macro IWMYCON) are:
* IwmEwlmArmStatusGood(0),
* IwmEwlmArmStatusAborted(1),
* IwmEwlmArmStatusFailed(2) or
* IwmEwlmArmStatusUnknown(3)
The codes above correspond to status codes in
the OpenGroup ARM 4.0 Standard (for the meaning of the status codes
see the ARM 4.0 Standard at http://www.opengroup.org/management/arm).
The default is IWMEWLMARMSTATUSNONE.
indicates that work request completion status
should be derived from the passed STATUS parameter value.
To code: Specify the RS-type address, or address
in register (2)-(12), of a fullword field, or specify a literal decimal
value.
|
z/OS MVS Programming: Workload Management Services
Copyright IBM Corporation 1990, 2014