Message Sets: XML Wire Format message set properties

The following tables define the properties for the XML Wire Format for the message set.

Namespace settings

Property Type Meaning
Namespace URI String Enter the name of the namespace that you are using for the associated prefix.
Prefix String Enter the prefix to associate the element and attribute names that you use it with to the namespace name.

Namespace schema locations

Property Type Meaning
Namespace URI String Enter the namespace name that identifies which namespace you are using.
Schema location String Enter the location of the schema for the associated namespace name that is used to validate objects within the namespace.

XML declaration

Property Type Meaning
Suppress XML Declaration Check box Select the check box to suppress the XML declaration. If selected, the declaration (for example, <?xml version='1.0'>) is suppressed.

By default, the check box is cleared.
XML Version Enumerated type This controls the value of the version in the generated XML declaration.

The default is 1.0.

If you set Suppress XML Declaration to Yes, this property is ignored.
XML Encoding Enumerated type This controls whether an encoding attribute is written in the generated XML declaration.

If Null is selected, no encoding attribute is written in the XML declaration of the output XML document.

If As document text is selected, an encoding attribute is generated that is consistent with the text in the XML document.

The default is Null.

If the Suppress XML Declaration check box is selected, this property is ignored.
Standalone Document Enumerated type Select Yes, No, or Null from the list of values. If you select Null, no standalone declaration is present in the XML declaration. If you select Yes or No, the declaration standalone = "yes" or standalone = "no" is added to the XML declaration when the output message is written. The default value is Null.

The setting of this property does not determine whether an external DTD subset is loaded; external DTD subsets are never loaded in this release.

If the Suppress XML Declaration check box is selected, this property is ignored.
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 output as attributes of the message in the output XML document. The disadvantage of this option is that, in some cases, unnecessary declarations might be output.
  • As required. Declarations are output 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 output 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
Suppress DOCTYPE Check box If you select the check box, the DOCTYPE (DTD) declaration is suppressed.

By default, the check box is selected.
DOCTYPE System ID String Specify the System ID for DOCTYPE external DTD subset (if DOCTYPE is present). This is typically set to the name of the generated (or imported) DTD for a message set.

If Suppress DOCTYPE is set, this property is ignored and cannot be changed (the field is disabled). The default value is www.mrmnames.net/, followed by the message set identifier.
DOCTYPE Public ID String Specify the Public ID for DOCTYPE external DTD subset (if DOCTYPE is present, and System ID is specified).

If Suppress DOCTYPE is set, this property is ignored and cannot be changed (the field is disabled). The default value is the message set identifier.
DOCTYPE Text String Use this property to add additional DTD declarations. It is not parsed by the XML parser and, therefore, it might not be valid XML. You can include ENTITY definitions or internal DTD declarations. It is a string (up to 32 KB) in which new line and tab characters are replaced by \n and \t respectively.

The content is not parsed, and appears in the output message. If there is an in-line DTD, the content of this property takes precedence.

If you have set Suppress DOCTYPE, this property 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 empty (not set).

XML representation of Boolean values

Property Type Meaning
Boolean True Value String Specify the string that is used to encode and recognize BOOLEAN true values. When an XML document is parsed, the string 1 is always accepted as true for a BOOLEAN element. Enter a string of up to 254 characters.

The default is true. 1 is also valid.
Boolean False Value String Specify the string that is used to encode and recognize BOOLEAN false values. When an XML document is parsed, the string 0 is always accepted as false for a BOOLEAN element. Enter a string of up to 254 characters.

The default is false. 0 is also valid.

XML representation of null values

Property Type Meaning
Encoding Numeric Null Enumerated type Specify the null encoding for numeric XML elements. This provides a method of assigning a logical null meaning to such elements. You must select one of the following values from the list shown:
  • NULLEmpty. If the element value is the empty string, the element is null. This is the default value.
  • NULLValue. If the element value matches that provided by associated property Encoding Numeric Null Value, the element is null.
  • NULLXMLSchema. If the element contains an xsi:nil attribute that evaluates to true, the element is null.
  • NULLValueAttribute. This option is valid only for elements that have XML Wire Format property Render set to either XMLElementAttrVal or XMLElementAttrIDVal. See Message Sets: XML Null handling options for details.
  • NULLAttribute (deprecated). If the element contains an attribute with a name that matches that provided by associated property Encoding Numeric Null Value, and the attribute evaluates to true, the element is null.
  • NULLElement (deprecated). If the element contains a child element with a name that matches that provided by associated property Encoding Numeric Null Value, the element is null.
