Parameters
The parameters are explained as follows:
- name
- An optional symbol, starting in column 1, that is the name on
the IWMCONN macro invocation. The name must conform to the rules for
an ordinary assembler language symbol.
- ,APPLENV=applenv
- When SERVER_MANAGER=YES is specified, a required input parameter,
which contains the application environment under which work requests
are served.
To code: Specify the RS-type
address, or address in register (2)-(12), of a 32-character field.
- ,CONNTKN=conntkn
- A required output parameter, which will receive the connect
token.
To code: Specify the RS-type address,
or address in register (2)-(12), of a 32 bit field.
- ,CONNTKNKEY=conntknkey
- When CONNTKNKEYP=VALUE and WORK_MANAGER=YES are specified, a
required input parameter, which contains the key for which the various
branch entry services using the CONNTKN returned by IWMCONN must have
PSW update authority. These other services include Classify (IWMCLSFY),
Report (IWMRPT), Notify (IWMMNTFY). Create (IWMMCREA) is a PC interface
and hence is excluded. The low order 4 bits (bits 4-7) contain the
key value. The high-order 4 bits (bits 0-3) must be zeros.
Note
however that there are other services that use the connect token,
for which the CONNTKNKEY does not relate to PSW update authority but
instead must be a system key (0-7) rather than a user key (8-15).
To code: Specify the RS-type address, or address
in register (2)-(12), of an 8 bit field.
- ,CONNTKNKEYP=VALUE
- ,CONNTKNKEYP=PSWKEY
- When WORK_MANAGER=YES is specified, a required parameter, which
describes how the input key should be obtained.
- ,CONNTKNKEYP=VALUE
- indicates that the key is being passed explicitly via CONNTKNKEY.
- ,CONNTKNKEYP=PSWKEY
- indicates that the current PSW key should be used.
- ,DYNAMIC=NO
- ,DYNAMIC=YES
- When SERVER_MANAGER=YES is specified, an optional parameter
indicating whether the server manager connects to a dynamic or static
application environment. The default is DYNAMIC=NO.
- ,DYNAMIC=NO
- The server manager connects to a static application environment.
This is the default.
- ,DYNAMIC=YES
- The server manager connects to a dynamic application environment.
- ,EWLM=NO
- ,EWLM=YES
- When WORK_MANAGER=YES is specified, an optional parameter, which
indicates if this work manager intends 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. This is the default.
- ,EWLM=YES
- The work manager participates in cross-platform enterprise workload
management and interacts with EWLM.
- ,EXPTIMPT=NO
- ,EXPTIMPT=YES
- An optional parameter indicating whether the space needs access
to the export and import services (IWMEXPT, IWMUEXPT, IWMIMPT, IWMUIMPT).
The default is EXPTIMPT=NO.
- ,EXPTIMPT=NO
- The connecting address space will not use the export and import
services.
- ,EXPTIMPT=YES
- The connecting address space will use the export and import
services.
- ,GROUPNM=groupnm
- ,GROUPNM=NO_GROUPNM
- An optional input parameter, which contains the name of an application
group, for example, a group of similar or cooperating subsystem instances.
A group name can be up to 255 characters long. Provision of a data
area initialized to all blanks is equivalent to specification of NO_GROUPNM.
The default is NO_GROUPNM. This indicates that no group name is passed.
To code: Specify the RS-type address, or address
in register (2)-(12), of a character field.
- ,GROUPNM_LEN=groupnm_len
- When GROUPNM=groupnm is specified, a required input
parameter, which contains the length of the group name. A group name
can be up to 255 characters long.
To code: Specify
the RS-type address, or address in register (2)-(12), of a fullword
field.
- ,MANAGE_TASKS=NO
- ,MANAGE_TASKS=YES
- When SERVER_TYPE=QUEUE and SERVER_MANAGER=YES are specified,
an optional parameter indicating that WLM will manage the server instances
(tasks), selecting work from a work queue.
If YES is
specified the caller must use service IWMSINF to obtain the number
of server instances to start from WLM.
The meaning of PARALLEL_EU
changes in this case. PARALLEL_EU is only used to determine the number
of tasks to start if the application environment cannot be managed
by WLM. Otherwise PARALLEL_EU can be used to limit the number of server
tasks to start initially.
The server can define the SERVER_LIMIT
parameter to specify a limit for the number of server tasks supported
by the application.
- ,MANAGE_TASKS=NO
- The connecting address space starts the number of server instances
as provided with PARALLEL_EU.
- ,MANAGE_TASKS=YES
- The connecting address space uses IWMSINF to obtain the number
of server instances to start from WLM.
- ,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 X'0F' to
force the parameter list to a word boundary, or X'0D' to
force the parameter list to a doubleword boundary. If you do not code attr,
the system provides a value of X'0D'.
- ,COMPLETE
- Specifies that the system is to check for required parameters
and supply defaults for omitted optional parameters.
- ,NODENM=nodenm
- ,NODENM=NO_NODENM
- An optional input parameter, which contains the node name to
be used for classifying work requests when Work_Manager=Yes is specified
or taken as default. The node name identifies a specific subcomponent
of the generic subsystem type.
When Server_Manager=Yes and Server_Type=Queue
is specified, the node name should match the node name specified on
the corresponding Connect for the Queue_Manager, for example, all
servers associated with the Queue_Manager have identical node names.
If
a product chooses to use both Work_Manager=Yes and Server_Manager=Yes
on a single invocation of IWMCONN for a space, then the rules for
Server_Manager apply, for example, the node name refers to the node
name of the space playing the role of Queue_Manager.
If the
caller connects to the WLM work queueing services, the combination
of the subsystem type, node name and the subsystem name must be unique
to that MVS™ system. Node name
can be omitted. The default is NO_NODENM.
To
code: Specify the RS-type address, or address in register (2)-(12),
of an 8-character field.
- ,NUMBERASCB=numberascb
- When TOPOLOGY=topology and WORK_MANAGER=YES are specified,
a required input parameter, which contains the number of ASCBs in
the list passed via xTOPOLOGY. While there is no restriction on the
number of entries in the list, the current support will only look
at the first 10 entries. The number specified must be positive (hence
also non-zero).
To code: Specify the RS-type
address, or address in register (2)-(12), of a fullword field.
- ,PARALLEL_EU=parallel_eu
- When SERVER_MANAGER=YES is specified, a required input parameter,
which contains the maximum number of tasks (TCBs) within the address
space which will be used to concurrently process distinct work requests if MANAGE_TASKS=YES is not in effect. When Select (IWMSSEL)
is used to obtain a work request, which might then be passed to another
task (TCB) for processing under a Begin (IWMSTBGN) environment, this
count represents the number of tasks (TCBs) which can be running concurrently
against these work requests, i.e. the number of concurrent Begin environments.
It is important that this count represent the actual number of tasks
(TCBs) which can be utilized, and not merely some approximate upper
bound, as this value will influence system algorithms.
If MANAGE_TASKS=YES
is in effect, the application environment managed by WLM PARALLEL_EU
is not used. In this case the parameter is only used as described
above if no procedure name was defined for the application environment.
To code: Specify the RS-type address, or address
in register (2)-(12), of a fullword field.
- ,PLISTVER=IMPLIED_VERSION
- ,PLISTVER=MAX
- ,PLISTVER=0
- ,PLISTVER=1,PLISTVER=2
- ,PLISTVER=3
- ,PLISTVER=4
- 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 parameters
and those from version 0:
| | |
---|
APPLENV | QUEUE_MANAGER | SERVER_TYPE | EXPTIMPT | ROUTER | SRV_MGR_EXIT@ | PARALLEL_EU | SERVER_DATA | WORK_MANAGER | QMGR_EXIT@ | SERVER_MANAGER | |
- 2, which supports the following parameters
and those from version 0 and 1:
| | |
---|
MANAGE_TASKS | SERVER_LIMIT | GROUPNM_LEN |
- 3, which supports the following
parameters and those from version 0, 1, and 2:
- 4, which supports the following
parameters and those from version 0, 1, 2, and 3:
To code: Specify one of the following:
- IMPLIED_VERSION
- MAX
- A decimal value of 0, 1, 2, 3, or 4
- ,QMGR_EXIT@=qmgr_exit@
- ,QMGR_EXIT@=NO_QMGR_EXIT@
- When QUEUE_MANAGER=YES and ROUTER=NO are specified, an optional
input parameter that contains the address of the Queue Manager Connect
Exit to be invoked when the system wishes to inform the queue manager
of actions it should perform. The exit will be called in enabled,
unlocked TCB mode with no FRRs set, but may be called in a cross-memory
environment. The mapping of the parameter list for the exit and its
invocation environment is given by the list form of the IWMQCXIT macro.
The
system may chose to discontinue calling the exit upon repetitive abnormal
completions, i.e. where the system recovery routine is percolated
to from an error within the exit. The exit must be callable from any
address space and remain available after the queue manager disconnects
or terminates. The default is NO_QMGR_EXIT@, which indicates that
no queue manager exit is provided.
To code: Specify
the RS-type address, or address in register (2)-(12), of a pointer
field.
- ,QUEUE_MANAGER=NO
- ,QUEUE_MANAGER=YES
- When ROUTER=NO is specified, an optional parameter indicating
that WLM Work Queuing services be available to the connecting address
space. For example:
- Insert (IWMQINS)
- Delete (IWMQDEL)
If YES is specified, the combination of the subsystem type
and the subsystem name must be unique to that MVS system. The default is QUEUE_MANAGER=NO.
- ,QUEUE_MANAGER=NO
- The connecting address space will not use the WLM Work Queuing
services.
- ,QUEUE_MANAGER=YES
- The connecting address space will be using the WLM Work Queuing
services.
- ,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).
- ,ROUTER=NO
- ,ROUTER=YES
- An optional parameter, which describes whether recommendations
for sysplex routing to servers associated with the same subsystem
type and name are requested. The default is ROUTER=NO.
- ,ROUTER=NO
- indicates that recommendations for sysplex routing via IWMSRFSV
are not required.
- ,ROUTER=YES
- indicates that recommendations for sysplex routing via IWMSRFSV
is required. Note that only server spaces which have the same Subsystem
type and name AND which specified Server_Type=Routing are considered
when IWMSRFSV is invoked.
If YES is specified, the combination
of the subsystem type and the subsystem name must be unique to that MVS system.
- ,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).
- ,SERVER_DATA=server_data
- When SERVER_TYPE=ROUTING and SERVER_MANAGER=YES are specified,
a required input parameter, which contains whatever data is needed
to uniquely identify the server when recommended by MVS through use of the IWMSRFSV interface. The structure
of this data is undefined to MVS,
and will be returned to the program invoking IWMSRFSV when the server
is returned.
To code: Specify the RS-type
address, or address in register (2)-(12), of a 32-character field.
- ,SERVER_LIMIT=server_limit
- ,SERVER_LIMIT=1000
- When MANAGE_TASKS=YES, SERVER_TYPE=QUEUE and SERVER_MANAGER=YES
are specified, an optional input parameter indicating the architectural
limit of the application for the number of server instances which
can be supported.
This parameter can be
used to tell WLM the upper limit up to which WLM will recommend to
start server instances. If the parameter is omitted or is set higher
than 1000, WLM will use 1000 as upper limit instead. The default is
1000.
To
code: Specify the RS-type address of a fullword field.
- ,SERVER_MANAGER=NO
- ,SERVER_MANAGER=YES
- An optional parameter indicating whether the space needs access
to a family of services specified by SERVER_TYPE. The default is SERVER_MANAGER=NO.
- ,SERVER_MANAGER=NO
- The connecting address space will not use any of the various
server related WLM services documented under SERVER_TYPE.
- ,SERVER_MANAGER=YES
- The connecting address space will be acting in the role of a
server and needs access to the family of services specified by SERVER_TYPE.
Specification
of both Queue_Manager=Yes, and Server_Manager=Yes requires that Server_Type=Queue.
Specification of Server_Type=Routing is rejected.
Specification
of both Router=Yes, and Server_Manager=Yes requires that Server_Type=Routing.
Specification of Server_Type=Queue is rejected.
- ,SERVER_TYPE=QUEUE
- ,SERVER_TYPE=ROUTING
- When SERVER_MANAGER=YES is specified, an optional parameter,
which describes what type of services are used by the server. The
default is SERVER_TYPE=QUEUE.
- ,SERVER_TYPE=QUEUE
- indicates that the server selects work from a queue, and thus
requests that WLM Work Execution services be available to the connecting
address space. For example:
- Select (IWMSSEL)
- Begin (IWMSTBGN)
- End (IWMSTEND)
The server also has the WLM Work Queuing services available
to the connecting address space when the corresponding Queue Manager
with the same subsystem type and name is active on the same MVS image (see following macros for
macro specific restrictions). For example:
- Insert (IWMQINS)
- Delete (IWMQDEL)
- ,SERVER_TYPE=ROUTING
- indicates that the server receives work by way of routing, and
may be selected by the IWMSRFSV (Find Server) macro interface. Note
that the space which invokes the IWMSRFSV service must Connect with
Router=Yes.
Termination of the router with the same subsystem type
and name on the same MVS image
will not cause notification to the server to terminate. This coordination,
if required, must be handled through a different protocol than use
of Connect.
- ,SRV_MGR_EXIT@=srv_mgr_exit@
- When SERVER_TYPE=ROUTING and SERVER_MANAGER=YES are specified,
a required input parameter that is to contain the address of the Server
Manager Connect Exit to be invoked when the system wishes to inform
the server of actions it should perform. This exit will be called
in SRB mode, with a non cross-memory environment, where HASN=SASN=PASN=HASN
at the time IWMCONN was invoked. The mapping of the parameter list
for the exit and its invocation environment is given by the list form
of the IWMSCXIT macro.
Note that it may be possible for the exit
to be called before the caller has received control back from IWMCONN.
The exit or any program it drives (synchronously or asynchronously)
must synchronize with the program issuing IWMCONN to ensure that IWMCONN
has returned a connect token prior to issuing IWMDISC (disconnect)
or any other services that need the connect token.
The system
may cause the space to become ineligible to be recommended by IWMSRFSV
upon repetitive errors in calling the exit specified. The exit must
be callable from the server address space and remain available after
the server manager disconnects or the connecting server TCB terminates.
The exit need not persist upon memory termination of the server.
To code: Specify the RS-type address, or address
in register (2)-(12), of a pointer field.
- ,SUBSYS=subsys
- A required input parameter, which contains the generic subsystem
type (e.g. IMS™, CICS®, etc.). When WORK_MANAGER=YES is specified,
this is the primary category under which classification rules are
grouped.
If the caller connects to the WLM work queueing services
by specifying QUEUE_MANAGER=YES, or requests sysplex routing by specifying
ROUTER=YES, the combination of the subsystem type and the subsystem
name must be unique to that MVS system.
To code: Specify the RS-type address, or address
in register (2)-(12), of a 4-character field.
- ,SUBSYSNM=subsysnm
- A required input parameter, which contains the subsystem name
to be used for classifying work requests when Work_Manager=Yes is
specified or taken as default. The subsystem name identifies a specific
instance of the generic subsystem type.
When Server_Manager=Yes
and Server_Type=Queue is specified, the subsystem name should match
the subsystem name specified on the corresponding Connect for the
Queue_Manager, i.e. all servers associated with the Queue_Manager
have identical subsystem names.
When Server_Manager=Yes and
Server_Type=Routing is specified, the subsystem name should match
the subsystem name specified on the corresponding Connect for Router=Yes,
i.e. all servers associated with the Router have identical subsystem
names.
If a product choses to use both Work_Manager=Yes and
Server_Manager=Yes on a single invocation of IWMCONN for a space,
then the rules for Server_Manager apply, i.e. the subsystem name refers
to the subsystem name of the space playing the role of Queue_Manager
or Router.
If the caller connects to the WLM work queueing services,
or to sysplex routing services, the combination of the subsystem type
and the subsystem name must be unique to that MVS system.
To code: Specify
the RS-type address, or address in register (2)-(12), of an 8-character
field.
- ,TOPOLOGY=topology
- ,TOPOLOGY=NO_TOPOLOGY
- When WORK_MANAGER=YES is specified, an optional input parameter,
which represents a list of ASCB addresses for the address spaces which
comprise the subsystem. This list should ONLY include address spaces
which do NOT surface as the current home address space when IWMMINIT
or IWMMRELA are used to establish the delay monitoring environments,
but that may participate as dispatchable units (TCBs or SRBs) in serving
work requests. If the current primary or home space is a space not
surfacing in a monitoring environment and its execution can affect
the response time of work flowing through the subsystem, then it should
appear in the list. Neither current primary nor current home are defaults.
While there are no limits on the number of address spaces, this information
is less precise than that provided by monitoring environments. The
default is NO_TOPOLOGY, which indicates that no topology information
was passed.
To code: Specify the RS-type
address, or address in register (2)-(12), of a character field.
- WORK_MANAGER=YES
- WORK_MANAGER=NO
- An optional parameter indicating that WLM Work Management services
be available to the connecting address space. For example:
- Classify (IWMCLSFY)
- Report (IWMRPT)
- Notify (IWMMNTFY)
- Enclave Create (IWMECREA)
- Modify Connect (IWMWMCON)
If NO is specified, the above services cannot be used, except
for the form of Notify that does not pass an input connect token.
The default is WORK_MANAGER=YES.
- WORK_MANAGER=YES
- The connecting address space will be using the WLM Work Management
services.
- WORK_MANAGER=NO
- The connecting address space will not use the WLM Work Management
services. Specifying this keyword may reduce the use of system resources.
|