Message sets have properties that you can set to define their characteristics and the way in which they are processed.
The table below defines the properties that you can set to customize the message set.
Property | Type | Meaning |
---|---|---|
Message Domain | String | Select, from the drop-down list, the message parser
for messages that belong to this set. Use the message parser name when you
write ESQL field references for messages in the message set; for example, InputRoot.MRM.Document.
The Mapping editor and the content assist feature of the ESQL editor use the
message parser name when they generate ESQL field references. The message
parser name must match the Message Domain property of any
input node that processes messages from the message set, or the <Msd>
element value of any MQRFH2 header that precedes a message from the message
set. You can choose from the following names:
|
![]() ![]() |
![]() ![]() |
![]() If you do not select any of the preceding options, the Default Wire Format format is unavailable. ![]() |
Message Set ID | String | This property is a unique identifier that is automatically generated for you when you create the message set. You cannot change this property. |
Message Set Alias | String | Specify an alternative unique value that identifies the message set. This property is only required if you are using the Message Identity technique to identify embedded messages. Using this technique, the embedded messages are defined in this message set but the parent message is defined in a different message set, and the bit stream does not contain the actual message set name or identifier. |
Message Type Prefix | String | This property is used when you define multipart messages,
specifically when using the Message Path technique to identify embedded messages. The value that you specify is used as an absolute or relative path to the innermost message from the outermost, and is used as a prefix to the value of the Message Type property that is specified for the outermost message (specified either in the MQRFH2 header of the message, or in the input node of the message flow). If you set a value, it must be in the form id1/id2/.../idnu where id1 is the identifier of the outermost message, id2 is the identifier of the next element or message, and idn is the identifier of the innermost message. The default value is blank (not set). The table below, describing the use of the message set property Message Type Prefix, shows how this value is combined with the Message Type property of an input message. |
Use namespaces | Check box | Select this property if you want to use namespaces within
the message set. Namespaces provide a method of avoiding naming conflicts
where different document definitions have elements of the same name. For further
information see Namespaces. By default, this check box is selected. Using namespaces affects how elements are created in the logical message tree. Each element in the message tree has both a name and a namespace, so an ESQL or Java reference to one of these elements has to specify both name and namespace. Therefore, using namespaces has an effect on the ESQL or the Java that you write. Select this property if you want to use the message set in the future to model XML messages. |
Broker will treat Length facet as MaxLength | Check box | Select this property if you want the COBOL importer
to create a maxLength facet, rather than a length facet, for a fixed length
string element. By default, this check box is selected. |
The table below shows the implications of using the property Message Type Prefix. The message type or message prefix can describe either elements or messages.
Message Type property example | Message Type Prefix not set | Message Type Prefix set |
---|---|---|
Simple Message Type:msg_type | Results in the simple Message Type:msg_type | Results in the path Message Type: /msg_prefix_1/.../msg_prefix_n/ msg_type |
Path Message Type:msg_type_1/.../msg_type_m | Results in the path Message Type:/msg_type_1/.../msg_type_m | Results in the combined path Message Type: /msg_prefix_1.../msg_prefix_n /msg_type_1/.../msg_type_m |
Simple absolute Message Type:/msg_type | Results in the simple Message Type:msg_type | Results in the simple Message Type:msg_type An error is raised if Message Type Prefix is set to any value other than msg_type. |
Path absolute Message Type:/msg_type_1/.../msg_type_m | Results in the path Message Type:/msg_type_1/.../msg_type_m | Results in the path Message Type:/msg_type_1/.../msg_type_m An error is raised if all identifiers in Message Type Prefix do not match the corresponding identifiers in the resulting path. |
The message set does not have any properties that are dictated by membership of a larger object, because it is the largest message object that can be defined by the MRM.
In addition to message set properties, you can update properties that are specific to each of the physical formats. Links to reference topics that describe these properties are given below.