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


Message Sets: TDS properties for local element binary types

The TDS format properties for local element binary types.

The TDS Format properties described here apply to:

Field Identification

Property Type Meaning
Tag String Specify the value that is used to identify the object in a message bit stream.

If the object is simple and the Data Element Separation property of the complex type or types in which the object is a child is Tagged Delimited, Tagged Fixed Length, or Tagged Encoded Length, this property must contain a non-empty value.

If the object is a complex element, and the Data Element Separation property of its parent is Tagged Delimited, Tagged Fixed Length, or Tagged Encoded Length, the property can contain an empty value.

The value for this property must be unique for every element in the message set; that is, no two elements in the message set can contain the same value for this property.

Data Pattern String Specify the regular expression that the parser uses to identify the data in the message to assign to the object. This property is used when the Data Element Separation method is set to Use Data Pattern in the complex type. For more details, see Message Sets: Regular expression syntax.

Physical representation

Property Type Meaning
Physical Type Enumerated type For all Messaging Standard values, the Physical Type property is set to Binary and cannot be changed.
Length Integer Specify the expected length of the object in length units.

A non-zero length must be specified if no Length Reference is specified.

The default is dependent on the setting of the message set property Derive default length from logical type. If Derive default length from logical type is selected, the default value is derived from any length or maxLength value constraint (schema facet) on the object's simple type.

Length Units Enumerated type Always set to Bytes.
Length Reference Enumerated type This property is applicable only if Physical Type is Text, Binary, or TLOG Specific. If set, this property takes precedence over any value in the Length Units property.

Specify the identifier of a sibling integer object, the value of which determines the length of the object in question. The sibling object must be defined before the current object within the message structure.

For information about reordering elements, see Message Sets: Reordering objects.

Inclusive Length Reference Check box This property is applicable only if Length Reference is set.

If the check box is selected, the value of the sibling integer object that is identified by Length Reference is the length of the current object plus the length of the sibling integer object.

If the check box is not selected, the value of the sibling integer object that is identified by Length Reference is the length of the current object only.

If the check box is selected, the Length Units property of the sibling integer object must be the same as that of the current object.

Occurrences

Property Type Meaning
Repeat reference Enumerated type Use this property if the object occurs multiple times, and the number of occurrences is given dynamically by a field earlier in the message. Select an integer object from the list of integer objects that occur before this object in the structure of the message. The value of the selected integer specifies the number of occurrences of this object. If no objects are listed, no integer objects exist before this one in the message structure.

If a Repeat Reference is specified, it overrides any setting for the Max Occurs logical property when parsing and writing the message, but not for validating the message.

Repeating Element Delimiter String Specify the delimiter to use between repeating elements.

This delimiter is used only when the element repeats and the Data Element Separation property of the parent group or complex type is set to All Elements Delimited or Variable Length Elements Delimited.

A default value is provided if the previous conditions are true; if the messaging standard is HL7, the mnemonic <HL7_RS> is used; if the messaging standard is not HL7, and the maximum number of repeats is fixed, the delimiter of the parent group or complex type is used.

If none of the previous conditions are true, a default is not applied.


ad15560_.htm | Last updated 2015-05-28 20:50:49