Parameters

The parameters are explained as follows:

name

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

,ACCTINFO=acctinfo

,ACCTINFO=NO_ACCTINFO

An optional input parameter, which contains the accounting information. For environments where accounting information is available on some, but not all flows, provision of a data area initialized to all blanks is equivalent to specification of NO_ACCTINFO. The default is NO_ACCTINFO, which indicates that no accounting information was passed.

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

,ACCTINFO_L=acctinfo_l

When ACCTINFO=acctinfo is specified, a required input parameter, which contains the length of the accounting information field. The maximum value supported is 143.

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

,CLIENTACCT=clientacct

,CLIENTACCT=NO_CLIENTACCT

An optional input parameter, which contains the accounting information. For environments where accounting information is available on some, but not all flows, providing a data area initialized to all blanks is equivalent to specifying NO_CLIENTACCT. The default is NO_CLIENTACCT, which indicates that no accounting information was passed.

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

,CLIENTACCT_L=clientacct_l

When CLIENTACCT=clientacct is specified, a required input parameter, which contains the length of the client accounting information field. The maximum value supported is 512.

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

,CLIENTIPADDR=clientipaddr

,CLIENTIPADDR=NO_CLIENTIPADDR

An optional input parameter, which contains the source client IPv6 address, which is left-justified and represented as a colon hexadecimal address. An example of an IPv6 address is: X'2001:0DB8:0000:0000:0008:0800:200C:417A'

The compressed format is not supported for classifications. For environments where the source client IPV6 address may be available on some, but not all flows, providing a data area initialized to all blanks is equivalent to specifying NO_CLIENTIPADDR .

SOURCELU, CLIENTIPADDR and NETID/LUNAME are mutually exclusive. The default is NO_CLIENTIPADDR, which indicates that no CLIENTIPADDR name is passed.

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

,CLIENTTRXNM=clienttrxnm

,CLIENTTRXNM=NO_CLIENTTRXNM

An optional input parameter, which contains the client transaction name for the work request, as known by the work manager. For environments where the transaction name is available on some, but not all flows, providing a data area initialized to all blanks is equivalent to specifying NO_CLIENTTRXNM. The default is NO_CLIENTTRXNM, which indicates that no client transaction name is passed.

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

,CLIENTTRXNM_L=clienttrxnm_l

When CLIENTTRXNM=clienttrxnm is specified, a required input parameter, which contains the length of the client transaction name field. The maximum value supported is 255.

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

,CLIENTUSERID=clientuserid

,CLIENTUSERID=NO_CLIENTUSERID

An optional input parameter, which contains the value of the client user ID which may be different than USERID and provided from the client information that is specified for the connection. For environments where the client user ID name may be available on some, but not all flows, providing a data area initialized to all blanks is equivalent to specifying NO_CLIENTUSERID. The default is NO_CLIENTUSERID, which indicates that no CLIENTUSERID name is passed.

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

,CLIENTUSERID_L=clientuserid_l

When CLIENTUSERID=clientuserid is specified, a required input parameter, which contains the length of the client user ID name field. The maximum value supported is 128.

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

,CLIENTWKSTNM=clientwkstnm

,CLIENTWKSTNM=NO_CLIENTWKSTNM

An optional input parameter, which contains the value of the client workstation name or host name from the client information that is specified for the connection. For environments where the client workstation name may be available on some, but not all flows, providing a data area initialized to all blanks is equivalent to specifying NO_CLIENTWKSTNM. The default is NO_CLIENTWKSTNM, which indicates that no CLIENTWKSTNM name is passed.

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

,CLIENTWKSTNM_L=clientwkstnm_l

When CLIENTWKSTNM=clientwkstnm is specified, a required input parameter, which contains the length of the client workstation name field. The maximum value supported is 255.

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

,COLLECTION=collection

,COLLECTION=NO_COLLECTION

An optional input parameter, which contains the customer defined name for a group of associated packages. For environments where the collection name may be available on some, but not all flows, providing a data area initialized to all blanks is equivalent to specifying NO_COLLECTION. The default is NO_COLLECTION, which indicates that no COLLECTION name is passed.

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

