Parameters
The parameters are explained as follows:
- name
- An optional symbol, starting in column 1, that is the name on
the IWM4MNTF macro invocation. The name must conform to the rules
for an ordinary assembler language symbol.
- ,COMPLETION=YES
- ,COMPLETION=NO
- A required parameter, which indicates whether the (or possibly
one of several) major execution phase(s) is(are) now complete.
- ,COMPLETION=YES
- indicates that execution for an entire phase of processing has
now completed. Typically IWM4MNTF Completion(Yes) would be issued
as a result of the completion of the transaction program for the work
request. When a work request is comprised of several (typically cascaded)
transaction programs, each would correspond to an invocation of IWM4MNTF
Completion(Yes).
The execution time, as given by the difference
between the IWM4MNTF ENDTIME value and the Execution start time (established
via IWM4MINI), will be added to the running total execution time for
the service class. There may still be "output" processing left to
perform for the work request, which time would be accounted for via
Iwmrpt. There may also be operations corresponding to hardening of
the database data outside the scope of Notify.
- ,COMPLETION=NO
- indicates that this invocation of Notify does not correspond
to the completion of an entire execution segment. Instead this invocation
of Notify corresponds to the portion of the work request represented
by the monitoring environment. For example, use Completion(No) when
this portion of processing behaves like a subroutine in the execution
phase, which is therefore a subset of the execution time passed in
another Notify.
The execution time, as given by the difference
between the IWM4MNTF ENDTIME value and the Execution start time (established
via IWM4MINI), will be treated separately from that passed for Completion(Yes),
since otherwise there would be double-counting.
- ,CONNTKN=conntkn
- ,CONNTKN=NO_CONNTKN
- An optional input parameter, which is returned by IWM4CON. The
default is NO_CONNTKN. indicates that no connect token is passed.
To code: Specify the RS-type address, or address
in register (2)-(12), of a 32 bit field.
- ,DISASSOCIATE=YES
- ,DISASSOCIATE=NO
- A required parameter, which indicates whether the work request
should be disassociated from the monitoring environment or not.
- ,DISASSOCIATE=YES
- indicates that the work request should be disassociated from
the monitoring environment.
- ,DISASSOCIATE=NO
- indicates that the work request should not be disassociated
from the monitoring environment.
- ,ENDTIME=endtime
- ,ENDTIME=CURRENT
- An optional input parameter, which specifies the ending execution
time for the transaction 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.
- ,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
- 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.
- ,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
- ,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).
- ,WORKREQ_STA=workreq_sta
- ,WORKREQ_STA=IWMEWLMARMSTATUSNONE
- When DISASSOCIATE=YES is specified, 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 the COMPLETION parameter value
and internal information in the Monitoring Environment will be examined
to determine the status of the work request. If COMPLETION=YES is
specified and no abnormal event was recorded for the monitoring environment
via the IWM4MABN service, the completion status IwmEwlmArmStatusGood
will be reported to EWLM. If an abnormal event was reported via IWM4MABN
or COMPLETION=NO was specified, the completion status IwmEwlmArmStatusFailed
will be reported to EWLM.
To code: Specify
the RS-type address, or address in register (2)-(12), of a fullword
field, or specify a literal decimal value.
|