MQHeader node
Use the MQHeader node to add, modify, or delete MQ Message Descriptor (MQMD) and MQ Dead Letter Header (MQDLH) headers.
- Developer
- Application Integration Suite
- Standard
- Advanced
- Express
- Scale
The MQHeader node requires access to WebSphere® MQ, so you must install it in addition to IBM® Integration Bus if you require the capabilities provided by this node. For more information about using WebSphere MQ with IBM Integration Bus, see Installing WebSphere MQ.
This topic contains the following sections:
Purpose
The MQHeader node is contained in the WebSphere MQ drawer of the palette, and is represented in the IBM Integration Toolkit by the following icon:
Terminals and properties
MQHeader 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. |
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).
Property | M | C | Default | Description |
---|---|---|---|---|
Node name | No | No | MQHeader | 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. |
Property | M | C | Default | Description | mqsiapplybaroverride command property |
---|---|---|---|---|---|
MQMD header options | No | No | Carry forward header | Options to control the MQMD 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.
|
|
Coded Character Set Identifer | No | No | MQCCSI_Q_MGR | The character set identifier of character data
in the message. A sample set of custom literals for EBCIDIC and
other common Unicode values is given here: MQCCSI_INTL_EBCIDIC : 500
Refer to the WebSphere MQ Application Programming Reference and WebSphere MQ Application Programming
Guide for full details. MQCCSI_US_EBCIDIC : 037 MQCCSI_UNICODE_1200 : 1200 MQCCSI_UNICODE_1208 : 1208 MQCCSI_UNICODE_13488 : 13488 MQCCSI_UNICODE_17584 : 17584 |
|
Format | No | No | MQFMT_NONE | A name that the sender of the message can use to indicate to the receiver the nature of the data in the message. | |
Version Number | No | No | MQMD_VERSION_1 | The version ID of the MQMD message. | |
Message Type | No | No | MQMT_DATAGRAM | The message type. | |
Message Expiry | No | No | MQEI_UNLIMITED | A period of time expressed in tenths of a second, set by the application that puts the message. The message becomes eligible to be discarded if it has not been removed from the destination queue before this period of time elapses. | |
Feedback or Reason Code | No | No | MQFB_NONE | Used with a message of type MQMT_REPORT to indicate the nature of the report, and meaningful only with that type of message. | |
Message Priority | No | No | MQPRI_PRIORITY_AS_Q_DEF | Message priority. 0 is the lowest value, and 9
is the highest. Custom display literals are as follows: MQPRI_PRIORITY_HIGH : 9
MQPRI_PRIORITY_8 : 8 MQPRI_PRIORITY_7 : 7 MQPRI_PRIORITY_6 : 6 MQPRI_PRIORITY_5 : 5 MQPRI_PRIORITY_MEDIUM : 4 MQPRI_PRIORITY_3 : 3 MQPRI_PRIORITY_2 : 2 MQPRI_PRIORITY_1 : 1 MQPRI_PRIORITY_LOW : 0 |
|
Message Persistence | No | No | MQPER_PERSISTENCE_AS_Q_DEF | Indicates whether the message survives system failures and restarts of the queue manager. | |
Message Identifier | No | No | MQMI_NONE | A string that is used to distinguish one message from another. | |
Correlation Identifier | No | No | MQCI_NONE | A string that the application can use to relate one message to another, or to relate the message to other work that the application is performing. | |
Reply To Queue | No | Yes | <No default value> | The message queue to which the application that issued the get request for the message should send Reply and Report messages. | mqmdReplyToQ |
Reply To Queue Manager | No | Yes | <No default value> | The queue manager to which the reply message or report message should be sent. | mqmdReplyToQMgr |
Property | M | C | Default | Description |
---|---|---|---|---|
Inherit from header | No | No | Selected | This property is enabled only when the Modify header option is selected. Select this field to inherit any MQMD report property value that is present in an incoming message. |
Exception | No | No | No default value | A type of MQ report message. Exception report message is generated. |
Expiration | No | No | No default value | A type of MQ report message. Expiration report message is generated. |
Confirm on arrival | No | No | No default value | A type of MQ report message. Confirm on arrival report message is generated. |
Confirm on delivery | No | No | No default value | A type of MQ report message. Confirm on delivery report message is generated. |
Notification | No | No | No default value | A type of MQ report Message. Action notification report message is generated. |
Property | M | C | Default | Description | mqsiapplybaroverride command property |
---|---|---|---|---|---|
MQDLH header options | No | No | Carry forward the header | Options to control the MQMD 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.
|
|
Coded Character Set Identifer | No | No | MQCCSI_UNDEFINED | The character set identifier of character data in the message. | |
Format | No | No | MQFMT_NONE | A name that the sender of the message can use to indicate to the receiver the nature of the data in the message. | |
Reason | No | No | MQRC_NONE | A code that indicates why the message is sent to the dead letter queue (DLQ). | |
Destination Queue Name | No | Yes | No default value | The name of the destination queue. | mqdlhDestQName |
Destination Queue Manager Name | No | Yes | No default value | The name of the destination queue manager. | mqdlhDestQMgrName |
Save dead letter queue | No | No | Selected | If selected, the dead letter queue name is stored in the local environment. | |
Save source queue | No | No | Selected | If selected, the original source queue name is stored in the local environment. | |
Put Application Name | No | No | The name of the application that put the message on the dead-letter queue. | This property is set to WebSphereMQIntegrator and appended with the broker major version number, for example: WebSphereMQIntegrator9. |
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. |