,COLLECTION_L=collection_l

When COLLECTION=collection is specified, a required input parameter, which contains the length of the collection name. The maximum value supported is 18.

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

,CONNECTION=connection

,CONNECTION=NO_CONNECTION

An optional input parameter, which contains the name associated with the environment creating the work request, which may reside anywhere within the network. For environments where the connection name may be available on some, but not all flows, providing a data area initialized to all blanks is equivalent to specifying NO_CONNECTION . The default is NO_CONNECTION, which indicates that no CONNECTION name 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 for use by the classify routine.

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

,CORRELATION=correlation

,CORRELATION=NO_CORRELATION

An optional input parameter, which contains the name associated with the user/program creating the work request, which may reside anywhere within the network. For environments where the correlation name may be available on some, but not all flows, providing a data area initialized to all blanks is equivalent to specifying NO_CORRELATION. The default is NO_CORRELATION, which indicates that no CORRELATION name is passed.

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

,CORRELATION_L=correlation_l

When CORRELATION=correlation is specified, a required input parameter, which contains the length of the correlation identifier. The maximum value supported is 12.

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

,EWLM_CHCORR=ewlm_chcorr

An optional output parameter, which contains the cross-platform Enterprise Workload Management (EWLM) child correlator associated with the instantiated sub work request. Specifying this parameter indicates that a sub work request will be created.

Notes:

1. Currently z/OS® V2R1 only uses the first 64 bytes of the EWLM_CHCORR field.
2. The EWLM_OUTCORR, EWLM_CHCORR and EWLM_CHCTKN parameters are mutually exclusive.

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

,EWLM_CHCTKN=ewlm_chctkn

An optional output parameter, which contains the cross-platform Enterprise Workload Management (EWLM) child correlator token associated with the instantiated sub work request. Specifying this parameter indicates that a sub work request will be created. An EWLM child correlator token must not be passed outside of the EWLM management domain.

The EWLM_OUTCORR, EWLM_CHCORR and EWLM_CHCTKN parameters are mutually exclusive.

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

,EWLM_CLTOKEN=ewlm_cltoken

,EWLM_CLTOKEN=NO_EWLM_CLTOKEN

An optional input parameter, which contains internal EWLM classification information to be passed from EWLM to WLM. This parameter is used internally by WLM and must not be used by application programs. The default is NO_EWLM_CLTOKEN, which indicates that no EWLM classification information was passed.

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

,EWLM_CORR=ewlm_corr

,EWLM_CORR=NO_EWLM_CORR

An optional input parameter, which contains the cross-platform Enterprise Workload Management (EWLM) correlator associated with the work request. If this parameter is specified and a valid EWLM correlator is passed, the EWLM transaction class can be used for WLM classification purposes. The default is NO_EWLM_CORR which indicates that no EWLM correlator is passed.

The EWLM correlator also serves as the input correlator for the EWLM_CHCORR, EWLM_CHTKN, EWLM_OUTCORR parameters.

Notes:

1. The architected length field of an ARM correlator in the first two bytes must contain a value between 4 (X'0004') and 512 (X'0200').
2. For environments where the EWLM correlator may be available on some, but not all flows, providing a data area with the first four bytes set to binary zeroes is equivalent to specifying NO_EWLM_CORR.
3. The EWLM_OUTCORR, EWLM_CHCORR and EWLM_CHCTKN parameters are mutually exclusive.

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

,EWLM_OUTCORR=ewlm_outcorr

An optional output parameter which receives a validated EWLM correlator on return. The execution form of IWM4CLSY validates the passed correlator in EWLM_CORR and provides a valid EWLM correlator in EWLM_OUTCORR as follows:

• If the EWLM_CORR parameter is specified and the correlator in EWLM_CORR is a valid ARM correlator in EWLM format, it will be copied to EWLM_OUTCORR.
• If the correlator in EWLM_CORR is not a valid EWLM ARM correlator or the EWLM_CORR parameter is omitted, a new classify correlator will be returned within the EWLM_OUTCORR field.

