Parameters
The parameters are explained as follows:
- name
- An optional symbol, starting in column 1, that is the name on
the IWMCLSFY macro invocation. The name must conform to the rules
for an ordinary assembler language symbol.
- ,ACCTINFL=acctinfl
- 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, or specify a literal decimal value.
- ,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.
indicates that no accounting information was passed.
To
code: Specify the RS-type address, or address in register
(2)-(12), of a character field.
- ,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, provision
of a data area initialized to all blanks is equivalent to specification
of NO_COLLECTION The default is NO_COLLECTION. 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_LEN=collection_len
- When COLLECTION=collection is specified, a required
input parameter, which contains the length of the collection name.
There is no restriction on the length of data passed, but all storage
between the start and end must be allocated (getmained).
To code: Specify the RS-type address, or address
in register (2)-(12), of a fullword field, or specify 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, provision of a data area
initialized to all blanks is equivalent to specification of NO_CONNECTION
The default is NO_CONNECTION. 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 IWMCONN for
use by the classify routine.
To code: Specify
the RS-type address, or address in register (2)-(12), of a 32 bit
field.
- ,CORR_LEN=corr_len
- When CORRELATION=correlation is specified, a required
input parameter, which contains the length of the correlation identifier.
There is no restriction on the length of data passed, but all storage
between the start and end must be allocated (getmained).
To code: Specify the RS-type address, or address
in register (2)-(12), of a fullword field, or specify a literal decimal
value.
- ,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, provision of a data
area initialized to all blanks is equivalent to specification of NO_CORRELATION
The default is NO_CORRELATION. indicates that no CORRELATION name
is passed.
To code: Specify the RS-type
address, or address in register (2)-(12), of a character 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. Specification of this parameter
indicates that a sub work request will be created.
Notes:
- Currently (z/OS V1R6) only uses the first 64 Bytes of the EWLM_CHCORR
field.
- Parameters EWLM_OUTCORR, EWLM_CHCORR and EWLM_CHCTKN are all 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. Specification of this parameter
indicates that a sub work request will be created. A EWLM child correlator
token must not be passed outside of the EWLM Management Domain.
Parameters
EWLM_OUTCORR, EWLM_CHCORR and EWLM_CHCTKN are all 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 internally
used by WLM and must not be used by application programs. The default
is NO_EWLM_CLTOKEN. 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.
Moreover the EWLM correlator serves as the input
correlator for the EWLM_CHCORR, EWLM_CHTKN, EWLM_OUTCORR parameters.
Note,
that the architected length field of an ARM correlator in the first
two bytes must contain a value between 4 ('0004'X) and 512 ('0200'X).
For
environments where the EWLM correlator may be available on some, but
not all flows, provision of a data area with the first four bytes
set to binary zeroes is equivalent to the specification of NO_EWLM_CORR.
The
default is NO_EWLM_CORR. 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_OUTCORR=ewlm_outcorr
- An optional output parameter, which will receive a validated
EWLM correlator on return. The execution form of IWMCLSFY will validate
the passed correlator in EWLM_CORR and provide a valid EWLM correlator
in EWLM_OUTCORR as follows:
- If the EWLM_CORR parameter is specified and the 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:
- The specification of EWLM_OUTCORR (unlike EWLM_CHCORR or EWLM_CHCTKN)
does not indicate the beginning of an sub work request.
- Currently (z/OS V1R6) only uses the first 64 Bytes of the EWLM_OUTCORR
field.
- The application may specify the same parameter for both EWLM_CORR
and EWLM_OUTCORR, which means that the EWLM correlator can be validated/replaced
in place.
- Parameters EWLM_OUTCORR, EWLM_CHCORR and EWLM_CHCTKN are all 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, provision of a data
area initialized to all blanks is equivalent to specification of NO_LUNAME.
SOURCELU
is mutually exclusive with LUNAME. The default is NO_LUNAME. 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 IWMCLSFY in the following
order:
- Use IWMCLSFY ...MF=(M,list-addr,COMPLETE) specifying appropriate
parameters, including all required ones.
- Use IWMCLSFY ...MF=(M,list-addr,NOCHECK), specifying the parameters
that you want to change.
- Use IWMCLSFY ...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, provision
of a data area initialized to all blanks is equivalent to specification
of NO_NETID.
SOURCELU is mutually exclusive with NETID. The default
is NO_NETID. 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, e.g. 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,
provision of a data area initialized to all blanks is equivalent to
specification of NO_PACKAGE The default is NO_PACKAGE. 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.
- ,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, provision of a data area initialized to
all blanks is equivalent to specification of NO_PERFORM. The default
is NO_PERFORM. 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, provision
of a data area initialized to all blanks is equivalent to specification
of NO_PLAN The default is NO_PLAN. 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
- ,PLISTVER=1
- ,PLISTVER=2
- ,PLISTVER=3
- ,PLISTVER=4
- ,PLISTVER=5
- ,PLISTVER=6
- ,PLISTVER=7
- ,PLISTVER=8
- 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 both the following parameters
and those from version 0:
| | |
---|
PERFORM
|
PRCNAME
|
PRCNAME_LEN
|
- 2, which supports both the following parameters
and those from version 0 and 1:
- 3, which supports both the following parameters
and those from version 0,1 and 2:
| | |
---|
PROCESSNAME
|
PROCESSNM_LEN
|
|
- 4, which supports both the following parameters
and those from version 0,1,2 and 3:
- 5, which supports both the following parameters
and those from version 0,1,2,3 and 4:
| | |
---|
SCHEDENV
|
SRMTOKEN
|
|
SCHEDENV_LEN
|
SUBCOLN
|
|
- 6, which supports both the following parameters
and those from version 0,1,2,3,4 and 5:
- 7, which supports both the following parameters
and those from version 0,1,2,3,4,5 and 6:
| | |
---|
EWLM_CHCORR
|
EWLM_CHCTKN
|
EWLM_OUTCORR
|
- 8, which supports both the following parameters
and those from version 0,1,2,3,4,5,6 and 7:
To code: Specify one of the following:
- IMPLIED_VERSION
- MAX
- A decimal value of 0, 1, 2, 3, 4, 5, 6, 7, or 8
- ,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, provision of a data area initialized to all blanks is equivalent
to specification of NO_PRCNAME. The default is NO_PRCNAME. 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_LEN=prcname_len
- When PRCNAME=prcname is specified, a required input
parameter, which contains the length of the procedure name. There
is no restriction on the length of data passed, but all storage between
the start and end must be allocated (getmained).
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, provision of a data area
initialized to hexadecimal 80000000 (the largest negative integer)
is equivalent to specification of NO_PRIORITY. The default is NO_PRIORITY.
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. 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_LEN=processnm_len
- When PROCESSNAME=processname is specified, a required
input parameter, which contains the length of the process name. There
is no restriction on the length of data passed, but all storage between
the start and end must be allocated (getmained).
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 (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).
- ,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 (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).
- ,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.
indicates that no scheduling environment value is passed.
To code: Specify the RS-type address, or address
in register (2)-(12), of a 16-character field.
- ,SCHEDENV_LEN=schedenv_len
- ,SCHEDENV_LEN=16
- When SCHEDENV=schedenv is specified, an optional input
parameter, which contains the length of the scheduling environment.
There is no restriction on the length of data passed, but all storage
between the start and end must be allocated (getmained). The default
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,
e.g. 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. The SOURCELU field may be
from 1-17 characters. In the assembler form, the macro will determine
the length of the field as follows:
- if the field is specified by register notation, it will be assumed
to be 17 characters (padded with blanks).
- if the field is specified using an RS form name, then the length
will be determined using the L' assembler function.
In the PL/AS form, the rules for the PL/AS compiler will determine
the length. The product using IWMCLSFY is responsible for documenting
which form is used so that the customer may specify the correct format.
For
environments where the LU name may be available on some, but not all
flows, provision of a data area initialized to all blanks is equivalent
to specification of NO_SOURCELU.
SOURCELU is mutually exclusive
with NETID/LUNAME. The default is NO_SOURCELU. 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.
- ,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.
- ,SSPMLEN=sspmlen
- When SUBSYSPM=subsyspm is specified, a required input
parameter, which contains the length of the data passed by the work
manager. There is no restriction on the length of data passed, but
all storage between the start and end must be allocated (getmained).
To code: Specify the RS-type address, or address
in register (2)-(12), of a fullword field, or specify a literal decimal
value.
- ,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.
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, provision of a data area initialized
to all blanks is equivalent to specification of NO_SUBSYSPM. The default
is NO_SUBSYSPM. 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, provision of a data area initialized to
all blanks is equivalent to specification of NO_TRXCLASS. The default
is NO_TRXCLASS. 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,
provision of a data area initialized to all blanks is equivalent to
specification of NO_TRXNAME. The default is NO_TRXNAME. 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 userid associated
with the work request. For environments where the user id is available
on some, but not all flows, provision of a data area initialized to
all blanks is equivalent to specification of NO_USERID. The default
is NO_USERID. indicates that no userid is passed.
To
code: Specify the RS-type address, or address in register
(2)-(12), of an 8-character field.
|