IBM Integration Bus, Version 10.0.0.2 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS


Message Sets: Message XML properties

The following tables describe the XML properties of a message.

Namespace schema locations

This property is only active if namespaces have been enabled.

Property Type Meaning
Namespace URI String A unique string, usually in the form of a URL that identifies the schema.

If namespaces have not been enabled, this property displays <no target namespace>.

This property overrides the same property at the message set level.

Schema location String Enter the location of the schema for the associated namespace name to be used to validate objects in the namespace.

XML declarations

Property Type Meaning
Output Namespace Declaration Enumerated type The Output Namespace Declaration property controls where the namespace declarations are placed in the output XML document.
Select from:
  • At start of document. Declarations for all of the entries in the Namespace schema locations table above are produced as attributes of the message in the output XML document. The disadvantage of this option is that in some cases unnecessary declarations might be produced.
  • As required. Declarations are produced only when required by an element or attribute that is in that namespace. The disadvantage of this option is that the same namespace declaration might need to be produced more than once in the output XML document.

The default option is At start of document.

This property is active only if namespaces are enabled for this message set.

XML document type settings

Property Type Meaning
DOCTYPE System ID String Specify the System ID for DOCTYPE external DTD subset. It overrides the equivalent message set property setting for this particular message.

If the message set property Suppress DOCTYPE is set to Yes, this parameter is ignored and cannot be changed (the field is disabled).

The default value is the value that you specified for the DOCTYPE System ID property for the message set.

DOCTYPE Public ID String Specify the Public ID for DOCTYPE external DTD subset. It overrides the equivalent message set property setting for this particular message.

If the message set property Suppress DOCTYPE is set to Yes, this parameter is ignored and cannot be changed (the field is disabled) .

The default value is the value that you specified for the DOCTYPE Public ID property for the message set.

DOCTYPE Text String Enter optional additional text to include within the DOCTYPE. It overrides the message set property for this particular message.

If the message set property Suppress DOCTYPE is set to Yes, this parameter is ignored and cannot be changed (the field is disabled).

For more information, see MRM XML: In-line DTDs and the DOCTYPE text property.

The default value is the value that you specified for the DOCTYPE Text property for the message set.

Property Type Meaning
Root Tag Name String Specify the name of the root tag for a message bit stream XML document. It overrides the message set property set for this message.

The default value is the value that you specified for the Root Tag Name property for the message set.

Note: This property is deprecated. Do not change its value from its default setting.

Field identification

A number of the following properties will only become active depending on the value that Render property is set to.

Property Type Meaning
Render Enumerated type Specify how the instantiated object or type is rendered (for output) in the resulting XML document. Select one of the following values from the drop-down list:
  • XMLElement. If you select this value, the object (or type) is rendered as a child XML element of the parent complex type. The identity of the child is determined by the tag name of the child. The value is the content of the child element.

    If you select this value for more than one object, and set their XML Name property to the same value, both objects must refer to the same element.

    This is the default value for element objects.

  • XMLElementAttrID. If you select this value, the object (or type) is rendered as a child XML element of the parent complex type. The identity of the child is determined by the value of a specified attribute of the child. The value is the content of the child element. You must add an attribute to the child element with an attribute name as specified in ID Attribute Name and a value as specified in ID Attribute Value.

    If you select this value for one object, and set this same value or the value XMLElementAttrIDVal for a second object, and set XML Name, ID Attribute Name, ID Attribute Value to the same values:

    • You must also set Value Attribute Name to the same value for the two objects.
    • Both objects must refer to the same element.

Message Sets: XML rendering options shows some examples of how these rendering options affect the XML output, and provides usage recommendations.

XML Name String Enter a value for the XML element name. This property specifies the name for the XML start tag or attribute for the element (or attribute) in an XML document (message).

This can be used to provide name mapping when the MRM identifier needs to be different from the XML name, for example because of different namespace rules. It must be a valid XML name.

You cannot specify a name that is already used for another element (or attribute) , or for a message. No two elements (or attribute) or messages can have the same XML name.

If you do not set a value, it defaults to that of the element's identifier. If the element's identifier is a prefixed identifier, it defaults to the identifier with the caret character (^) replaced by an underscore (_).

ID Attribute Name String Specify the name of the attribute used to identify the child. This must be a valid XML Attribute Name. This property is ignored and cannot be changed (the field is disabled) if Render is set to XMLElement, XMLAttribute, or XMLElementAttrVal.

The default value is id.

Namespace String Enter the namespace associated with the ID Attribute.
ID Attribute Value String Specify the value of the attribute used to identify the child. This property is ignored and cannot be changed (the field is disabled) if Render is set to XMLElement, XMLAttribute, or XMLElementAttrVal.

The default value is the identifier of the child.


ad06700_.htm | Last updated 2015-09-24 12:52:12