Notes:

1. Specifying EWLM_OUTCORR (unlike EWLM_CHCORR or EWLM_CHCTKN) does not indicate the beginning of a sub work request.
2. Currently z/OS V2R1 only uses the first 64 bytes of the EWLM_OUTCORR field.
3. The application may specify the same parameter for both EWLM_CORR and EWLM_OUTCORR, which means that the EWLM correlator can be validated or replaced in place.
4. The EWLM_OUTCORR, EWLM_CHCORR and EWLM_CHCTKN parameters are mutually exclusive.

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

,LUNAME=luname

,LUNAME=NO_LUNAME

An optional input parameter, which contains the local LU name associated with the requestor. For environments where the local LU name may be available on some, but not all flows, providing a data area initialized to all blanks is equivalent to specifying NO_LUNAME.

SOURCELU, CLIENTIPADDR and LUNAME are mutually exclusive. The default is NO_LUNAME, which indicates that no local LU name is passed.

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)

,MF=(E,list addr,NOCHECK)

,MF=(M,list addr)

,MF=(M,list addr,COMPLETE)

,MF=(M,list addr,NOCHECK)

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.

Use MF=M together with the list and execute forms of the macro for service routines that need to provide different options according to user-provided input. Use the list form to define a storage area; use the modify form to set the appropriate options; then use the execute form to call the service.

IBM® recommends that you use the modify and execute forms of IWM4CLSY in the following order:

• Use IWM4CLSY ...MF=(M,list-addr,COMPLETE) specifying appropriate parameters, including all required ones.
• Use IWM4CLSY ...MF=(M,list-addr,NOCHECK), specifying the parameters that you want to change.
• Use IWM4CLSY ...MF=(E,list-addr,NOCHECK), to execute the macro.

,list addr

The name of a storage area to contain the parameters. For MF=S, MF=E, and MF=M, 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.

,NOCHECK

Specifies that the system is not to check for required parameters and is not to supply defaults for omitted optional parameters.

,NETID=netid

,NETID=NO_NETID

An optional input parameter, which contains the network identifier associated with the requestor. For environments where the network identifier may be available on some, but not all flows, providing a data area initialized to all blanks is equivalent to specifying NO_NETID.

SOURCELU, CLIENTIPADDR and NETID are mutually exclusive with NETID. The default is NO_NETID, which indicates that no network identifier is passed.

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

,PACKAGE=package

,PACKAGE=NO_PACKAGE

An optional input parameter, which contains the package name for a set of associated SQL statements. Products using this attribute must chose a specific package name to be associated with the work request, for example, the first package name used in the unit of work. Individual product documentation will describe how this choice is made to allow the installation to use the WLM administrative application. For environments where the package name may be available on some, but not all flows, providing a data area initialized to all blanks is equivalent to specifying NO_PACKAGE The default is NO_PACKAGE, which indicates that no PACKAGE name is passed.

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

,PACKAGE_L=package_l

When PACKAGE=package is specified, a required input parameter, which contains the length of the package information field. The maximum value supported is 128.

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

,PERFORM=perform

,PERFORM=NO_PERFORM

An optional input parameter, which contains the performance group number (PGN) associated with the work request. If specified, the performance group number value must be within the range of 1-999, represented as character data, left-justified and padded with blanks on the right. For environments where the perform value may be available on some, but not all flows, providing a data area initialized to all blanks is equivalent to specifying NO_PERFORM. The default is NO_PERFORM, which indicates that no PERFORM value is passed.

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

,PLAN=plan

,PLAN=NO_PLAN

An optional input parameter, which contains the access plan name for a set of associated SQL statements. For environments where the plan name may be available on some, but not all flows, providing a data area initialized to all blanks is equivalent to specifying NO_PLAN. The default is NO_PLAN, which indicates that no PLAN name is passed.

To code: Specify the RS-type address, or address in register (2)-(12), of an 8-character 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; 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

,PRCNAME=prcname

,PRCNAME=NO_PRCNAME

