Local attribute 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.

Value

The Value properties are used in conjunction with the Usage property in an Attribute Reference or a Local Attribute.

Property Type Meaning
Default Button and String This property provides the default value for an element or attribute.

When writing a fixed-length portion of a message (CWF or fixed-length TDS) if the attribute or element is missing from the message tree, the default value is inserted into the bit stream in order to preserve the message structure.

This property is not used by the message broker when parsing.

Note that this behavior differs from the XML Schema specification.

Fixed Button and String This property provides the fixed value for an element or attribute.

If a Fixed value is set for an attribute or element and a message is received, if the attribute or element exists in the message, the data in that part of the message must match that held in this property.

If the attribute or element does not exist in the message, the broker creates it and populates it with the value in this property.

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.

Usage properties

Property Type Meaning
Usage Enumerated type The usage property is used in conjunction with the Value property found in an attribute object. The default for the Usage property is optional.

Select from;

  • optional.
    • Where 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.
    • Where 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.
    • Where 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.
    • Where 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.
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