SOAPEnvelope node
Use the SOAPEnvelope node to add a SOAP envelope onto an existing message. This node is designed to be used with the SOAPExtract node.
- Developer
- Application Integration Suite
- Standard
- Advanced
- Express
- Scale
This topic contains the following sections:
Purpose
You can also use the node in a flow without a corresponding SOAPExtract node; the node has an option to create a default SOAP envelope.
The SOAPEnvelope node is contained in the Web Services drawer of the palette, and is represented in the IBM® Integration Toolkit by the following icon:
Using the SOAPEnvelope node in a message flow
This node is designed to be used in conjunction with the SOAPExtract node; see SOAPExtract node.
Configuring the SOAPEnvelope node
When you have put an instance of the SOAPEnvelope 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.
Supported parsers
- XMLNSC
- XMLNS
- MRM
Full validation is not done on the SOAP message, which just needs to contain a body element.
SOAPInput node-> SOAPExtract node->SOAPEnvelope node
Example SOAP messages
Incoming SOAP envelope
<?xml version="1.0"?>
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:tns="http://ws3.st.mqsi.ibm.com/App/DocLiteral1"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header>
<tns:requestHeader>
<tns:assessorUrl>header1</tns:assessorUrl>
</tns:requestHeader>
</soapenv:Header>
</soapenv:Envelope>
Incoming SOAP message body
<?xml version="1.0"?>
<tns:requestAvailability
xmlns:tns="http://ws3.st.mqsi.ibm.com/App/DocLiteral1"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<tns:carDetails>body1</tns:carDetails>
<tns:claimID>body2</tns:claimID>
<tns:location>body3</tns:location>
<tns:reqDate>body4</tns:reqDate>
</tns:requestAvailability>
Outgoing SOAP message
<?xml version="1.0"?>
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:tns="http://ws3.st.mqsi.ibm.com/App/DocLiteral1"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header>
<tns:requestHeader>
<tns:assessorUrl>header1</tns:assessorUrl>
</tns:requestHeader>
</soapenv:Header>
<soapenv:Body>
<tns:requestAvailability>
<tns:carDetails>body1</tns:carDetails>
<tns:claimID>body2</tns:claimID>
<tns:location>body3</tns:location>
<tns:reqDate>body4</tns:reqDate>
</tns:requestAvailability>
</soapenv:Body>
</soapenv:Envelope>
Terminals and properties
The terminals of the SOAPEnvelope node are described in the following table:
Terminal | Description |
---|---|
In | The input terminal that accepts a SOAP message for processing by the node. |
Out | The output terminal that outputs the SOAP message that was constructed from the SOAP message body and a SOAP envelope. |
Failure | The output terminal to which the message is routed if a failure is detected during processing. |
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 Description properties of the SOAPEnvelope node are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Node name | No | No | The node type | 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 Basic properties of the SOAPEnvelope node are described in the following table.
Property | M | C | Default | Description |
---|---|---|---|---|
Create new envelope | No | No | Cleared | This property controls whether the node creates a SOAP envelope, or gets an existing one from the message tree. If you select the check box, the node creates a new envelope. If you clear the check box, the node copies the envelope from the value entered in the Existing Envelope Location property. |
Existing Envelope Location | No | No | $LocalEnvironment/SOAP/Envelope | An XPath expression that represents the location
from which the node will copy the SOAP envelope. The following correlation
names are available:
|
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. |