An optional input parameter, which contains the DB2® Stored SQL Procedure name associated with the work request. For environments where the SQL procedure name may be available on some, but not all flows, providing a data area initialized to all blanks is equivalent to specifying NO_PRCNAME. The default is NO_PRCNAME, which indicates that no PRCNAME value is passed.

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

,PRCNAME_L=prcname_l

When PRCNAME=prcname is specified, a required input parameter, which contains the length of the procedure name. The maximum value supported is 128.

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

,PRIORITY=priority

,PRIORITY=NO_PRIORITY

An optional input parameter, which contains the priority associated with the work request. For environments where the priority value may be available on some, but not all flows, providing a data area initialized to X'80000000' (the largest negative integer) is equivalent to specifying NO_PRIORITY. The default is NO_PRIORITY, which indicates that no PRIORITY value 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.

,PROCESSNAME=processname

,PROCESSNAME=NOPROCESSNAME

An optional input parameter, which contains the process name associated with the work request. The default is NOPROCESSNAME, which indicates that no PROCESSNAME value is passed.

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

,PROCESSNM_L=processnm_l

When PROCESSNAME=processname is specified, a required input parameter, which contains the length of the process name. The maximum value supported is 32.

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

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

,RPTCLSNM=rptclsnm

An optional output parameter, which is to receive the output report class name.

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

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

,SCHEDENV=schedenv

,SCHEDENV=NO_SCHEDENV

An optional input parameter, which contains the scheduling environment value associated with the work request. The default is NO_SCHEDENV, which indicates that no scheduling environment value is passed.

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

,SCHEDENV_L=schedenv_l

When SCHEDENV=schedenv is specified, an optional input parameter, which contains the length of the scheduling environment. The maximum value supported is 16.

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

,SERVCLS=servcls

A required output parameter, which is to receive the output token which represents the service and report class for the work request.

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

For environments where the LU name may be available on some, but not all flows, providing a data area initialized to all blanks is equivalent to specifying NO_SOURCELU.

SOURCELU, CLIENTIPADDR and NETID/LUNAME are mutually exclusive. The default is NO_SOURCELU, which indicates that no source LU name was passed.

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

,SOURCELU_L=sourcelu_l

When SOURCELU=sourcelu is specified, a required input parameter, which contains the length of the source LU name field. The maximum value supported is 17.

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

,SRMTOKEN=srmtoken

An optional output parameter, token for SRM internal use only.

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

,SRVCLSNM=srvclsnm

An optional output parameter, which is to receive the output service class name.

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

,SUBCOLN=subcoln

,SUBCOLN=NO_SUBCOLN

An optional input parameter, which contains the subsystem collection name associated with the work request. The default is NO_SUBCOLN, which indicates that no subsystem collection name is passed.

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

,SUBSYSPM=subsyspm

,SUBSYSPM=NO_SUBSYSPM

An optional input parameter, which contains character data related to the work request which is passed by the work manager for use in classification. The nature of the contents of this data must be documented for customer use. For environments where the subsystem parameter is available on some, but not all flows, providing a data area initialized to all blanks is equivalent to specifying NO_SUBSYSPM. The default is NO_SUBSYSPM, which indicates that no parameter was passed.

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 the subsystem. This can be any meaningful value that the installation can recognize and specify to match the value presented by the work manager. For environments where the transaction class is available on some, but not all flows, providing a data area initialized to all blanks is equivalent to specifying NO_TRXCLASS. The default is NO_TRXCLASS, which indicates that no transaction class was passed.

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 the work request, as known by the work manager. For environments where the transaction name is available on some, but not all flows, providing a data area initialized to all blanks is equivalent to specifying NO_TRXNAME. The default is NO_TRXNAME, which indicates that no transaction name is passed.

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

,TTRACETOKEN=ttracetoken

An optional output parameter, which is to receive the output transaction trace token associated with the work request.

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 user ID associated with the work request. For environments where the user ID is available on some, but not all flows, providing a data area initialized to all blanks is equivalent to specifying NO_USERID. The default is NO_USERID, which indicates that no user ID is passed.

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