Local group logical properties

Valid children in a local group that depend on both Composition and Content Validation are shown in Content Validation properties for complex types.

Property Type Meaning
Composition Enumerated type The following only applies to the element content of a complex type and has no effect on the attribute content of a complex type. Select from:
  • Empty
  • sequence. If you select this option, you can define children that are elements or groups. These children, if present, must appear in the specified order. They can repeat and can be duplicated.
  • choice. If you select this option, you can define children that are elements or groups. Only one of the defined children of the complex type can be present, but repeating children are allowed.

    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. The elements in an all group can appear in any order. Each element can appear once, or not at all. An all group can only contain elements - groups are not allowed. An all group can only be used at the top level of a complex type - it cannot be a member of another group within a type.
  • unorderedSet. If you select this option, you can define only elements as children. The elements can repeat but cannot be duplicated. Child elements can appear in any order.
  • orderedSet. If you select this option, you can define only elements as children. These elements, if present, must appear in the specified order, and they can repeat but cannot be duplicated. This is the default value for new complex types.
  • message. If you select this option, you can define only messages as children. They can repeat, but they cannot be duplicated. Like choice, only one of the defined children can be present.

    If the complex type includes more than one message, the bit stream contains the exact length of the embedded message, and is not padded to the length of the longest.

    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 Multipart messages.

Content Validation Enumerated type Content Validation controls how the broker responds to undeclared content and specifies where the objects that are included within the complex type are defined, if at all. It is used in combination with the Composition property.
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 Combinations of Composition and Content Validation for further details of these options.

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.

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