This topic describes the SOAPEnvelope node.
This topic contains the following sections:
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 represented in the workbench by the following icon:
Look at the following sample to see how to use this node:
When you have put an instance of the SOAPEnvelope node into a message flow, you can configure it. The properties of the node are displayed in the Properties view.
Full validation is not done on the SOAP message, which just needs to contain a body element.
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 | 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 | $LocalEnvironment/ |
An XPath expression that represents the location from
which the node will copy the SOAP envelope. The following correlation names
are available:
|
<?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>
<?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>
<?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>