Field identification.
The XML Wire Format properties described here apply to:
- Objects: Compound elements
Field identification
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:
- 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 Nameproperty
to the same value, both objects must refer to the same element.
This
is the default value for element objects.
- XMLAttribute.
If you select this value, the object (or type) is rendered as an attribute
of the parent XML object. The identity of the child is determined
by the attribute name. The value is the attribute value. This is only
valid for simple elements.
If you select this value for more than
one object , you must set their XML
Name property to different values.
This is the
default value for attribute 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.
- XMLElementAttrVal.
If you specify 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 value
of a specified attribute. The name of the attribute is specified in Value Attribute Name.
- XMLElementAttrIDVal.
This option combines the two options, XMLElementAttrID and XMLElementAttrVal. The object
is rendered as a child of the parent complex type. The identity of
the child is determined by the value of ID Attribute Name. The value
is the value of ID Attribute Value.
If
you select this value for one object, and set this same value or the
value XMLElementAttrID 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.
|
| 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. |