JMSHeader node

Use the JMSHeader node to modify contents of the JMS Header_Values and Application properties so that you can control the node's output without programming.

The JMSHeader node is available in the following operation modes:

Developer
Application Integration Suite
Standard
Advanced
Express
Scale

For more information, see Operation modes.

This topic contains the following sections:

Purpose

Use the node to control the output from a JMSOutput node. A subset of common values can be changed in the JMS Header, and user-chosen properties can be added, changed, or deleted for the Application properties.

For JMS Header_Values properties, the node provides a set of fields that you can modify using predefined values, user-defined values, or XPath expressions. XPath is used to provide a valid location from which a value for a property can be copied. For example, the location can be the body of the message, the local environment tree, or an exception list.

For JMS Application properties, the node provides a way to add, modify, and delete name-value pairs of application properties.

The JMSHeader node is contained in the JMS drawer of the palette, and is represented in the IBM® Integration Toolkit by the following icon:

Terminals and properties

When you have put an instance of the node into a message flow, you can configure it; see Configuring a message flow node. This node has no mandatory properties.

JMSHeader node terminals are described in the following table:

Terminal	Description
In	The input terminal that accepts a message for processing by the node.
Failure	The output terminal to which the input message is routed if a failure is detected during extraction.
Out	The output terminal to which the transformed message is routed if the input message is processed successfully.

The following tables describes the node properties. The column headed M indicates whether the property is mandatory (marked with an asterisk if you must enter a value when no default is defined); the column headed C indicates whether the property is configurable (you can change the value when you add the message flow to the BAR file to deploy it).

The JMSHeader node Description properties are described in the following table:

Property	M	C	Default	Description
Node name	No	No	JMSHeader	The name of the node.
Short description	No	No		A brief description of the node.
Long description	No	No		Text that describes the purpose of the node in the message flow.

The JMSHeader node JMS transport header options are described in the following table:

Property	M	C	Default	Description
JMS header options	No	Yes	Carry forward header	Options to control the JMSTransport header as a whole. Select Carry forward header to carry forward any values that are present in an incoming message. Select Add header to add a new header using the specified property values. If a header already exists, the header is modified using the specified property values. If Inherit from header is specified as a property value and the header does not exist, the default value for the property is used. Select Modify header to change an existing header using the specified property values. If a header does not exist, a new header is added first. If Inherit from header is specified as a property value and the header does not exist, the default value for the property is used. Select Delete header to delete the header, if it exists. Note: The Add header and Modify header options both add a header if it does not exist, and change a header if it does exist. However, the default values offered by each option differ, so use the appropriate option.

Property

Default

Description

JMS header options

Yes

Carry forward header

Options to control the JMSTransport header as a whole.

Select Carry forward header to carry forward any values that are present in an incoming message.

Select Add header to add a new header using the specified property values. If a header already exists, the header is modified using the specified property values. If Inherit from header is specified as a property value and the header does not exist, the default value for the property is used.

Select Modify header to change an existing header using the specified property values. If a header does not exist, a new header is added first. If Inherit from header is specified as a property value and the header does not exist, the default value for the property is used.

Select Delete header to delete the header, if it exists.

Note: The Add header and Modify header options both add a header if it does not exist, and change a header if it does exist. However, the default values offered by each option differ, so use the appropriate option.

The JMSHeader node JMSHeader_Value properties are described in the following table:

Property	M	C	Default	Description	mqsiapplybaroverride command property
JMS Delivery Mode	No	Yes	Non _Persistent	Filter messages by message delivery mode: Non_Persistent Persistent
JMS Message Expiration(ms)	No	Yes	0	Ask the JMS provider to keep the output JMS message for a specified time. Values are in milliseconds; the default value 0 means that the message should not expire.
JMS Message Priority	No	Yes	4	Assign relative importance to the message. A receiving JMS client application or a JMSOutput node can use this value. JMS defines a ten-level priority value, with 0 as the lowest priority and 9 as the highest.
JMS Correlation Identifier	No	Yes	No default value	A client can use the JMS Correlation Identifier header field to link one message with another. A typical use is to link a response message with its request message.
JMS Reply To	No	Yes	No default value	The JMS Reply To header field contains a destination supplied by a client when a message is sent. It is the destination where a reply message should be sent to.	jmsReplyTo

The JMSHeader node Application properties are described in the following table:

Property	M	C	Default	Description
Application Properties	No	Yes		This screen is enabled only if you chose Add header or Modify header for JMS Transport header. The screen has no predefined properties; you use it to create custom properties and values. Use the property table to add new properties, or modify or delete existing properties, for the header. There is no limit to the number of properties. Each property must have a name, and a type qualifier. The type qualifier can be `Value`, `XPath`, or `Delete`. Value Enter a new valid value for the selected property. A null value or empty string is also considered as a valid value. XPath Specify a valid XPath expression. IBM Integration Bus supports XPath definitions that start with an XPath variable such as `$Root` or `$LocalEnvironment`. Only the first occurrence is returned if there are multiple values for the XPath expression. (Examples of valid XPath expressions are: $LocalEnvironment/Host, and $Root/HTTPRequest/Content-Type). Delete Specify the property to be deleted from the incoming message. The value associated with the selected property is also deleted.
Clear incoming values	No	Yes	Cleared	This option, which is is enabled only if you choose Modify header, removes all property names and associated values from the incoming message if present.

The Monitoring properties of the node are described in the following table.

Property	M	C	Default	Description
Events	No	No	None	Events that you have defined for the node are displayed on this tab. By default, no monitoring events are defined on any node in a message flow. Use Add, Edit, and Delete to create, change or delete monitoring events for the node; see Configuring monitoring event sources by using monitoring properties for details. You can enable and disable events that are shown here by selecting or clearing the Enabled check box.