Type to start searching...

ObjectMapping

Maps message parts to attributes in class instances.

Properties
access : identifier

Update access attribute. If its value is false, the update to the attribute or (or the whole instance for a root part) will be skipped.

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.

associationCode : string

The association code identifies child transfer objects.

attribute

Attribute to which the part is mapped.

Valid values based on“string”.
[\p{L}_][\p{L}\p{N}_]*|:[\p{L}_][\p{L}\p{N}_-]*
class : identifier

Class to which the part is mapped.

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.

create : boolean

True to create a missing instance, false to generate an error.

delete : boolean

If true, all unmatched instances of the underlying collection attribute will be deleted

key : boolean

True if the value is used as lookup key for the parent part instance.

local : boolean

True to lookup the instance only within the subcollection scoped by the parent part instance. Defaults to the opposite of the "key" flag.

primary : boolean

True if this message is the primary message in the hierarchy for a given class.

A hierarchy of messages can contain multiple messages with the same class. If this is the case, when selecting a message to use to parse a given class, the primary flag serves to disambiguate which message should be used. Valid only on mapping on message root.
subkey : boolean

True if the value is used as a lookup key for the parent part instance, which in turn is a lookup key for the grand-parent part instance.

truncate : boolean

If true, the underlying attribute value will be truncated to fit within the maximum length.

update : boolean

If false, the underlying attribute will not be updated on an already existing instance.

where : string

Additional lookup where clause.

Parents
  • Value - A value (or primitive) message part.
  • Message - A message (or composite) message part.
  • Message
  • Message - A message carries information from a source system to a destination system over an integration channel.