Skip to main content Skip to complementary content
Close announcements banner

ReadMessage

Reads a message from an enclosing ESB into a map element.

The ReadMessage function may be used only as an I/O expression. Specify it as the I/O expression of the element to contain the data to be read. The contents of message are read during the map execution populating the values of the element containing the I/O expression and any subordinate elements.

Reading Message Properties - if you want to access properties that are associated with the message, they can be read into map elements. To do this the first child map element must specify the ReadMessageProperties I/O function, inherit from the /Builtin/Structures/Properties structure, and must be a loop. When the message is read, the property elements of this structure are populated with the property names and values.

You may use this function in multiple map elements in order to read multiple messages. You may not however nest the use of this function. In other words, if a map element contains an I/O expression, no subordinate map element may contain an I/O expression.

This function can only be used in the IO/Database tab.

Arguments

Start Offset Specify the byte offset for the element. If not specified, the offset is 0.
Length Specify the number of bytes to read in the element. If not specified, all of the bytes are read.

Properties

Representation Select the representation to use when processing this element. This is used if multiple representations are available in the structure inheriting this element.
Endpoint Enter the endpoint name that is meaningful to the enclosing ESB to identify where to get the message.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!