Breadcrumbs

t_Message_Parts_Message

Message : Message Part

A message (or composite) message part.

Description A message part is also known as a composite message part. It is a sub-message that can have it's own child parts. It shares it's format type with the message's root part but it has its own mapping that defines how it is marshalled between internal and external format. Properties

aggregationChild part aggregation mode.Child parts must appear in the order specified (sequential), in any order (random) or only one choice of the children may appear (single). When "ref" is set, the aggregation from the referenced message part is used and the aggregation on the reference is ignored.Valid values based on“string”.sequentialThe contained parts must appear in their order of declaration.randomThe contained parts may appear in any order.singleOnly one of the contained parts may appear. This implies a 'choice'.description : stringMessage description.lax : booleanTrue to allow and ignore unidentifiable child parts in a raw message when parsing.Lax is mainly used during message parsing. Set it to true to allow and ignore unidentifiable child parts in a raw message when parsing. If lax is false - the default - the parser will throw an error if it encounters a message part that is not in the message definition, like an extra XML attribute or a CSV column. When "ref" is set, the lax setting from the referenced message part is used and the lax setting on the reference is ignored. Example For an RSS message definition, you probably want to set the root tag to "lax" as most RSS feeds have custom attributes added to their XML.  If a custom attribute was found in a message that your message definition didn't expect and the "lax" flag was false, the message would be rejected.maxCount : nonNegativeIntMaximum count of occurrences of this part (0 for unlimited).Valid values based on“int”.0 (minInclusive)minCount : nonNegativeIntMinimum count of occurences of this part.Valid values based on“int”.0 (minInclusive)name : messagePartIdentifierPart name, unique within the parent part.Valid values based on“string”.:?[\p{L}_][\p{L}\p{N}\.\-_]*(:[\p{L}_][\p{L}\p{N}\.\-_]*)*Value must begin with a letter, colon, or an underscore. Case and length are not restricted. Letters, numbers, underscores, dashes, colons and periods are allowed. Spaces and other punctuation characters are not allowed.ref : stringMessage defining this part (and any subparts). If the ref is set to another message name, then this part will be defined by the structure of that message.

Content


Parents

  • t_Message_Parts - A message is represented internally (in canonical form) as a tree of parts.

Parent topic: t_Message_Parts