Message domain exit XMEOUT
You can use the XMEOUT exit to suppress or reroute CICS® and CICSPlex SM messages that use the CICS message domain.
- It can suppress or reroute only messages sent to the system console or to transient data queues. It cannot suppress or reroute messages sent to terminal operators. XMEOUT is not invoked for messages sent to terminal operators.
- It can suppress or reroute only messages that use the message domain. You can determine which
CICS messages this applies to from CICS messages. The description of each
message that can invoke XMEOUT contains a list titled "XMEOUT parameters/Message inserts"; if
no XMEOUT parameters are listed for a message, the message cannot invoke the exit. For example,
message DFHDX8320 can invoke XMEOUT, but message DFHDU0205 does
not. For CICSPlex SM, XMEOUT is invoked only for messages that have a destination of EYULOG, because these are the messages that use the message domain. You can determine which messages this applies to from CICSPlex SM messages.Note: CICSPlex SM messages that invoke the XMEOUT exit can be rerouted or suppressed only from the joblog or console, not from the EYULOG.
- It cannot reroute or suppress CICSPlex SM Web User interface messages.
- It cannot change the text of a message, or change the message inserts. If it attempts to do so, CICS ignores the changes.
- It cannot suppress or reroute messages issued during the early stages of CICS initialization (because the exit cannot be enabled then).
- It cannot reroute a message to transient data (TD) queues during CICS shutdown, unless the original
message destination included one or more transient data queues. If it attempts to do so, the message
is routed to its original destination, and message DFHME0120I is issued to the
console. The user exit program cannot reroute message DFHME0120I, but it can
suppress this message.
This restriction is necessary because the message domain must handle messages during CICS shutdown even after the transient data queue function has ended.
To discover whether CICS shutdown has started, your exit program can check for the first instance of message DFHME0120. It can stop rerouting messages to TD queues after DFHME0120 has been issued.
Important
- Any DFHTDxxxx messages, which are produced by the transient data program.
- User domain messages in the range DFHUS0002 toDFHUS0006, plus message DFHUS0150.
- Transaction manager messages DFHXM0212, DFHXM0213, DFHXM0304, and DFHXM0308.
- Application messages DFHAP0001, DFHAP0002, DFHAP0004, DFHAP0601, DFHAP0602, and DFHAP0603.
- Any user domain (DFHUSxxxx) messages to an intrapartition queue defined with a TRIGLEV value of anything other than zero, if the messages are produced while the user domain is performing error recovery processing.
The message definition template contains an indicator called noreroute. This indicator is set on if the message that is being issued cannot be rerouted to a transient data queue by the XMEOUT exit program. The address of the indicator is passed to XMEOUT in the UEPNRTE exit-specific parameter. Your exit program can check the value of the indicator before deciding whether to reroute a particular message.
Each message that is affected by this restriction is identified by a note in CICS messages.
It is possible to pass APPLID (the application identifier) as an optional parameter in a message. However, the APPLID that is inserted in a message might not be the APPLID of the current CICS system. For example, when a CICSPlex SM MAS message is routed to a CMAS, the APPLID of the MAS system might be passed, so the message contains the APPLID of the MAS system and not the current system (the CMAS).
- UEPMROU (route codes)
- UEPMNRC (number of route codes)
- UEPMTDQ (transient data queue names)
- UEPMNTD (number of TDQs)
Using XMEOUT to monitor DFHAP1900 message
Message DFHAP1900 is issued when a change is made to the CICS system configuration by certain system programming interface commands. These commands are SET, PERFORM, ENABLE, DISABLE, or RESYNC. The commands are written to the transient data queue CADS. The DFHAP1900 messages can provide auditing of dynamic configuration changes and also aid problem determination. For more information, see SPI commands that can be audited.