Parameters

The parameters are explained as follows:

name

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

,APPLENV=applenv

A required input parameter, which contains an application environment name. An application environment is defined in the workload manager service definition and instructs WLM how to create a server address space.

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

CONNTKN=conntkn

A required input parameter, which contains the connect token returned by the IWMCONN macro.

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

,DEPENDENT=NO

,DEPENDENT=YES

An optional parameter indicating whether the insert is for a dependent or a standard request. The default is DEPENDENT=NO.

,DEPENDENT=NO

The request is for an independent (standard) work request (default).

,DEPENDENT=YES

The insert is for a dependent work request which is required by already active server tasks to complete their processing. The request is prioritized above requests which are not marked as dependent.

,DYNAMIC=NO

,DYNAMIC=YES

An optional parameter indicating whether the insert is for a dynamic or static application environment. The default is DYNAMIC=NO.

,DYNAMIC=NO

The server manager connects to a static application environment according to the WLM service defintion. This is the default.

,DYNAMIC=YES

The server manager connects to a dynamic application environment according to a prior definition via IWMAEDEF (IWM4AEDF for 64-bit environments) service.

,ETOKEN=etoken

A required input parameter, which contains the enclave token associated with the work request. An enclave token is obtained using either the IWMECREA or IWMESQRY macro.

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

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

,PLISTVER=IMPLIED_VERSION

,PLISTVER=MAX

,PLISTVER=0

,PLISTVER=1

,PLISTVER=2

,PLISTVER=3

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, which supports all parameters except those specifically referenced in higher versions.
• 1, which supports the following parameter and those from version 0:
  SERVER_TOKEN
  
• 2, which supports the following parameter and those from version 0 and 1:
  REGION_TOKEN
  
• 3, which supports the following parameter and those from version 0, 1, and 2:
  DYNAMIC
  

To code: Specify one of the following:

• IMPLIED_VERSION
• MAX
• A decimal value of 0, 1, 2, or 3

,REGION_TOKEN=region_token

,REGION_TOKEN=0

An optional input parameter, which contains a region token returned by the IWM4CON and IWMSSEL macro. Use REGION_TOKEN to queue a work request to a specific server region. Such a work request is considered to be part of a set of work requests which all need access to the same status information which is kept in the virtual storage of the server region.

The following qualifications apply when specifying a region token:

• The application is responsible for passing the region token to the queueing manager so that it can insert the work request to the region.
• WLM has to know that temporal affinities for work requests to a specific server region exist in order not to stop the server region.The application must use the IWMTAFF macro to tell WLM when a temporal affinity starts and when it ends.

Coding REGION_TOKEN=0 is equivalent to omitting the REGION_TOKEN keyword. The default is 0.

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

,RETCODE=retcode

An optional output parameter into which the return code is to be copied from GPR 15.

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

,RSNCODE=rsncode

An optional output parameter into which the reason code is to be copied from GPR 0.

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

,SECUSER=NO

,SECUSER=YES

An optional parameter, which specifies whether the security environment of the user should be associated with the request at run time. The default is SECUSER=NO.

,SECUSER=NO

No security environment to be established.

,SECUSER=YES

Use the specified user ID to establish a security environment.

,SERVER_TOKEN=server_token

,SERVER_TOKEN=0

An optional input parameter, which contains a server token returned by the IWMSSEL macro. Use SERVER_TOKEN to queue a secondary work request to the same server task that selected a prior work request. A secondary work request is considered to be an extension of the prior work request.

The following qualifications apply when specifying a server token:

• The server task is responsible for passing the server token to the queueing manager so that it can insert a secondary work request.
• Coordination is required between the queueing manager and the server task so that the server task knows when to expect secondary work requests. The server task uses the IWMSSEM macro to select secondary work requests. It must select all secondary work requests before it can resume normal selection using IWMSSEL.
• The same application environment and enclave token passed for the original work request must be passed for each secondary work request.
• A secondary work request cannot be deleted using the IWMQDEL macro. IWMQINS does not return a work unit token (WLMWUTKN).
• The SECUSER keyword is ignored.

Coding SERVER_TOKEN=0 is equivalent to omitting the SERVER_TOKEN keyword. The default is 0.

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

,USERDATA=userdata

A required input parameter, which contains data to pass to the server address space. This user data is returned to the caller of the IWMSSEL or IWMSSEM macro. The format is undefined to MVS™.

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

,USERID=userid

When SECUSER=YES is specified, a required input parameter, which contains the requester's user ID.

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

,WLMWUTKN=wlmwutkn

An optional output parameter, which will receive the work unit token. This token can be passed to the IWMQDEL service to delete the work request.

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