Table 69 summarizes the message domain’s specific gates.
It shows the level-1 trace point IDs of the modules providing the functions
for the gates, the functions provided by the gates, and whether or not the
functions are available through the exit programming interface (XPI).
Table 69. Message domain’s specific gates
Gate |
Trace |
Function |
XPI |
MEBM |
None
|
INQUIRE_MESSAGE_DEFINITION
INQUIRE_MESSAGE_LENGTH
RETRIEVE_MESSAGE
|
NO
NO
NO
|
MEME |
ME 0301
ME 0302
|
CONVERSE
INQUIRE_MESSAGE
INQUIRE_MESSAGE_LENGTH
RETRIEVE_MESSAGE
SEND_MESSAGE
VALIDATE_LANGUAGE_CODE
VALIDATE_LANGUAGE_SUFFIX
|
NO
NO
NO
NO
NO
NO
NO
|
MESR |
ME 0201
ME 0202
|
SET_MESSAGE_OPTIONS
|
NO
|
The RETRIEVE_MESSAGE function of the MEBM gate is used to retrieve the
message text and build the message into a buffer.
Input parameters
- MESSAGE_TABLE
- is a table containing all the message definitions for the message domain.
- [COMPONENT_ID]
- is the component identifier for the message.
- MESSAGE_NUMBER
- is the numeric message identifier.
- MESSAGE_BUFFER
- is the buffer to receive the message text.
- [INSERT1] through [INSERT10]
- are user-supplied inserts, if these are required by the message definition.
- [SYMPTOM_BUFFER]
- is the buffer to receive a symptom string for the message.
- [SUPPRESS_SRBUILD]
- indicates whether or not a symptom record build is suppressed. It can
have either of these values:
YES|NO
- [MODULE_NAME]
- is the name of the module in error, supplied as data for the symptom
string.
- [MODULE_PTF]
- is the PTF level of the module in error, supplied as data for the symptom
string.
- [UPPERCASE]
- determines whether or not messages should be converted to uppercase.
It can have either of these values:
YES|NO
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have either of these
values:
OK|EXCEPTION
- [REASON]
- is returned when RESPONSE is EXCEPTION. It has this value:
MESSAGE_CANNOT_BE_PRODUCED
The INQUIRE_MESSAGE_LENGTH function of the MEBM gate is used to find the
length of the message in order to obtain the appropriate sized buffer to retrieve
the message.
Input parameters
- MESSAGE_TABLE
- is a table containing all the message definitions for messages output
by the message domain.
- [COMPONENT_ID]
- is the component identifier for the message.
- MESSAGE_NUMBER
- is the numeric message identifier.
- [INSERT1] through [INSERT10]
- are user-supplied inserts, if these are required by the message definition.
Output parameters
- MESSAGE_LENGTH
- is the length of the message being inquired on.
- RESPONSE
- is the domain’s response to the call. It can have either of these
values:
OK|EXCEPTION
- [REASON]
- is returned when RESPONSE is EXCEPTION. It has this value:
MESSAGE_CANNOT_BE_FOUND
The INQUIRE_MESSAGE_DEFINITION function of the MEBM gate is used to return
the action and severity codes of a message.
Input parameters
- MESSAGE_TABLE
- is a table containing all the message definitions for the message domain.
- [COMPONENT_ID]
- is the component identifier for the message.
- MESSAGE_NUMBER
- is the numeric message identifier.
Output parameters
- SEVERITY_CODE
- is the severity of the message.
- ACTION_CODE
- is the action code for the message.
- RESPONSE
- is the domain’s response to the call. It can have either of these
values:
OK|EXCEPTION
- [REASON]
- is returned when RESPONSE is EXCEPTION. It has this value:
MESSAGE_CANNOT_BE_FOUND
The SEND_MESSAGE function of the MEME gate is used to send a message to
one or more destinations.
Input parameters
- [COMPONENT_ID]
- is the component identifier for the message.
- MESSAGE_NUMBER
- is the numeric message identifier.
- [PRODUCT]
- is an optional product identifier.
- [MSGTABLE]
- indicates that the feature message table is to be used.
- [SYSTEM_DUMPCODE]
- is the dump code to be used when the message domain requests a dump
on behalf of its caller.
- [TERMINATE_CICS]
- specifies whether the caller requests CICS to be terminated.
[RESTART_CICS]
specifies whether the caller requests CICS to be automatically restarted
by ARM.
- [INSERT1] through [INSERT10]
- are user-supplied inserts, if these are required by the message definition.
- [TRANID]
- is the transaction identifier to be used to override the tranid obtained
by the message domain.
- [TERMID]
- is the terminal identifier to be used to override the termid obtained
by the message domain.
- [NETNAME]
- is the network name to be used to override the netname obtained by the
message domain.
[NOREROUTE]
specifies whether the caller requests that the message is to be rerouted
to a transient data destination.
[TDQUEUES] 
specifies the transient data destinations to which a message is to be
sent.
[IGNORE_EXCEPTIONS] 
specifies whether the caller requests that a failure sending a message
to a transient data destination is to be ignored.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, INVALID, or PURGED. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
INVALID_MODULE_PTR
INVALID_TEMPLATE
ABEND
INSUFFICIENT_STORAGE
|
INVALID |
INVALID_COMPONENT_TYPE
INVALID_DBCS_FORMAT
INVALID_DESTINATION
INVALID_FUNCTION
INVALID_INSERT
INVALID_MEFO_RESPONSE
MESSAGE_NOT_FOUND
MESSAGE_SET_NOT_FOUND
MISSING_INSERT
OPT_INSERT_NOT_FOUND
RETRY_MSG_LOCATE
|
PURGED |
TDQ_PURGED |
The CONVERSE function of the MEME gate is used to send a message and receive
a reply.
Input parameters
- [COMPONENT_ID]
- is the component identifier for the message.
- MESSAGE_NUMBER
- is the numeric message identifier.
- [PRODUCT]
- is an optional product identifier.
- [INSERT1] through [INSERT10]
- are user-supplied inserts, if these are required by the message definition.
- [TRANID]
- is the transaction identifier to be used to override the tranid obtained
by the message domain.
- [TERMID]
- is the terminal identifier to be used to override the termid obtained
by the message domain.
- [NETNAME]
- is the network name to be used to override the netname obtained by the
message domain.
- [REPLY_BUFFER]
- is the buffer into which the text reply is to be returned.
- REPLY_FORMAT (VALUE|TEXT_OR_VALUE|TEXT)
- indicates the format of the reply. It can be one of these formats:
VALUE|TEXT_OR_VALUE|TEXT
Output parameters
- [REPLY_INDEX]
- is the number of the template reply option that matches the user’s
reply text.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
INVALID_MODULE_PTR
INVALID_TEMPLATE
MAX_REPLIES_EXCEEDED
ABEND
INSUFFICIENT_STORAGE
|
EXCEPTION |
REPLY_BUFFER_TOO_SMALL |
INVALID |
INVALID_COMPONENT_TYPE
INVALID_DESTINATION
INVALID_FUNCTION
INVALID_INSERT
INVALID_REPLY_BUFFER
MESSAGE_NOT_FOUND
MESSAGE_SET_NOT_FOUND
MISSING_INSERT
OPT_INSERT_NOT_FOUND
REPLY_BUFFER_REQUIRED
REPLY_INDEX_REQUIRED
RETRY_MSG_LOCATE
|
The RETRIEVE_MESSAGE function of the MEME gate is used to retrieve a message
text.
Input parameters
- [COMPONENT_ID]
- is the component identifier for the message.
- MESSAGE_NUMBER
- is the numeric message identifier.
- MESSAGE_BUFFER
- is the buffer to receive the message text.
- [PRODUCT]
- is an optional product identifier.
- [MSGTABLE]
- indicates that the feature message table is to be used.
- [LANGUAGE]
- is an optional language code.
- [INSERT1] through [INSERT10]
- are user-supplied inserts, if these are required by the message definition.
- [TRANID]
- is the transaction identifier to be used to override the tranid obtained
by the message domain.
- [TERMID]
- is the terminal identifier to be used to override the termid obtained
by the message domain.
- [NETNAME]
- is the network name to be used to override the netname obtained by the
message domain.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
INSUFFICIENT_STORAGE
INVALID_MODULE_PTR
INVALID_TEMPLATE
|
EXCEPTION |
MSG_BUFFER_TOO_SMALL
REPLY_BUFFER_TOO_SMALL
|
INVALID |
INVALID_COMPONENT_TYPE
INVALID_FUNCTION,
INVALID_INSERT
INVALID_MESSAGE_BUFFER
MESSAGE_NOT_FOUND
MESSAGE_SET_NOT_FOUND,
MISSING_INSERT
OPT_INSERT_NOT_FOUND
RETRY_MSG_LOCATE
|
The INQUIRE_MESSAGE_LENGTH function of the MEME gate is used to find the
length of the message in order to obtain the appropriate size buffer to retrieve
the message.
Input parameters
- [COMPONENT_ID]
- is the component identifier for the message.
- MESSAGE_NUMBER
- is the numeric message identifier.
- [PRODUCT]
- is an optional product identifier.
- [MSGTABLE]
- indicates that the feature message table is to be used.
- [LANGUAGE]
- is an optional language code.
- [INSERT1] through [INSERT10]
- are user-supplied inserts, if these are required by the message definition.
Output parameters
- MESSAGE_LENGTH
- is the length of the message being inquired on.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND
INSUFFICIENT_STORAGE
INVALID_MODULE_PTR
INVALID_TEMPLATE
|
INVALID |
INVALID_COMPONENT_TYPE
INVALID_FUNCTION
INVALID_INSERT
MESSAGE_NOT_FOUND
MESSAGE_SET_NOT_FOUND
MISSING_INSERT
OPT_INSERT_NOT_FOUND
RETRY_MSG_LOCATE
|
The VALIDATE_LANGUAGE_CODE function of the MEME gate is used to determine
whether a specific three-letter IBM® standard national language code is valid.
If it is valid, this function returns the equivalent one-character CICS language
suffix. The IBM standard three-character codes, and their corresponding one-character
CICS language suffices, are listed in Table 70.
Input parameters
- LANGUAGE_CODE
- is the three-character national language code to be validated.
Output parameters
- [LANGUAGE_SUFFIX]
- is the one-character CICS language suffix that corresponds to the input
LANGUAGE_CODE.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|DISASTER|EXCEPTION|INVALID
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
LANGUAGE_CODE_INVALID
LANGUAGE_NOT_SUPPORTED
|
INVALID |
INVALID_FUNCTION |
Table 70. Languages and their codes
NATLANG code |
NLS code |
Language |
A |
ENG |
Alternative English |
Q |
ARA |
Arabic |
1 |
BEL |
Byelorussian |
L |
BGR |
Bulgarian |
B |
PTB |
Brazilian Portuguese |
T DBCS |
CHT |
Traditional Chinese |
C DBCS |
CHS |
Simplified Chinese |
2 |
CSY |
Czech |
D |
DAN |
Danish |
G |
DEU |
German |
O |
ELL |
Greek |
S |
ESP |
Spanish |
W |
FIN |
Finnish |
F |
FRA |
French |
X |
HEB |
Hebrew |
3 |
HRV |
Croatian |
4 |
HUN |
Hungarian |
J |
ISL |
Icelandic |
I |
ITA |
Italian |
H DBCS |
KOR |
Korean |
M |
MKD |
Macedonian |
9 |
NLD |
Dutch |
N |
NOR |
Norwegian |
5 |
PLK |
Polish |
P |
PTG |
Portuguese |
6 |
ROM |
Romanian |
R |
RUS |
Russian |
Y |
SHC |
Serbo-Croatian (Cyrillic) |
7 |
SHL |
Serbo-Croatian (Latin) |
V |
SVE |
Swedish |
Z |
THA |
Thai |
8 |
TRK |
Turkish |
U |
UKR |
Ukrainian |
Notes:
- DBCS denotes Double-Byte Character Set languages.
- A for alternative English. Code letter A means "alternative English" to distinguish your edited English message tables
from the default US English message tables supplied by CICS. The default US
English tables are designated by the language code letter E.
- The NATLANG code for the selected language is used as the suffix of your
edited message data sets that you can create using the message editing utility.
For more information about the message editing utility, see CICS® Operations and Utilities Guide.
|
The VALIDATE_LANGUAGE_SUFFIX function of the MEME gate is used to determine
whether a specific one-character CICS language suffix is valid. If it is valid,
this function returns the equivalent three-character IBM standard national
language code. The IBM standard three-character codes, and their corresponding
one-character CICS language suffices, are listed in Table 70.
Input parameters
- LANGUAGE_SUFFIX
- is the one-character CICS language code to be validated.
Output parameters
- [LANGUAGE_CODE]
- is the three-character CICS language suffix that corresponds to the
input LANGUAGE_SUFFIX.
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|DISASTER|EXCEPTION|INVALID
- [REASON]
- is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible
values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
EXCEPTION |
LANGUAGE_NOT_SUPPORTED
LANGUAGE_SUFFIX_INVALID
|
INVALID |
INVALID_FUNCTION |
The INQUIRE_MESSAGE function of the MEME gate is used to find the system
default language as a one-character CICS language suffix and a three-character
IBM standard national language code.
Input parameters
None.
Output parameters
- DEFAULT_LANGUAGE_CODE
- is the three-character code for the default language.
- DEFAULT_LANGUAGE_SUFFIX
- is the one-character suffix for the default language.
- RESPONSE
- is the domain’s response to the call. It can have either of these
values:
OK|DISASTER|INVALID
- [REASON]
- is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE |
Possible REASON values |
DISASTER |
ABEND |
INVALID |
INVALID_FUNCTION |
The SET_MESSAGE_OPTIONS function of the MESR gate is used to set the various
message options specified by the system initialization parameters MSGCASE,
MSGLVL, and NATLANG.
Input parameters
- [LANGUAGES_USED]
- is a list of the languages used in the system.
- [MESSAGE_LEVEL]
- can be 0 or 1. 0 means that information messages do not appear (are
suppressed) at the console.
- [MESSAGE_CASE]
- is either MIXED for mixed-case messages, or UPPER for messages to be
folded to uppercase.
Output parameters
- RESPONSE
- is the domain’s response to the call. It can have any of these
values:
OK|INVALID|KERNERROR|PURGED
- [REASON]
- is returned when RESPONSE is INVALID. It has this value:
INVALID_FUNCTION
[[ Contents Previous Page | Next Page Index ]]