This section tells you how to configure API exits.
You define your API exits in stanzas in the mqs.ini and qm.ini files. The sections below describe these stanzas, and the attributes within them that define the exit routines and the sequence in which they run. For guidance on the process of changing these stanzas, see Changing the configuration information.
Stanzas in mqs.ini are:
The stanza in qm.ini is:
All these stanzas have the following attributes:
This name must be unique, no longer than 48 characters, and contain only valid characters for the names of WebSphere MQ objects (for example, queue names).
The length of this field is limited to MQ_EXIT_NAME_LENGTH.
If this field contains the full path name of the module it is used as is.
If this field contains just the module name, the module is located using the ExitsDefaultPath attribute in the ExitPath in qm.ini.
The length of this field is limited to the maximum path length the platform supports.
If you include this attribute, leading and trailing blanks are removed, the remaining string is truncated to 32 characters, and the result is passed to the exit. If you omit this attribute, the default value of 32 blanks is passed to the exit.
The maximum length of this field is 32 characters.
This attribute is an unsigned numeric value.
Once you have created an exit as a service program, you must refer to it in the appropriate stanza in a configuration file using LIBRARY/PROGRAM syntax, as shown in the examples.
The mqs.ini file below contains the following stanzas:
mqs.ini ApiExitTemplate: Name=OurPayrollQueueAuditor Sequence=2 Function=EntryPoint Module=MYLIB/MYAUDIT Data=123 ApiExitCommon: Name=MQPoliceman Sequence=1 Function=EntryPoint Module=MYLIB/MYSECURE Data=CheckEverything
The qm.ini file below contains an ApiExitLocal definition of an exit with the descriptive name ClientApplicationAPIchecker, module name MYCHECK, and sequence number 3.
qm.ini ApiExitLocal: Name=ClientApplicationAPIchecker Sequence=3 Function=EntryPoint Module=MYLIB/MYCHECK Data=9.20.176.20
The WebSphere MQ configuration file, mqs.ini, contains information relevant to all the queue managers on a particular node.
A queue manager configuration file, qm.ini, contains information relevant to a specific queue manager. There is one queue manager configuration file for each queue manager, stored in its own subdirectory.
The configuration files are stored in the IFS, as follows:
/QIBM/UserData/mqm/mqs.ini /QIBM/UserData/mqm/qmgrs/<queue-manager-name>/qm.ini
Before editing a configuration file, back it up so that you have a copy you can revert to if the need arises.
You can edit configuration files using the EDTF CL command.
If you set an incorrect value on a configuration file attribute, the value is ignored and an operator message is issued to indicate the problem. (The effect is the same as missing out the attribute entirely.)
Notices |
Downloads |
Library |
Support |
Feedback
![]() ![]() |
chconfig |