Parameter descriptions

Home
Parameter descriptions

The parameter descriptions also apply to the ALTER PROCESS command, with the following exceptions:

The LIKE parameter applies only to the DEFINE PROCESS command.
The NOREPLACE and REPLACE parameter applies only to the DEFINE PROCESS command.
(process-name)

Name of the WebSphere MQ process definition (see Rules for naming WebSphere MQ objects). This is required.
The name must not be the same as any other process definition currently defined on this queue manager (unless REPLACE is specified).

APPLICID(string)

The name of the application to be started. This might typically be a fully-qualified file name of an executable object. The maximum length is 256 characters.
For a CICS application this is a CICS transaction ID, and for an IMS™ application it is an IMS transaction ID.
On z/OS, for distributed queuing, it must be “CSQX START”.

APPLTYPE(string)

The type of application to be started. Valid application types are:

integer

A system-defined application type in the range zero through 65 535 or a user-defined application type in the range 65 536 through 999 999 999.

For certain values in the system range, a parameter from the following list can be specified instead of a numeric value:

CICS

Represents a CICS transaction.

DOS

Represents a DOS application.

IMS

Represents an IMS transaction.

MVS™

Represents a z/OS application (batch or TSO).

NOTESAGENT

Represents a Lotus Notes agent.

NSK

Represents a Compaq NSK application.

OPENVMS

Represents a HP OpenVMS application.

OS2

Represents an OS/2 Warp application.

OS400

Represents an i5/OS application.

UNIX

Represents a UNIX application.

WINDOWS

Represents a Windows application.

WINDOWSNT

Represents a Windows NT, Windows 2000, or Windows XP application.

WLM

Represents a z/OS workload manager application.

DEF

This causes the default application type for the platform at which the command is interpreted to be stored in the process definition. This default cannot be changed by the installation. If the platform supports clients, this is interpreted as the default application type of the server.

Only application types (other than user-defined types) that are supported on the platform at which the command is executed should be used:

On HP OpenVMS, OPENVMS is supported
On z/OS, CICS (default), DOS, IMS, MVS, OS2, UNIX, WINDOWS, WINDOWSNT, WLM, and DEF are supported
On i5/OS, OS400 (default), CICS, and DEF are supported
On Compaq NSK, NSK is supported.
On UNIX systems, UNIX (default), OS2, DOS, WINDOWS, CICS, and DEF are supported
On Windows, WINDOWSNT (default), DOS, WINDOWS, OS2, UNIX, CICS, and DEF are supported

CMDSCOPE

This parameter applies to z/OS only and specifies how the command is executed when the queue manager is a member of a queue-sharing group.
CMDSCOPE must be blank, or the local queue manager, if QSGDISP is set to GROUP.

‘ ’

The command is executed on the queue manager on which it was entered. This is the default value.

qmgr-name

The command is executed on the queue manager you specify, providing the queue manager is active within the queue-sharing group.
We can specify a queue manager name other than the queue manager on which it was entered, only if you are using a shared queue environment and if the command server is enabled.

*

The command is executed on the local queue manager and is also passed to every active queue manager in the queue-sharing group. The effect of this is the same as entering the command on every queue manager in the queue-sharing group.

DESCR(string)

Plain-text comment. It provides descriptive information about the object when an operator issues the DISPLAY PROCESS command.
It should contain only displayable characters. The maximum length is 64 characters. In a DBCS installation, it can contain DBCS characters (subject to a maximum length of 64 bytes).
If characters are used that are not in the coded character set identifier (CCSID) for this queue manager, they might be translated incorrectly if the information is sent to another queue manager.

ENVRDATA(string)
A character string that contains environment information pertaining to the application to be started. The maximum length is 128 characters.
The meaning of ENVRDATA is determined by the trigger-monitor application. The trigger monitor provided by WebSphere MQ appends ENVRDATA to the parameter list passed to the started application. The parameter list consists of the MQTMC2 structure, followed by one blank, followed by ENVRDATA with trailing blanks removed.
On z/OS, ENVRDATA is not used by the trigger-monitor applications provided by WebSphere MQ.
On z/OS, if APPLTYPE is WLM, the default values for the ServiceName and ServiceStep fields in the work information header (MQWIH) can be supplied in ENVRDATA. The format must be:
SERVICENAME=servname,SERVICESTEP=stepname
where:

SERVICENAME=

is the first 12 characters of ENVRDATA.

servname

is a 32-character service name. It can contain embedded blanks or any other data, and have trailing blanks. It is copied to the MQWIH as is.

SERVICESTEP=

is the next 13 characters of ENVRDATA.

stepname

is a 1- to 8-character service step name. It is copied as is to the MQWIH, and padded to 8 characters with blanks.

If the format is incorrect, the fields in the MQWIH are set to blanks.
On UNIX systems, ENVRDATA can be set to the ampersand character to make the started application run in the background.
LIKE(process-name)
The name of an object of the same type, whose parameters will be used to model this definition.
This parameter applies only to the DEFINE PROCESS command.
If this field is not filled in, and you do not complete the parameter fields related to the command, the values are taken from the default definition for this object.
This is equivalent to specifying:
LIKE(SYSTEM.DEFAULT.PROCESS)
A default definition for each object type is provided, but these can be altered by the installation to the default values required. See Rules for naming WebSphere MQ objects.
On z/OS, the queue manager searches page set zero for an object with the name you specify and a disposition of QMGR or COPY. The disposition of the LIKE object is not copied to the object you are defining.

