MQOutput node
Use the MQOutput node to send messages to client applications using the IBM® MQ Enterprise Transport.
This topic contains the following sections:
Purpose
The MQOutput node delivers an output message from a message flow to an IBM MQ queue.
On distributed systems, you can configure the MQOutput node to put a message to an IBM MQ queue on any local or remote queue manager, or to the destinations identified in the local environment associated with the message. You can either specify the queue manager explicitly by setting the MQ Connection properties on the MQOutput node, or specify an MQEndpoint policy on the Policy tab.
If the integration server has a queue manager associated with it, then the MQ message flow node by default connects to that queue manager with server bindings. If you configure properties on the MQ Connection tab, then these properties will be used to connect to the specified queue manager. If you specify an MQEndpoint policy, then the values in the policy will be used instead of the values that are defined in the MQ Connection tab. If an MQEndpoint policy is specified, the values of properties that are set in the MQEndpoint policy are used at run time instead of any corresponding values that are set on the MQ Connection tab. All MQ nodes that do not have connection properties set and do not have an MQEndpoint policy specified will use the connection details of the queue manager that is associated with the integration server at run time. If no queue manager was specified for the integration server, the message flow cannot deploy. For more information, review the MQ Connection and Policy property tables in this topic.
You can connect to a secured local or remote queue manager by using the Security identity property on the MQOutput node to pass a user name and password to the queue manager. The identity is defined using the mqsisetdbparms command. You can use the Security identity property to provide the security credentials on local and client connections, but it is not available for client connections that use a client channel definition table (CCDT). You can also choose whether to use the SSL protocol when a client connection is made to a remote queue manager. Select the Use SSL property on the MQOutput node to provide confidentiality on the client connection by using SSL. You can also set this property through an MQEndpoint policy. For more information about using security identities and SSL, see Connecting to a secured IBM MQ queue manager.
You can define the queue as an IBM MQ clustered queue or shared queue. When you are using an IBM MQ clustered queue, if you leave the Object Queue Manager property empty, the cluster will route the message to an appropriate queue manager in the cluster.
The MQOutput node checks for the presence of an MQMD (IBM MQ message descriptor) header in the message tree. If no MQMD header is present, the MQOutput node creates one in the message tree, and populates it with MQMD default properties. If an MQMD header is found, the MQOutput node checks that it is an IBM MQ type header; if it is not, the Message Context property is set to Default. For information about the content of fields in MQMD, see Contents of the IBM MQ reply message.
The MQOutput node treats any other transport headers in the message tree as data. If such headers are not required as part of the message body, use a transformation node to remove them from the message tree before the MQOutput node. If the message tree is sourced from JMS, you can use a JMSMQTransform node to construct a message tree compatible with MQ. For further details, see JMS message transformation.
The MQOutput node is contained in the IBM MQ drawer of the palette, and is represented in the IBM App Connect Enterprise Toolkit by the following icon:
Using this node in a message flow
For an example of how to use this node, assume that you have written a publishing application that publishes stock updates on a regular basis. The application sends the messages to the integration server on an MQInput node, and the message flow makes the publications available to multiple subscribers through a Publication node. You configure a Compute node to create a new output message whenever one particular stock is changed, and connect this node to an MQOutput node to record each price change for this stock.
Working with WrittenDestination data
WrittenDestination = (
MQ = (
DestinationData = (
queueName = 'OUT'
queueManagerName = 'MYQUEUEMANAGER'
replyIdentifier = X'4d...2e'
msgId = X'3c...2c'
correlId = X'2a...00'
GroupId = X'3a...00'
bindingType = 'CLIENT' (CHARACTER)
destinationQueueManager = 'QM1_REG1' (CHARACTER)
queueManagerHostname = 'MYQUEUEMANAGERHOSTNAME' (CHARACTER)
listenerPortNumber = 9000 (INTEGER)
channelName = 'MYCHANNELNAME' (CHARACTER)
)
)
)
Behavior of a node that adds a request to a group
When a supported node successfully processes a message for output, it adds the information about the request that was just sent to the group that was most recently created in the message flow. The reply ID that the group expects is determined automatically from the transport, and the folder name is taken from the Folder name attribute.
Overrides
By default, the output node adds the request to the most recently created group. If multiple groups are being constructed in the same thread, a local environment override can be used to specify the group ID of the target group: LocalEnvironment.Destination.GroupScatter.RequestNode.GroupId. Requests can only be added to a group that is in construction in the current message flow thread. An exception is issued if no such group is available.
Transactions
Where a transport is transactional, the message obeys the usual transactional rules for the given transport. However, the group information is updated outside of the scope of the transaction. Therefore, if the transaction and output message are rolled back, the request is still added to the group.
Error
If Add Request to Group is true, and Folder name is blank, a configuration exception is issued. The thread context is used to determine which group to add a request to.
If Add Request to Group is true but no group is in construction in this thread, an exception is issued.
If a group ID override is specified and the ID is invalid, or does not correspond to a group that is in construction in the current thread, an exception is issued.
Connecting the terminals
Connect the In terminal to the node from which outbound messages are routed.
Connect the Out or Failure terminal of this node to another node in this message flow to process the message further, process errors, or send the message to an additional destination.
If you use aggregation in your message flows, you must use the output terminals.
Terminals and properties
When you add an MQOutput node to a message flow, you can use the Properties view in the Message Flow editor to configure it. To display field help, click within a field, and then click the information icon that is displayed at the beginning of the field. All mandatory properties that do not have a default value defined are marked with an asterisk. For general configuration information see Configuring a message flow node.
You can create and attach policies to control particular connection properties for this type of node at run time (see MQEndpoint policy).
The following tables describe the node terminals and the node properties that you can set on a specified tab in the Properties view in the Message Flow editor. 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).
Table of node terminals
Terminal | Description |
---|---|
In | The input terminal that accepts a message for processing by the node. |
Failure | The output terminal to which the message is routed if a failure is detected when the message is put to the output queue. |
Out | The output terminal to which the message is routed if it has been successfully put to the output queue. |
Tables of node properties
Property | M | Default | Description |
---|---|---|---|
Node name | No | The node type, MQOutput | The name of the node. |
Short description | No | A brief description of the node. | |
Long description | No | Text that describes the purpose of the node in the message flow. |
Property | M | Default | Description |
---|---|---|---|
Queue name | No | To send the output message to a single destination
queue that is defined by this node, enter the name of the IBM MQ output queue to which the message
flow sends messages. If you set the Destination Mode property to Queue Name, you must specify a value for the Queue Name property. If you set Destination Mode to another value, this property is ignored. |
Property | M | Default | Description |
---|---|---|---|
Connection | No | Local queue manager | This property specifies how a connection is
made to IBM MQ:
Valid values for mqsiapplybaroverride are SERVER, CLIENT, and CCDT. |
Destination queue manager name | No | This property specifies the name of the queue manager on which the destination message queues are defined. | |
Queue manager host name | No | This property specifies the host name of the
queue manager. To achieve high availability, you can specify more than one host name by separating each host name with a comma. The first host name in the list is used as the primary host name. If the connection to the host name becomes unavailable, the next host name is used, and so on. For more information about high availability in IBM MQ, see the IBM MQ product documentation online. |
|
Listener port number | No | This property specifies the port on which the queue manager is listening. | |
Channel name | No | This property specifies the name of the channel used by the queue manager to receive messages. | |
Security identity | No | This property specifies an identity that is
used to provide username and password credentials for connections
to a secured local or remote queue manager. It can be used to provide
credentials on local and client connections, but it is not available
for client connections that are configured using a client channel
definition table (CCDT). The identity is defined using the mqsisetdbparms command. When
you set the security identity by using this command, ensure that it
is prefixed by For more information, see Connecting to a secured IBM MQ queue manager. |
|
Use SSL | No | No | This property controls whether the SSL protocol
is used when a client connection is made to a remote queue manager.
Select this property to provide confidentiality on the client connection
by using SSL. You can also set this property through an MQEndpoint policy. You can use SSL for client connections that are configured using either the MQ client connection properties or a client channel definition table (CCDT). If you select Use
SSL and specify the connection details through MQ client connection properties,
you can also set the following properties:
If
you select the Use SSL property,
you must also specify the location of the SSL key repository. The
SSL key repository is created using the IBM MQ GSkit, and it holds the required
private and public certificates appropriate to the chosen certificate
policy for the queue manager. You specify the key repository location
by using the mqsichangeproperties command;
it is specified as the SSL key repository full file path minus the .kdb file
extension. For example, if the SSL key repository is located in C:\SSL\key.kdb,
you set it by using the following command :
The SSL key repository password stash file key repository file name.sth must be located in same folder location as the key repository. The stash file is created using IBM MQ GSKit. Use the MQSC REFRESH SECURITY command to pick up the changes to the SSL key repository. For more information, see Connecting to a secured IBM MQ queue manager. |
SSL peer name | No | This property specifies the name that is passed
to the remote queue manager when making the client connection; there
must be a positive match for the connection to succeed. You can specify this property if the Use SSL property is selected and the client connection details are specified through MQ client connection properties. It is not used for client connections that use a client channel definition table (CCDT); you can specify this information in the CCDT. |
|
SSL cipher specification | No | This property specifies the name of the symmetric
key cryptography algorithm through which the remote queue manager
is secured. You can specify this property if the Use SSL property is selected and the client connection details are specified through MQ client connection properties. It is not used for client connections that use a client channel definition table (CCDT); you can specify this information in the CCDT. |
Configure the connection details to enable a message to be retrieved from a queue on a local or remote queue manager. Values that are set on the MQ Connection tab are used at run time, unless overridden by a value in an MQEndpoint policy that is specified on the Policy tab.
Property | M | Default | Description |
---|---|---|---|
Destination mode | Yes | Queue Name | The queues to which the output message is sent.
|
Transaction mode | Yes | Automatic | This property controls whether the message is
put transactionally.
|
Persistence mode | Yes | Automatic | This property controls whether the message is
put persistently.
|
Object queue manager | No | This property specifies the name of a second IBM MQ queue manager, which is the
target queue manager to which messages are routed from the queue manager
that is connected to the MQOutput node. The Object Queue Manager property is used only if the specified queue is defined on another queue manager or is a cluster queue. If it is a cluster queue, the Object Queue Manager can optionally be specified if you want to specify which queue manager receives the message. If you leave the Object Queue Manager property empty, the cluster will route the message to an appropriate queue manager in the cluster. For more information, see the IBM MQ product documentation online. |
|
New message ID | Yes | Cleared | If you select this check box, IBM MQ generates a new message identifier
to replace the contents of the MsgId field
in the MQMD. This property maps to the MQPMO_NEW_MSG_ID option of
the MQPMO of the MQI. Clear the check box if you do not want to generate
a new ID. A new message ID is still generated if you select the Request property on the Request tab. For more information about the options to which this property maps, see the Application Programming Reference section of the IBM MQ product documentation online. |
New correlation ID | Yes | Cleared | If you select this check box, IBM MQ generates a new correlation
identifier to replace the contents of the CorrelId field in the MQMD.
This property maps to the MQPMO_NEW_CORREL_ID option of the MQPMO
of the MQI. Clear the check box if you do not want to generate a new
ID. For more information about the options to which this property maps, see the Application Programming Reference section of the IBM MQ product documentation online. |
Segmentation allowed | Yes | Cleared | If you select this check box, IBM MQ breaks the message into segments
in the queue manager. Clear the check box if you do not want segmentation
to occur. For more information about message segmentation,
see Sending message segments in an IBM MQ message. For more information about the options to which this property maps, see the Application Programming Reference section of the IBM MQ product documentation online. |
Message context | Yes | Pass All | This property controls how origin context is
handled.
When a security profile is associated with the node and is configured to perform identity propagation, the chosen context can be overridden to ensure that the outgoing identity is set. For more information about the options to which these properties map, see the Application Programming Reference section of the IBM MQ product documentation online. |
Alternate user authority | Yes | Cleared | If you select this check box, alternate authority is used when the output message is put and the MQOO_ALTERNATE_USER_AUTHORITY option is set in the open options (MQOO) of the MQI. If you select this check box, this option is specified when the queue is opened for output. The alternative user information is retrieved from the context information in the message. Clear the check box if you do not want to specify alternative user authority. If you clear the check box, the integration server service user ID is used when the message is put. |
The Advanced node properties define the transactional control for the message and the way in which the message is put to the queue.
Property | M | Default | Description |
---|---|---|---|
Request | Yes | Cleared | If you select the check box, each output message in the MQMD is generated as a
request message (MQMT_REQUEST), and the message identifier field is cleared (and set to MQMI_NONE)
so that IBM MQ generates a new identifier. Clear the check box to
indicate that each output message is not marked as a request message. If you have set Destination Mode to Reply To
Queue, you cannot select this check box. A new message identifier is generated even if the New Message ID check box is not selected on the Advanced tab. If the check box is not selected and the values that were previously configured for Reply-to queue and Reply-to queue Manager are grayed out, these grayed out values are not used to override the MQMD header of the outgoing message. |
Reply-to queue Manager | No | The name of the IBM MQ queue manager to which the output queue, which is specified in Reply-to Queue, is defined. This name is inserted into the MQMD of each output message as the reply-to queue manager. | |
Reply-to queue | No | The name of the IBM MQ queue to which to put a reply to this request. This name is inserted into the MQMD of each output message as the reply-to queue. |
The Request properties define the characteristics of each output message that is generated.
Property | M | Default | Description |
---|---|---|---|
Validate | No | Inherit | This property controls whether validation takes place. Valid values are None, Content and Value, Content, and Inherit. |
Failure action | No | Exception | This property controls what happens if validation fails. You can set this property only if you set Validate to Content or Content and Value. Valid values are User Trace, Local Error Log, Exception, and Exception List. |
For a full description of these properties, see Validation properties.
Property | M | Default | Description |
---|---|---|---|
Security profile | No | None | This property specifies the name of the security profile that defines the
security operations that are completed by the node in the message flow. For more information, see Security profiles and Creating a security profile. |
For information about the MQOutput node Security properties, see Security profiles.
Property | M | Default | Description |
---|---|---|---|
Policy | No | Set the value of this field to the location
of an MQEndpoint policy to use
the connection details defined in that policy for this MQ node. Specify
the name of the policy project and the policy in the format {policyProjectName}:PolicyName .If an MQEndpoint policy is specified, the property values that are set in the policy are used at run time. The properties that are set in the policy override the corresponding properties that are set on the MQ Connection tab. If an MQEndpoint policy is not specified, then property values that are set on the MQ Connection tab are used. If no MQEndpoint policy is specified, and the Connection property on the MQ Connection tab is set to Local queue manager with no queue manager specified (the default state), then the MQ node uses the connection details for the queue manager that was specified for the integration server. If no queue manager was specified for the integration server, then the message flow will not deploy. |
If an MQEndpoint policy is specified, any equivalent properties that are set on the MQ Connection tab are ignored at run time (see MQEndpoint policy).
Property | M | C | Default | Description |
---|---|---|---|---|
Add request to group | No | No | False | If selected, this property causes the request or output node to add the request to a group that is being built, and generate group information in the environment tree. |
Folder name | No (See note) | No | The folder name in the group for the request that this node will make. |
Property | M | Default | Description |
---|---|---|---|
Events | No | 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. You can enable and disable events that are shown here by selecting or clearing the Enabled check box. |
Configurable properties
The following table describes the node properties that are configurable (you can change the property value when you add the message flow to the BAR file for deployment by using the mqsiapplybaroverride command). The table maps the message flow node properties to the corresponding properties of the mqsiapplybaroverride command.
For more information about configurable properties, see Configurable properties in a BAR file.
Table of configurable properties
Property | mqsiapplybaroverride command property |
---|---|
Queue name | queueName |
Connection type | connection |
Destination queue manager name | destinationQueueManagerName |
Queue manager host name | queueManagerHostname |
Listener port number | listenerPortNumber |
Channel name | channelName |
Security identity | securityIdentity |
Use SSL | useSSL |
SSL peer name | SSLPeerName |
SSL cipher specification | SSLCipherSpec |
Reply to queue manager | replyToQMgr |
Reply to queue | replyToQ |
Validate | validateMaster |
Policy | policyUrl |