This file is used as a common entities file for all Logical MRM information.
This file is used to contain information that is common to the logical 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 see the row ID, 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.
Substitution Groups provide a means by which one element may be substituted for another in a message. The element which can be substituted is called the 'head' element, and the substitution group is the list of elements that may be used in its place. An element can be in at most one substitution group.
Property | Type | Meaning |
---|---|---|
Name | String | Specify a name for the object when you create
it. Names can consist of alphanumeric characters, including the letters A through Z, a through z, and the digits 0 through 9. They might also include
the following punctuation characters;
Names can start only with a letter or the underscore character, and not with a number, hyphen, or period. Names that begin with xml, or any variant of these characters (for example XmL), are reserved by the XML standards specification. Further details
of naming conventions and allowable characters can be found in the |
Interpret Value As | Enumerated type | Specify if values stored within this object
must be interpreted as having significance for the parser and, if
so, the type of interpretation that must occur. Select one of the following options:
Note: This property is applicable only when the type of the object
is derived from xsd:string.
|
Composition | Enumerated type | Define the order, and the number of occurrences, of the elements and groups in your messages. Composition does not affect the attributes in a complex type. Select from the following options:
|
Content Validation | Enumerated type | Content Validation is used only by the MRM domain. If validation is enabled in your message flow, Content Validation specifies the strictness of the MRM validation for members of a complex type or group. See MRM content validation for further details. Select from the following options:
See Message Sets: Combinations of Composition and Content Validation for further details of these options. |
Min Occurs | Integer | Specify the minimum number of times that the object can repeat. The
default value is 1.
If the value is set to 0, the object is optional. With the exception of Max Occurs being set to -1, if a value is set for Min Occurs, it must be less than or equal to the value in Max Occurs. |
Max Occurs | Integer | Specify
the maximum number of times that the object can repeat. The default
value is 1. If this property is not set, the object cannot occur more than once. If this property is set to 0, it is interpreted as if the object does not exist in the message. It can also be set to -1, to indicate that the limit is unbounded and there is no maximum to the number of occurrences. |
Min Occurs | Integer | Specify the minimum number of times that the object can repeat. The
default value is 1.
If the value is set to 0, the object is optional. With the exception of Max Occurs being set to -1, if a value is set for Min Occurs, it must be less than or equal to the value in Max Occurs. |
Max Occurs | Integer | Specify
the maximum number of times that the object can repeat. The default
value is 1. If this property is not set, the object cannot occur more than once. If this property is set to 0, it is interpreted as if the object does not exist in the message. It can also be set to -1, to indicate that the limit is unbounded and there is no maximum to the number of occurrences. |
Type | Enumerated type | The Type property constrains
the type of data that can be present in the object. Select from the following options:
If you select (More...), the Type Selection wizard starts. In this wizard, you can select any of the available types. If you select (New Simple Type), the New Simple Type wizard starts. In this wizard, you can create an Anonymous simple type that is based on an existing type. This type can be created locally or globally. If you select (New Complex Type), the New Complex Type wizard starts. In this wizard, you can create an Anonymous complex type, which can be derived from an existing base type. This type can be created locally or globally. For further information about
these types, and examples of their use, see the |
Type | Enumerated type | The Type property constrains the type of data
that can be present in the object. Select from the following options:
If you select (More...), the Type Selection wizard starts. In this wizard, you can select any of the available types. If you select (New Simple Type), the New Simple Type wizard starts. In this wizard, you can create an Anonymous simple type that is based on an existing type. This type can be created locally or globally. For
further information about these types, and examples of their use,
see the |
Namespace | Enumerated type | Namespaces are a simple method for qualifying
element and attribute names by associating them with namespaces identified
by URI references. If <no target namespace> is displayed, a namespace has not been set for this object. If the property is inactive, the message set has not been configured to support namespaces. Where the property is active, namespaces that are available for selection are displayed in the drop-down list. |
Namespace | String | Namespaces are a simple method for qualifying
element and attribute names by associating them with namespaces identified
by URI references. This field is initially blank. |
Default | Button and String | This property provides the default value for
an element or attribute.
|
Fixed | Button and String | This property provides the fixed value for an
element or attribute.
|
Nillable | Check box | Select this option if you want the element to be able to be defined as null. A null value is distinct from being empty, when the element contains no data. |
Final | Enumerated type | Limit the set of elements that can belong to
its substitution group.
|
Block | Enumerated type | Limit the set of elements that can be substituted
for this element in a message.
|
Substitution Group | Enumerated type | Specify the name of a 'head' element. Setting this property indicates that this element is a member of the substitution group for the head element. |
Abstract | Check box | Select this option if you do not want the element to appear in the message, but require one of the members of its substitution group to appear in its place. |
Property | Type | Meaning |
---|---|---|
Reference Name | Enumerated type | The Reference Name is the name of the object that this object is referring to. The objects available to reference can be selected from the list. |
Property | Type | Meaning |
---|---|---|
Usage | Enumerated type | Use this property with the Value property found in an attribute
object. The default value for the Usage property
is optional. Select from the following options:
|
Property | Type | Meaning |
---|---|---|
Length | Integer | Specify the exact length of the simple type
in bytes or characters. The value must be greater than 0, and less than 2147483648. |
Min | Integer | Specify the minimum length of the simple type
in bytes or characters. The value must be greater than 0, and less than 2147483648. |
Max | Integer | Specify the maximum length of the simple type
in bytes or characters. The value must be greater than 0, and less than 2147483648. |
Property | Type | Meaning |
---|---|---|
White Space | Enumerated type | Set this property to control the processing
of white space characters received for this type. Select one of
the following values:
|
Property | Type | Meaning |
---|---|---|
Enumerations | String | Set this property to constrain the values to
the list that is specified in this property. For example, you might
create a simple type called RainbowColors, and add Red, Orange, Yellow, Green, Blue, Indigo, and Violet to the enumerations
list. You must ensure that you have all variations of the data that you are likely to receive in the message defined in the list. For example, Yellow, yellow, yel, and y might be variations of a single color. Select Add to add a default enumeration. Overtype the default with the data you require. To change an entry, select the entry, and click on the entry a second time (as distinct from double-click). You can now update the selected entry. |
Property | Type | Meaning |
---|---|---|
Patterns | String | Patterns are
a regular expression, or a series of regular expressions, that are
used to constrain the data within the simple type. For further information
about patterns and their syntax see Message Sets: Using regular expressions to parse data elements. Select Add to add a default pattern. Overtype the default with the data you require. To change an entry, select the entry, and click on the entry a second time (as distinct from double-click). You can now update the selected entry. |
Property | Type | Meaning |
---|---|---|
Min | Integer | Specify the minimum value for which the data
in the message must be greater than, or equal to. When this value is set, it cannot be equal to, or greater than, the Max Inclusive Constraint property. You cannot specify both Min Inclusive Constraint and Min Exclusive Constraint properties together for the same simple type. |
Max | Integer | Specify the maximum value for which the data
in the message must be less than, or equal to. When this value is set, it cannot be equal to, or less than, the Min Inclusive Constraint property. You cannot specify both Max Inclusive Constraint and Max Exclusive Constraint properties together for the same simple type. |
Property | Type | Meaning |
---|---|---|
Min | Integer | Specify the minimum value for which the data
in the message must be greater than. When this value is set it cannot be equal to, or greater than, the Max Inclusive Constraint property. You cannot specify both Min Inclusive Constraint and Min Exclusive Constraint properties together for the same simple type. |
Max | Integer | Specify the maximum value for which the data
in the message must be less than. When this value is set, it cannot be equal to, or less than, the Min Inclusive Constraint property. You cannot specify both Max Inclusive Constraint and Max Exclusive Constraint properties together for the same simple type. |
Property | Type | Meaning |
---|---|---|
Fraction Digits | Integer | Set this property to limit the number of digits
in the fraction part of a numeric value to the number of digits
specified in this property. The value must be greater than, or equal to, 0, and less than 2147483648. The value set for Fraction Digits cannot be greater than the value specified for Total Digits. |
Property | Type | Meaning |
---|---|---|
Total Digits | Integer | Set this property to set the maximum number
of digits in a numeric value to the number of digits specified in
this property. The value must be greater than, or equal to, 0, and less than 2147483648. The value set for Total Digits cannot be less than the value specified for Fraction Digits. |
Property | Type | Meaning |
---|---|---|
Process Content | Enumerated type | If a message contains an attribute that corresponds
to a wildcard in the message model, Process
Content defines how the attribute is validated. Select
one of the following options:
|
Property | Type | Meaning |
---|---|---|
Process Content | Enumerated type | If a message contains an element that corresponds
to a wildcard in the message model, Process
Content defines how the element is validated. Select one
of the following options:
|