Exit XMEOUT

This exit is invoked before a message domain sends a CICS® message.

When invoked
Before the message domain sends a CICS message to its destination.
Exit-specific parameters
UEPTRANID
Address of the 4-byte transaction ID.
UEPUSER
Address of the 8-byte user ID.
UEPTERM
Address of the 4-byte ID of the terminal under which the current transaction is running. If the current transaction is not associated with a terminal, the addressed field contains hexadecimal zeroes.
UEPPROG
Address of the 8-byte application program name, or nulls if there is no current application.
UEPMNUM
Address of a 4-byte field containing the message number. For CICSPlex® SM messages, this field contains binary zeros.
UEPMDOM
Address of a 2-byte field containing the domain identifier of the CICS message. For CICSPlex SM messages, this field contains binary zeros.
UEPMROU
Address of an array of up to 28 route codes. Route codes must be numbers in the range 1 through 28.
UEPMNRC
Address of a halfword containing the number of route codes in the route code array.
UEPMTDQ
Address of an array of up to 25 transient data queue names to which the message is to be sent. TD queue names must consist of 4 alphanumeric characters.
UEPMNTD
Address of a halfword containing the number of TDQs in the queues array.
UEPINSN
Address of a 2-byte field containing the number of message inserts.
UEPINSA
Address of an array, each element of which contains information about a single message insert. The size of the array depends on the number of inserts. Each array element has the following structure:
INSERT_FORMAT_P  DS  A  Address of the 1-byte insert
                        type-code, which has one of
                        the following hexadecimal values:
                        0    Not present
                        1    Character
                        2    Hexadecimal
                        3    Decimal
                        4    The insert is a number representing one item in a list of options.
                             (See the example below.)
                        7    Integer (no reformatting of numbers > 999) 
 INSERT_P         DS  A  Address of the message insert
 INSERT_LENGTH_P  DS  A  Address of a fullword containing the length of the insert
 INSERT_TYPE_P    DS  A  Reserved. 

You can find the order of the inserts in the array from the entry for the specific message in the CICS messages. For example:

DFHFC0531 date time applid Automatic journal journal journalname, opened for file filename is not of type MVS Module module

The XMEOUT inserts are date, time, applid, journal, journalname, filename, and module. The fourth insert (journal) is the number specified for JOURNAL on the file definition.

UEPNRTE
Address of 1-character flag indicating whether or not the message can be rerouted by XMEOUT. The possible values are:
C'0:'
The message can be routed.
C'1:'
The message cannot be routed.
UEPCPID
Address of a 3-byte product ID. The possible values are:
DFH
CICS messages.
EYU
CICSPlex SM messages.
UEPCPDOM
Address of a 2-byte field containing the domain identifier of the message.
UEPCPNUM
Address of a 4-byte field containing the message number.
UEPCPSEV
Address of the message severity code.
Return codes
UERCNORM
Continue processing.
UERCBYP
Suppress the message for all destinations.

CICSPlex SM messages cannot be suppressed. For these messages, a response of UERCBYP is treated as UERCNORM.

Specifying a return code of UERCBYP does not suppress the emission of any MESSAGE system events defined for the message.

XPI calls
WAIT_MVS can be used. Do not use any other calls.


dfha3e2.html | Timestamp icon Last updated: Monday, 5 June 2017