Type to start searching...

Message

Properties
aggregation

Child 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”.
sequential

The contained parts must appear in their order of declaration.
random

The contained parts may appear in any order.
single

Only one of the contained parts may appear. This implies a 'choice'.
description : string

Message description.

lax : boolean

True 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.

name : identifier

The message name.

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_]*(:[\p{L}_][\p{L}\p{N}_]*)*

Value must begin with a letter or an underscore. Case and length are not restricted. Letters, numbers and underscores are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.
ref : string

Message 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

  • Sequence of:

    • Parts [0..1] - A message is represented internally (in canonical form) as a tree of parts.

  • Sequence of:

    • Choice of:

      • ObjectMapping [1..1] - Maps message parts to attributes in class instances.

      • FixedMapping [1..1] - Maps message parts to record fields in a fixed length file, or flat file database.

      • JSONMapping [1..1] - Maps message parts to JSON objects, arrays or primitives.

      • AvroMapping [1..1] - Maps message parts to Avro objects, arrays or primitives.

      • HL7Mapping [1..1] - Maps message parts to segments and fields in a Health Level Seven (HL7), v2.x file.

      • CSVMapping [1..1] - Maps message parts to columns in a CSV file.

      • XMLMapping [1..1] - Maps message parts to XML elements, attributes or values.

      • ZipMapping [1..1] - Maps message parts to files in a Zip file archive.

      • VCardMapping [1..1] - Maps message parts to elements in a vCard file.

      • Mapping [1..1]

Parents
Parent topic: Messages