Listener ASCII format


An ASCII format can be assigned to JMS, MSMQ, TCP, and WMQ listeners. When you enable a listener to receive ASCII character delimited payloads, other parameters become available and must be specified.

The following describes the parameters on the Payload tab when ASCII is selected as a format option.

Data Delimiter

One or more characters used to delimit the data.These characters must be different from the characters used to delimit array elements. The default is a comma ( , ) character.

Map ID Position

The offset position in the message where the listener map definition can be found. The default is zero.

Array Delimiter

One or more characters used to delimit array elements. These characters must be different from the characters used to delimit data. The default is a bar ( | ) character.

Sequence ID Position

The offset position in the message where the message sequence number can be found. The default value is zero.

Encoding

The UTF encoding scheme used to translate the ASCII bytes received.

Termination

This field is only displayed for TCP Listeners. The set of characters that delineate the end of a message sent to the TCP listener. This set of characters is expected to be appended to every message sent to the TCP Listener.

Example termination characters appended to a message:

  • $END$
  • ===END===
  • EOM

If you need to specify control characters as a termination, then specify the characters with a preceding hex notation (0x). For example:

  • To specify the line feed control character as the message termination, enter 0x0a.
  • To specify the carriage return and line feed characters as the message termination, enter 0x0d0x0a.

Example TCP Listener message with termination characters

myListenerMapId,10,20,$END$

Related topics

Listener Payload tab