You define your API exits in new stanzas in the mqs.ini and qm.ini files (or in the Windows registry). The following sections describe these stanzas, and the attributes within them that define the exit routines and the sequence in which they run. For guidance on how to change these stanzas, see Changing the configuration information.
Stanzas in mqs.ini are:
The stanza in qm.ini is:
All API exit stanzas share 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). See Rules for naming WebSphere MQ objects.
The length of this field is limited to MQ_OBJECT_NAME_LENGTH.
If this field contains the full pathname 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.
The mqs.ini file below contains the following stanzas:
mqs.ini ApiExitTemplate: Name=OurPayrollQueueAuditor Sequence=2 Function=EntryPoint Module=/opt/ABC/auditor Data=123 ApiExitCommon: Name=TivoliMQIPoliceman Sequence=1 Function=EntryPoint Module=/opt/TMQPolice/tmqp Data=CheckEverything
The qm.ini file below contains an ApiExitLocal definition of an exit with the descriptive name ClientApplicationAPIchecker, module name ClientAppChecker, and sequence number 3.
qm.ini ApiExitLocal: Name=ClientApplicationAPIchecker Sequence=3 Function=EntryPoint Module=/opt/Dev/ClientAppChecker Data=9.20.176.20
The WebSphere MQ configuration file, mqs.ini, contains information relevant to all the queue managers on a particular node. You can find it in the /var/mqm directory. On Windows systems, this information is stored in the registry.
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, held in the root of the directory tree occupied by the queue manager. For example, the path and the name for a configuration file for a queue manager called QMNAME is:
/var/mqm/qmgrs/QMNAME/qm.ini
On Windows systems, this information is stored in the registry.
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 either:
On Windows systems, you can use the command amqmdain reg or use the WebSphere MQ Services configuration interface to make relevant changes to the registry. Go to the Exits tab of the Properties notebook for a queue manager to start the procedure. For details of the amqmdain command, see the WebSphere MQ System Administration Guide book.
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.)
Once created as a service program, an exit must be referenced in the
appropriate stanza in an ini file using LIBRARY/PROGRAM syntax, as in the
following example:
On OS/400, the ini files are stored in the IFS, as follows:
Each queue manager has its own qm.ini file in its own
subdirectory.
You can use the EDTF CL command to edit these files.OS/400 considerations
ApiExitLocal:
Name=Sample
Sequence=1
Function=EntryPoint
Module=MYLIB/MYSRVPGM
Data=123
/QIBM/UserData/mqm/mqs.ini
/QIBM/UserData/mqm/qmgrs/<queue-manager-name>/qm.ini