Message set properties

General message set properties

The table below defines the properties that you can set to customize the message set.

Property Type Meaning
Message set ID String This is a unique identifier that is automatically generated for you when you create the message set. You cannot change this property.
Default Wire Format String Specify the default wire format that is used if a format cannot be deduced from the message's MQRFH2 header, or was not specified as a property of the input node at which the message is received by a message flow. The default is empty (not set).
Message Type Prefix String This property is used when you define multipart messages (see Multipart messages for a definition and explanation of multipart 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 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.

Runtime Parser Start of changeStringEnd of change Start of changeSelect the message parser for messages belonging to this set from the drop-down list. The message parser name should be used when writing 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 will use the message parser name when generating ESQL field references. The message parser name must match the Message Domain property of any input node that will process messages from the message set, or the <Msd> element value of any MQRFH2 header preceding a message from the message set. You can choose from:
  • MRM (the default). If you specify MRM, you must deploy the message set to the brokers that will receive these messages. The deploy action creates a runtime dictionary (RTD) against which the MRM parser invoked by the broker checks the received message.
  • XML, XMLNS, JMSMap, or JMSStream. Choose one of these parsers if you want to model a generic self-defining XML, XMLNS, JMSMap, or JMSStream message. Messages defined in this way are interpreted by the generic XML parser, not the MRM parser. (You do not have to deploy these message sets to brokers, because these parsers do not use a runtime dictionary.)
End of change
Use namespaces Check box Select this property if you want to use namespaces within the message set.

Once this has been enabled, it cannot be disabled.

Treat Length facet as MaxLength Check box Select this property if you want the COBOL importer to create a maxLength facet for a fixed length string element rather than a length facet.

The default is for this property to be set.

Use of the message set property Message Type Prefix

The table below shows the implications of using the property Message Type Prefix. Note that message type or message prefix may describe might be 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 this is the largest message object as defined by the MRM.

In addition to message set properties, each of the physical formats have properties that can be updated. There is also a documentation property for a message set. Details of these can be found at;

Related concepts
Message set projects
Message sets
Physical formats in the MRM domain
Related tasks
Working with a message set project
Working with a message set
Related reference
Custom Wire Format message set properties
XML Wire Format message set properties
TDS Format message set properties
Documentation properties for all message set objects