See Message Sets: XML Null handling options for full details.
Encoding Numeric Null Value String Specify the value to qualify the Encoding Numeric Null property, if you have set that to NULLValue, NULLAttribute, or NULLElement. Refer to Message Sets: XML Null handling options for further information.
Encoding Non-Numeric Null Enumerated type Specify the null encoding for non-numeric XML elements. This provides a method of assigning a logical null meaning to such elements. The options are identical to those available for property Encoding Numeric Null.
Encoding Non-Numeric Null Value String Specify the value to qualify the Encoding Non-Numeric Null property. Refer to Message Sets: XML Null handling options for further information.

DateTime settings

Property Type Meaning
Derive default dateTime format from logical type Button Select this option if you want the default dateTime format to be determined by the logical type of the element or attribute.

You can override this property for an element or attribute within a complex type.
Use default dateTime format Button and String Select this option if you want to specify a default dateTime format that is fixed for all elements or attributes of logical type dateTime, date, time, gYear, gYearMonth, gMonth, gMonthDay, and gDay.

You can override this property for an element or attribute within a complex type.

For more information, see Message Sets: DateTime formats.
Start of century for 2-digit years Integer This property determines how 2-digit years are interpreted. Specify the two digits that start a 100-year window that contains the current year. For example, if you specify 89, and the current year is 2002, all 2-digit dates are interpreted as being in the range 1989 - 2088.
Days in First Week of Year Enumerated Specify the number of days of the new year that must fall within the first week.

The start of a year typically falls in the middle of a week. If the number of days in that week is less than the value specified here, the week is considered to be the last week of the previous year; therefore, week 1 starts some days into the new year. Otherwise, it is considered to be the first week of the new year; in this case, week 1 starts some days before the new year.

Select Use Broker Locale, which causes the integration node to get the information from the underlying platform, or select a number from the list that is displayed.

First Day Of Week Enumerated Specify the day on which each new week starts.

Select Use Broker Locale, which causes the integration node to get the information from the underlying platform, or select a value from the list that is displayed.

Strict DateTime Checking Check box Select this option if you want to restrict dateTimes to a valid dateTime format. If Strict DateTime Checking is selected, receiving an incorrect dateTime causes an error.
Strict dateTime checking
Examples of strict dateTime checking are:
  • DateTimes are restricted to valid dateTimes only. When you use this option, a date such as the 35th March is not processed as 4th April, and 10:79 is not processed as 11:19. Receiving an out-of-band dateTime, such as these examples, causes an error to occur.
  • The number of characters for a numeric dateTime component must be within the bounds of the corresponding formatting symbols. Repeat the symbol to specify the minimum number of digits that you require. The maximum number of digits that is permitted becomes the upper bound for a particular symbol. For example, day in month has an upper bound of 31; therefore, a format string of 'd' allows the values 2 and 21 to be parsed, but does not allow the values 32 and 210. On output, numbers are padded with zeros to the specified length. A year is a special case; see the message set property Start of century for 2 digit years. For fractional seconds, the length must implicitly match the number of format symbols on input. The output is rounded to the specified length.
  • White space is not skipped over. The white space in the input string must correspond with the same number and position of white space in the formatting string.
  • If data remains that is not parsed in the input string after all the symbols in the formatting string have been matched, an error occurs.
Lenient dateTime checking
Examples of lenient dateTime checking are:
  • The parser converts out-of-band dateTime values to the appropriate in-band value. For example, a date of 2005-05-32 is converted to 2005-06-01.
  • Output of dateTimes always adheres to the symbol count. For example, a formatting string of yyyy-MM-dd (where '-' is the field separator) allows one or more characters to be parsed against MM and dd. Therefore, dates that are not valid - for example, 2005-1-123 and 2005-011-12 - can be entered. The first value of 2005-1-123 is output as the date 2005-05-03, and the second value of 2005-011-12 is output as the date 2005-11-12.
  • The number of the timezone formatting symbol Z is applicable only to the output dateTime format.
  • White space is skipped over.
