WebSphere Message Brokers
File: ad12100_
Writer: Terry Cowling

Reference topic

This build: July 31, 2007 21:24:24

Local element logical properties

Property Type Meaning
Name String Specify a name for the object when you create it.

Names can consist of virtually any alphanumeric character including the letters A through Z, a through z and the digits 0 through 9.

They may also include the following punctuation characters;
  • - the hyphen
  • _ the underscore
  • . the period

Names can only start with a letter or the underscore character and not with a number, hyphen or period.

Names beginning with xml or any variant (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.

Type Enumerated type The Type property constrains the type of data that can be present in the object.

There are a limited number of types available directly from the drop-down selector. These are;

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

If you select (More...), this starts the Type Selection wizard. From this wizard you can select any of the available types.

If you select (New Simple Type), this starts the New Simple Type wizard which allows you to create an Anonymous simple type that is based on an existing type. This can be created locally or globally.

If you select (New Complex Type), this starts the New Complex Type wizard which allows you to create an Anonymous complex type which can be derived from an existing base type. This can be created locally or globally.

For further information about these types, and examples of their use see the XML Schema Part 0: Primer which can be found 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.

Occurrences

Property Type Meaning
Min Occurs Integer Specify the minimum number of times that the object can repeat. The default is 1.

If the value is set to 0, then 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 is 1.

If this property is not set, then the object can not 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.

Value

Property Type Meaning
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 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 this is 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 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 this is 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 if you want the element to be able to be defined as null. This is distinct from being empty where there is no data in the element.
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.

The possible values for this property are:

  • None This is the default value and indicates that the element or attribute does not have any 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 to this new one.
  • 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 may be defined in either the current message set or in a message set identified using a MessageSetIdentity.
Note: This property is only applicable when the type of the object is derived from xsd:string.

Substitution settings

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
Final Enumerated type You use this property to limit the set of elements which may belong to its substitution group.
  • Empty
  • restriction. Prohibit element substitution by elements whose types are restrictions of the head element's type.
  • extension. Prohibit element substitution by elements whose types are extensions of the head element's type.
  • #all. Prohibit substitution by any method.
Block Enumerated type You use this property to limit the set of elements which may be substituted for this element in a message.
Select from:
  • Empty
  • restriction. Prohibit element substitution by elements whose types are restrictions of the head element's type
  • extension. Prohibit element substitution by elements whose types are extensions of the head element's type
  • substitution. Prohibit element substitution by members of the element's substitution group.
  • #all. Prohibit substitution by any method.
Substitution Group Enumerated type Use this property to 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 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.
Related concepts
The message model
Related tasks
Working with message model objects
Related reference
Message model object properties
Logical properties for message model objects
Message model object properties by object
Notices | Trademarks | Downloads | Library | Support | Feedback

Copyright IBM Corporation 1999, 2007Copyright IBM Corporation 1999, 2007. All Rights Reserved.
This build: July 31, 2007 21:24:24

ad12100_ This topic's URL is: