Header (-HDR)

Use the Header adapter command (-HDR) to receive or include MSMQ message properties with the body of the message. When the message stream includes data other than the message body, the additional data is referred to as the header. To include message properties other than the body of the message, use the header adapter command (-HDR).

-HDR

When the MSMQ Adapter is started without the Header adapter command (-HDR), the data consists only of the body of the message. A sample MSMQ type tree, named msmq_in.mtt, is provided in the examples\adapters\msmq folder. This type tree represents the content of the MSMQ message header properties. This type tree is configured to receive or set all properties and uses property names as identifiers that partition them into proper type groups.

When the MSMQ Adapter is started with the Header adapter command (-HDR) for a data source, the input to the map is automatically formatted as an array of records that includes all properties present in the messages being received, including the body.

When the MSMQ Adapter is started with the Header adapter command (-HDR) for a data target, the adapter searches for property identifiers in the data produced by the map and includes these properties in the MSMQ message output.

When the Header adapter command is specified, the body of the message is treated the same as any other property.

Usage of the Header command (-HDR) requires additional execution time and memory for the adapter to receive or set all of the message properties. Therefore, specifying the header command can affect performance. Performance depends upon the number of properties set on the received message.