Time Zone Enumerated The value that you set for this property is used if the value that you specified for the Default DateTime Format property does not include Time Zone information.

The initial value is Use Broker Locale, which causes the integration node to get the information from the underlying platform.

You can change this property by selecting from the list of values.
Daylight Saving Time Check box Select this option if the area in the Time Zone property observes daylight saving time. If it does not observe daylight saving time, do not select this option.

For example, if an area is selected in Time Zone and this option is not selected, the value passed represents the time zone without the daylight saving time.
Use input UTC format on output Check box This property applies to elements and attributes of logical type xsd:dateTime or xsd:time that have a dateTime format of I, IU, T, or TU, or that include ZZZ or ZZZU.

Such elements and attributes can specify Coordinated Universal Time (UTC) by using either the Z character or timezone +00:00 in the value. On input, the MRM parser remembers the way that UTC was specified.

If this property is selected, and the element or attribute is copied to an output message, the UTC format is preserved into the output message and overrides the format that is implied by the dateTime format property.

If this property is cleared, or the element or attribute was not copied from an input message, the UTC format in the output message is controlled solely by the dateTime format property.

xsi:type settings

Property Type Meaning
Output policy for xsi:type attributes Enumerated type

When writing XML documents, use this property to specify the circumstances under which the xsi:type attribute of elements is produced as output.

Never
Do not produce xsi:type attributes for elements, even if xsi:type attributes appear in the message tree.
When present
Produce xsi:type attributes for elements only when xsi:type attributes appear in the message tree. This value is the default value.
Always (Simple elements only)
Ensure that all simple elements are produced with an xsi:type attribute. If a simple element already has an xsi:type attribute in the message tree, it is used; otherwise, an xsi:type attribute is generated by using the rules in the following table.
Always (All elements)
Ensure that all elements are produced with an xsi:type attribute if possible to do so. If an element already has an xsi:type attribute in the message tree, it is used; otherwise, an xsi:type attribute is generated by using the rules in the following table.
Follow SOAP Encoding rules
Follow the same behavior as for Always (Simple elements only). Additionally, produce a SOAP encoding-style attribute in the root tag of all messages.

If an xsi:type attribute needs to be produced as output, but does not appear in the message tree, the value is generated as described in the following table.

Element type Value generated when element is defined in model Value generated when element is self-defining
Simple type

If the type is global or is a built-in type, use it.

If the type is local, use the global or built-in type from which it is derived.

Use the built-in type which best matches the data type of the element in the message tree.
Complex type with simple content

If the type is global use it.

If the type is local, use the global or built-in type from which it is derived.

 Use the built-in type which best matches the data type of the element in the message tree.
Complex type with complex content

If the type is global use it.

If the type is local, no xsi:type attribute is produced.

 No xsi:type attribute is produced.

Deprecated

Note: The following properties are used to control behavior of the MRM parser; they should not be changed from their default settings. These properties will be withdrawn in a future release.
Property Type Meaning
Root Tag Name String Specify the name of the message set root tag. You can leave this property blank, in which case no wrapper tags are used for messages (that is, the message tag is the root of the document). The name can be followed by a space and additional text for attribute/value pairs to appear with the root tag.

The default value is blank.
Suppress Timestamp Comment Check box If selected, the timestamp comment string in the XML output is suppressed.

If not selected, the comment is not suppressed, and a comment of the form <!--MRM Generated XML Output on: Tue Apr 23 09:34:42 2002--> is included in the output message.

The default is for the check box to be selected.
Enable Versioning Support Check box If this is selected, versioning support is enabled. This property specifies whether XML namespace definitions are coded for the root tag in the message, together with namespace qualifiers for any elements that do not belong to the default namespace. These namespace definitions are used to represent the message set dependency information, which is used to support the exchange of messages between applications that are based on different customizations of the same message set.

The default is for the check box to be selected, for compatibility with MRM XML messages in earlier releases. If you did not use MRM XML messages in earlier releases, ensure that this check box is not selected.