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


Logical common MRM entities

This file is used as a common entities file for all Logical MRM information.

Details of this text reuse file

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.

General lines

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;
  • - the hyphen
  • _ the underscore
  • . the period

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 Extensible Markup Language (XML) specification that can be found on the World Wide Web Consortium (W3C) Web site.

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:

  • None This value is the default value, and indicates that the element or attribute does not have a key value associated with it.
  • MessageSetIdentity. Specifies that the value of the element or attribute corresponds to the identifier, name, or alias (in that priority order) that is associated with the message set where all subsequent embedded messages that are descendents of the enclosing message are defined. This value remains in force unless a new element or attribute MessageSetIdentity field is encountered which resets the MessageSetIdentity value.
  • MessageIdentity. Specifies that the value of the element or attribute corresponds to the name or alias (in that priority order) that is associated with a message, and acts as an identifier for subsequent embedded messages which are the immediate children of the enclosing message. This identity applies until a new element or attribute MessageIdentity field is encountered at the same level in the tree. The embedded message can be defined in either the current message set, or in a message set identified by using a MessageSetIdentity.
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:

  • Empty
  • sequence. If you select this option, you can define members that are elements or groups. These members, if present, must appear in the specified order in the message. They can repeat, and the same element or group can appear more than once.
  • choice. If you select this option, you can define members that are elements or groups. Exactly one of the defined members must be present in the message, and can repeat.

    Use this option if you want to model C unions and COBOL REDEFINES in a Custom Wire Format, or an XML DTD element that uses choice in an XML Wire Format, or a SWIFT field that has more than one option.

  • all. If you select this option, you can define members that are elements; groups are not allowed. The elements in an all group can appear in any order. Each element can appear once, or not at all. An all group can be used only at the top level of a complex type; it cannot be a member of another group within a type.
  • unorderedSet.

    This option is supported only by the MRM domain.

    If you select this option, you can define members that are elements. The elements can repeat, but the same element cannot appear twice in the list of members. The elements can appear in any order in the message.
  • orderedSet.

    This option is supported only by the MRM domain.

    If you select this option, you can define members that are elements. The elements can repeat, but the same element cannot appear twice in the list of members. The elements must appear in the specified order in the message.
  • message.

    This option is supported only by the MRM domain.

    If you select this option, you can define only messages as members. Each member can repeat, but the same message cannot appear twice in the list of members. Like choice, only one of the defined members can be present in a message.

    Unlike choice, when writing a message, if the complex type or group has more than one member, the bit stream is not padded to the length of the longest member.

    Use this option to model multipart messages, which are used in some industry standards; for example, SWIFT. For more information, see the section on multipart messages in Message Sets: Multipart messages.

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:
  • Closed. The complex type can only contain the child elements that you have added to it.
  • Open Defined. The complex type can contain any valid element defined within the message set.
  • Open. The complex type can contain any valid element, not just those that you have added to this complex type.

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:

  • int
  • string
  • Boolean
  • hexBinary
  • dateTime
  • date
  • time
  • decimal
  • float
  • (More...)
  • (New Simple Type)
  • (New Complex Type)

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 XML Schema Part 0: Primer. This document is available on the World Wide Web Consortium (W3C) Web site.

Type Enumerated type The Type property constrains the type of data that can be present in the object.
Select from the following options:
  • int
  • string
  • Boolean
  • hexBinary
  • dateTime
  • date
  • time
  • decimal
  • float
  • (More...)
  • (New Simple Type)

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 XML Schema Part 0: Primer. This document is available on the World Wide Web Consortium (W3C) Web site.

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.
XMLNSC domain
When parsing with validation enabled, default values are applied to missing attributes and empty elements as required by the XML Schema 1.0 specification. When writing, elements or attributes that are missing from the message tree are not automatically added to the output XML bit stream, even if they have default values. If missing elements or attributes are required, the message tree can be serialized and then re-parsed with validation enabled.
MRM (CWF and TDS physical formats)
When writing a fixed-length portion of a message (CWF or fixed-length TDS), if an attribute or element is missing from the message tree, the default value is inserted into the bit stream so that the message structure is preserved.
MRM (XML physical format)
No support for default values
Other domains
No support for default values.
Fixed Button and String This property provides the fixed value for an element or attribute.
XMLNSC domain
When parsing with validation enabled, if an attribute or element is present, the value is validated against the fixed value. If the values are not equal, a validation error is signalled. Also, when parsing with validation enabled, fixed values are applied to missing attributes and empty elements as required by the XML Schema 1.0 specification. When writing, elements or attributes that are missing from the message tree are not automatically added to the output XML bit stream, even if a fixed value has been specified. If missing elements or attributes are required, the message tree can be serialized and then re-parsed with validation enabled.
MRM (CWF and TDS physical formats)
When writing a fixed-length portion of a message (CWF or fixed-length TDS), if an attribute or element is missing from the message tree, the fixed value is inserted into the bit stream so that the message structure is preserved.
MRM (XML physical format)
No support for fixed values
Other domains
No support for fixed values.
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.
  • Empty
  • restriction. Prohibit element substitution by elements whose types are restrictions of the type of the head element.
  • extension. Prohibit element substitution by elements whose types are extensions of the type of the head element.
  • #all. Prohibit substitution by all methods.
Block Enumerated type Limit the set of elements that can be substituted for this element in a message.
  • Empty
  • restriction. Prohibit element substitution by elements whose types are restrictions of the type of the head element
  • extension. Prohibit element substitution by elements whose types are extensions of the type of the head element
  • substitution. Prohibit element substitution by members of the element's substitution group.
  • #all. Prohibit substitution by all methods.
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:

  • optional.
    • If the Value property is set to default, and no data has been entered in the Value property, the attribute can appear once and can have any value.
    • If the Value property is set to default, the attribute can appear once. If it does not appear, its value is the data that has been entered in the Value property. If it does appear, it is the value given.
    • Where the Value property is set to fixed, the attribute can appear once. If it does appear, its value must match the data that has been entered in the Value property. If it does not appear, its value is the data that has been entered in the Value property.
  • prohibited. The attribute must not appear.
  • required.
    • If the Value property is set to default, and no data has been entered in the Value property, the attribute must appear once and can have any value.
    • If the Value property is set to fixed, the attribute must appear once, and it must match the data that has been entered in the Value property.

Length constraints

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:
  • preserve. If you set the property to preserve, all white space characters including carriage return, line feed, and tab are preserved.
  • replace. If you set the property to replace, all carriage return, line feed, and tab characters are replaced with a space character.
  • collapse. If you set the property to collapse, all carriage return, line feed, and tab characters are replaced with a space character. All adjacent white space characters are then collapsed to a single space character, and leading or trailing spaces are stripped from the data.

Enumerations

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.

Patterns

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.

Inclusive Constraints

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.

Exclusive Constraints

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:
  • strict. The parser can match only against attributes declared in the specified namespace.
  • lax. The parser attempts to match against attributes declared in all accessible namespaces. If the specified namespace cannot be found, an error is not generated.
  • skip. If you select skip, the parser does not perform validation on the attribute.
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:
  • strict. The parser can match only against elements declared in the specified namespace.
  • lax. The parser attempts to match against elements declared in any accessible namespace. If the specified namespace cannot be found, an error is not generated.
  • skip. If you select skip the parser does not perform validation on the element.

adlogent.htm | Last updated 2016-06-25 08:07:43