QSGDISP (GROUP) objects are not searched.
LIKE is ignored if QSGDISP(COPY) is specified.
QSGDISP
This parameter applies to z/OS only.
Specifies the disposition of the object to which you are applying the command (that is, where it is defined and how it behaves).
QSGDISP ALTER DEFINE
COPY The object definition resides on the page set of the queue manager that executes the command. The object was defined using a command that had the parameters QSGDISP(COPY). Any object residing in the shared repository, or any object defined using a command that had the parameters QSGDISP(QMGR), is not affected by this command. The object is defined on the page set of the queue manager that executes the command using the QSGDISP(GROUP) object of the same name as the 'LIKE' object.
GROUP
The object definition resides in the shared repository. The object was defined using a command that had the parameters QSGDISP(GROUP). Any object residing on the page set of the queue manager that executes the command (except a local copy of the object) is not affected by this command. If the command is successful, the following command is generated and sent to all active queue managers in the queue-sharing group to attempt to refresh local copies on page set zero:
DEFINE PROCESS(process-name)
REPLACE QSGDISP(COPY)
The ALTER for the group object takes effect regardless of whether the generated command with QSGDISP(COPY) fails.
The object definition resides in the shared repository. This is allowed only if the queue manager is in a queue-sharing group. If the definition is successful, the following command is generated and sent to all active queue managers in the queue-sharing group to attempt to make or refresh local copies on page set zero:
DEFINE PROCESS(process-name)
REPLACE QSGDISP(COPY)
The DEFINE for the group object takes effect regardless of whether the generated command with QSGDISP(COPY) fails.
PRIVATE The object resides on the page set of the queue manager that executes the command, and was defined with QSGDISP(QMGR) or QSGDISP(COPY). Any object residing in the shared repository is unaffected. Not permitted.
QMGR The object definition resides on the page set of the queue manager that executes the command. The object was defined using a command that had the parameters QSGDISP(QMGR). Any object residing in the shared repository, or any local copy of such an object, is not affected by this command. This is the default value. The object is defined on the page set of the queue manager that executes the command. This is the default value.
REPLACE and NOREPLACE

Whether the existing definition (and on z/OS, with the same disposition) is to be replaced with this one. This is optional. The default is NOREPLACE. Any object with a different disposition is not changed.
This parameter applies only to the DEFINE PROCESS command.

REPLACE

The definition should replace any existing definition of the same name. If a definition does not exist, one is created.

NOREPLACE

The definition should not replace any existing definition of the same name.

USERDATA(string)

A character string that contains user information pertaining to the application defined in the APPLICID that is to be started. The maximum length is 128 characters.
The meaning of USERDATA is determined by the trigger-monitor application. The trigger monitor provided by WebSphere MQ simply passes USERDATA to the started application as part of the parameter list. The parameter list consists of the MQTMC2 structure (containing USERDATA), followed by one blank, followed by ENVRDATA with trailing blanks removed.
For WebSphere MQ message channel agents, the format of this field is a channel name of up to 20 characters. See the WebSphere MQ Intercommunications manual for information about what these need as APPLICID.
On Compaq NSK, a character string containing spaces must be enclosed in double quotation marks.
Parent topic:
DEFINE PROCESS

sc11150_

Home

QSGDISP	ALTER	DEFINE
COPY	The object definition resides on the page set of the queue manager that executes the command. The object was defined using a command that had the parameters QSGDISP(COPY). Any object residing in the shared repository, or any object defined using a command that had the parameters QSGDISP(QMGR), is not affected by this command.	The object is defined on the page set of the queue manager that executes the command using the QSGDISP(GROUP) object of the same name as the 'LIKE' object.
GROUP	The object definition resides in the shared repository. The object was defined using a command that had the parameters QSGDISP(GROUP). Any object residing on the page set of the queue manager that executes the command (except a local copy of the object) is not affected by this command. If the command is successful, the following command is generated and sent to all active queue managers in the queue-sharing group to attempt to refresh local copies on page set zero: DEFINE PROCESS(process-name) REPLACE QSGDISP(COPY) The ALTER for the group object takes effect regardless of whether the generated command with QSGDISP(COPY) fails.	The object definition resides in the shared repository. This is allowed only if the queue manager is in a queue-sharing group. If the definition is successful, the following command is generated and sent to all active queue managers in the queue-sharing group to attempt to make or refresh local copies on page set zero: DEFINE PROCESS(process-name) REPLACE QSGDISP(COPY) The DEFINE for the group object takes effect regardless of whether the generated command with QSGDISP(COPY) fails.
PRIVATE	The object resides on the page set of the queue manager that executes the command, and was defined with QSGDISP(QMGR) or QSGDISP(COPY). Any object residing in the shared repository is unaffected.	Not permitted.
QMGR	The object definition resides on the page set of the queue manager that executes the command. The object was defined using a command that had the parameters QSGDISP(QMGR). Any object residing in the shared repository, or any local copy of such an object, is not affected by this command. This is the default value.	The object is defined on the page set of the queue manager that executes the command. This is the default value.