Parameters

The parameters are explained as follows:

name

An optional symbol, starting in column 1, that is the name on the IWM4MSTO macro invocation. The name must conform to the rules for an ordinary assembler language symbol.

,AFTER_STRT=NO

,AFTER_STRT=YES

When EWLM_RCVD_CORR=ewlm_rcvd_corr is specified, an optional parameter, which indicates the moment the correlator has been received. The default is AFTER_STRT=NO.

,AFTER_STRT=NO

indicates that the correlator has been received before this work unit has been started by IWM4MSTR.

,AFTER_STRT=YES

indicates that the correlator has arrived within the scope of this work unit that means after issuing IWM4MSTR.

,END_FLOW=NO

,END_FLOW=YES

An optional parameter, which indicates the completion of a message flow. The default is END_FLOW=NO.

,END_FLOW=NO

indicates that a message flow has not completed.

,END_FLOW=YES

indicates that a message flow has completed. Specify END_FLOW=YES, if you know that the running work unit is the last one in a work unit flow. This indication can not be cleared, if it has been set.

,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_RCVD_CORR=ewlm_rcvd_corr

,EWLM_RCVD_CORR=NO_EWLM_RCVD_CORR

An optional input parameter, which contains a cross platform Enterprise Workload Management (EWLM) correlator received from another application. Workflows often have multiple parent work units that must complete before a new work unit can be initiated. You can pass only 1 parent correlator to the IWM4MSTR macro and one additional parent correlator to the IWM4MSTO macro. You have to issue the IWM4MUPD macro, if more than two parent correlators should be assigned to a work unit.
This correlator is ignored, if it is an unknown EWLM correlator. The default is NO_EWLM_RCVD_CORR. indicates that parameter EWLM_RCVD_CORR has not been specified.

To code: Specify the RS-type address, or address in register (2)-(12), of a character field.

,MESSAGES_SENT=messages_sent

,MESSAGES_SENT=NO_MESSAGES_SENT

An optional input parameter, which contains the number of messages sent to other applications. This value is added to the total messages_sent value of the work unit. The total messages_sent value should not exceed 32767. The default is NO_MESSAGES_SENT. indicates that parameter MESSAGES_SEND has not been specified.

To code: Specify the RS-type address, or address in register (2)-(12), of a fullword field, or specify a literal decimal value.

,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).

,STATUS=status

,STATUS=IWMEWLMARMSTATUSGOOD

An optional input parameter, which contains the completion status code of the work unit. 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 IWMEWLMARMSTATUSGOOD.
indicates that the work unit completed successfully.

To code: Specify the RS-type address, or address in register (2)-(12), of a fullword field, or specify a literal decimal value.