This file is used as a common entities file for all XML MRM information.
This file is used to contain information that is common to the XML layer in the MRM documentation.
The tables below define the properties of objects where they are common for multiple topics. The properties have been grouped together where they appear grouped in the product. The exception is the first table which contains properties used all over the place!
Some tables or sections are used as a whole, but most tables just contain the rows that define the object property. To view the row ID you need to view the table markup. This displays the ID as an attribute.
In most cases there is a single row for a property where there are no differences between where it is used for each object or object type. In other cases there are multiple rows for each property where there are differences in the meaning for a property between each object type. For example, binary, Boolean, and string. Occasionally where this has happened, a common row is defined that contains all the information required, and rows are then built beneath that one that contain links to the specific information for building the description of that property for that type.
Extreme caution should be used when editing this file to ensure that the changes you make only affect those topics that are required to be changed. In some cases, this common information is used in excess of 20 topics.
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:
The default option is At start of document. This property is active only if namespaces are enabled for this message set. |
Property | Type | Meaning |
---|---|---|
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 (_). |
A number of the following properties 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 (output) in the resulting
XML document. Select one of the following values from the drop-down
list:
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. |
Value Attribute Name | String | Specify the name of the attribute used for the value of the child. This must be a valid XML Attribute Name. This is only used if required by the setting of Render. The default value is val. |
Namespace | String | Enter the namespace associated with the Value Attribute. |
Property | Type | Meaning |
---|---|---|
Encoding | String | Select one of the following values from the
drop-down list: :
|
DateTime Format | String | Specify a format string that specifies the rendering
of the value for dateTime elements. The default dateTime format is dependent on the logical type of the object. For information about the defaults for the dateTime format according to the logical type see Message Sets: DateTime defaults by logical type. See Message Sets: DateTime formats for details of dateTime formats. |