SOAPReply node
Use the SOAPReply node to send SOAP messages from the integration node to the originating client in response to a message that is received by a SOAPInput node.
- Developer
- Application Integration Suite
- Standard
- Advanced
- Express
- Scale
- Adapter
Purpose
The SOAPReply node is typically used with the SOAPInput node, which can be included in the same message flow, or a different flow in the same integration server.
You cannot use a SOAPReply node to respond to a web service request that is received by an HTTPInput node; the integration node generates an exception when the reply is attempted.
The SOAPReply node is contained in the Web Services drawer of the message flow node palette, and is represented in the IBM® Integration Toolkit by the following icon:
Using this node in a message flow
The SOAPReply node can be used in any message flow that needs to send SOAP messages from the integration node to the originating client in response to a message that is received by a SOAPInput node. If a SOAPReply node is connected in a message flow that receives a one-way message, the message propagates to the Failure terminal of the SOAPReply node, and an exception is raised.
If the WS-Addressing, WS-Security, WS-ReliableMessaging, and MustUnderstand headers are not being used, the SOAPReply node can send an empty SOAP response message.
Working with WrittenDestination data
WrittenDestination = (
SOAP = (
Reply = (
WSA = (
To = 'URI'
MessageID = 'id'
Action = 'doAllTheStuff'
) )
)
)
LocalEnvironment overrides
You can dynamically override set values in the local environment in the same way as setting values in other elements of a message. For a full list of values you can override in the local environment, see Local environment overrides.
Terminals and properties
When you have put an instance of the SOAPReply node into a message flow, you can configure it; see Configuring a message flow node. The properties of the node are displayed in the Properties view. All mandatory properties for which you must enter a value (those that do not have a default value defined) are marked with an asterisk.
The SOAPReply 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 message is routed if a failure is detected when the message is propagated. |
Out | The output terminal to which the message is routed if it has been propagated successfully, and if further processing is required within this message flow. |
The following tables describe 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 SOAPReply node Description properties are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Node name | No | No | The node type: SOAPReply | The name of the node. |
Short description | No | No | None | A brief description of the node. |
Long description | No | No | None | Text that describes the purpose of the node in the message flow. |
The SOAPReply node Transactions property is described in the following table. This setting does not apply when the node uses HTTP transport.
Property | M | C | Default | Description |
---|---|---|---|---|
Transaction mode | Yes | No | Automatic | This property controls whether the message is sent under a JMS transaction. Valid values are Yes, No, and Automatic. Select No to send the message using a non-transactional JMS session. Select Yes to output the message using a transactional JMS session. The JMS transaction can be either local or XA coordinated. To use an XA coordinated transaction, using an XA JMS session, you must also select the message flow property Coordinated Transaction in the BAR file properties. Select Automatic if you want the message transactionality to be inherited from the Transaction mode setting on the Input node at the start of the flow. See Configuring JMS and SOAP nodes for local transactions. The Transactions properties apply only to messages sent using JMS transport. |
The SOAPReply node Validation properties are described in the following table. By default, validation is enabled.
If a message is propagated to the Failure terminal of the node, it is not validated. For more details, see Validating messages and Validation properties.
Property | M | C | Default | Description | mqsiapplybaroverride command property |
---|---|---|---|---|---|
Validate | No | Yes | Inherit | This property controls whether validation takes place. Valid values are None, Content and Value, Content, and Inherit. | validateMaster |
Failure action | No | No | User trace | 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. |
The SOAPReply node WS Extensions property is described in the following table.
Property | M | C | Default | Description | mqsiapplybaroverride command property |
---|---|---|---|---|---|
Allow MTOM | No | Yes | No | This property controls whether MTOM is enabled for the parser. Valid values are Yes, No, and Force. For more information about using SOAP MTOM with the SOAPReply, SOAPRequest, and SOAPAsyncRequest nodes, see SOAP MTOM and the SOAPReply, SOAPRequest, and SOAPAsyncRequest nodes. | allowMTOM |
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. |