SOAP Inbound Service

Implementing the SOAP Inbound Service

Configuring the SOAP Inbound Service

To configure the SOAP Inbound service, you must specify settings for the following fields in the application:

The following table describes the fields used to configure a header for the SOAP Inbound service in the application:

HandleSOAPRequest Business Process

The HandleSOAPRequest business process enables the application to receive SOAP messages.

Business Process Example – HandleSOAPRequest

The following is the predefined HandleSOAPRequest business process, as delivered with the application:

<process name="HandleSOAPRequest">
 <rule name="acting_as_intermediate">
   <condition>SOAP_INTERMEDIATE_NODE = "true"</condition>
 </rule>
  <rule name="acting_as_endpoint">
   <condition>SOAP_INTERMEDIATE_NODE = "false"</condition>
 </rule>
  <sequence>
   <sequence>
      <operation name="SoapIn">
       <participant name="SOAPInbound"/>
       <output message="output">
         <assign to="." from="*"></assign>
       </output>
        <input message="input">
         <assign to="." from="*"></assign>
       </input>
      </operation>
     <onFault code="SOAP-FAULT">
       <assign to="InvokeSubBP">false</assign>
     </onFault>
     <choice>
        <select>
         <case ref="acting_as_intermediate" activity="act_as_intermediate"/>
       </select>
       <sequence name="act_as_intermediate">
         <assign to="xport-http-url" from="NextSoapURL/text()"></assign>
         <assign to="b2b-message-mode">send</assign>
         <sequence>
            <operation name="HTTPSend">
              <participant name="SOAP_HTTP_Send"/>
              <output message="Xout">
                <assign to="b2b-raw-response">true</assign>
               <assign to="." from="*"></assign>
             </output>
              <input message="Xin">
                <assign to="." from="*"></assign>
             </input>
            </operation>
           <onFault>
              <sequence>
               <assign to="SOAPfaultcode">Server</assign>
               <assign to="SOAPfaultstring">There was an error processing the 
                           SOAP request.</assign>
               <assign to="SOAPdetail">An error occurred trying to send SOAP 
                           request to next node.</assign>
             </sequence>
            </onFault>
         </sequence>
         <operation name="SoapIn">
         <participant name="SOAPInbound"/>
           <output message="output">
             <assign to="." from="*"></assign>
             <assign to="bootstrap">false</assign>
           </output>
            <input message="input">
              <assign to="." from="*"></assign>
            </input>
         </operation>
         <assign to="SOAPOutboundAttachments" from="SOAPResponseAttachments/*"/>
        </sequence>
     </choice>
     <choice>
        <select>
         <case ref="acting_as_endpoint" activity="act_as_endpoint"/>
       </select>
       <sequence name="act_as_endpoint">
         <operation>
            <participant name="InvokeBusinessProcessService"/>
           <output message="Xout">
             <assign to="." from="*"></assign>
             <assign to="INVOKE_MODE">SYNC</assign>
           </output>
            <input message="Xin" >
              <assign to="." from="*"></assign>
            </input>
         </operation>
         <onFault>
            <sequence>
             <assign to="SOAPfaultcode">Server</assign>
             <assign to="SOAPfaultstring">There was an error processing the 
                         SOAP request.</assign>
             <assign to="SOAPdetail">An error occurred while processing the 
                         SOAP request.</assign>
           </sequence>
          </onFault>
       </sequence>
      </choice>
   </sequence>
            
   <operation name="SoapOut">
      <participant name="SOAPOutbound"/>
      <output message="output">
       <assign to="." from="*"></assign>
       <assign to="SOAP_MODE">respond</assign>
     </output>
      <input message="input">
       <assign to="." from="*"></assign>
     </input>
    </operation>
   <assign to="doc-has-headers">true</assign>
   
    <operation name="HttpResponse">
     <participant name="HttpRespond"/>
     <output message="Xout">
        <assign to="." from="*"></assign>
      </output>
     <input message="Xin">
        <assign to="." from="*"></assign>
      </input>
   </operation>
 </sequence> 
</process>

The following illustrations show the business process as it appears in the GPM:

HandleSOAPRequest Screen 1 of 4

HandleSOAPRequest Screen 2 of 4

HandleSOAPRequest Screen 3 of 4

HandleSOAPRequest Screen 4 of 4

SendSOAPRequest Business Process

The SendSOAPRequest business process enables the application to send SOAP messages.

The following table identifies parameters for various SendSOAP functions and the values you may need to specify in your business process:

Business Process Example – SendSOAPRequest

The following is the predefined SendSOAPRequest business process, as delivered with the application:

<process name="SendSOAPRequest">
 <sequence>
    <operation name="SoapOut">
      <participant name="SOAPOutbound"/>
     <output message="BPML:output">
       <assign to="." from="*"></assign>
     </output>
      <input message="input">
       <assign to="." from="*"></assign>
     </input>
    </operation>
   <operation name="HTTPSend">
      <participant name="SOAP_HTTP_Send"/>
      <output message="Xout">
       <assign to="b2b-raw-response">true</assign>
       <assign to="." from="*"></assign>
     </output>
      <input message="Xin">
       <assign to="." from="*"></assign>
     </input>
    </operation>
   <operation name="SoapIn">
      <participant name="SOAPInbound"/>
      <output message="BPML:output">
       <assign to="." from="*"></assign>
       <assign to="bootstrap">false</assign>
     </output>
      <input message="input">
       <assign to="." from="*"></assign>
     </input>
    </operation>
 </sequence> 
</process>

The following illustration shows the business process as it appears in the GPM:

Handling Multiple Incoming Attachments

When the SOAP Inbound Service handles a SOAP request containing attachments, the message package is opened and the SOAP payload and all attachments are placed in Process Data. The SOAP payload becomes the primary documeent, and the attachments are added with keys being SOAPAttachment1 . . . SOAPAttachmentn. These attachments are located under a SOAPAttachments tag in process data, and their nodes will contain attributes for Content Location and/or Content ID, if these values exist in the SOAP message package. An example Process Data section is shown below for a SOAP message containing two attachments:

<ProcessData> 
... 
<SOAP_URI>/ws/soap/testattachments </SOAP_URI> 
<SOAP_INTERMEDIATE_NODE>false</SOAP_INTERMEDIATE_NODE> 
<WFD_NAME>ExtractSOAPAttachments</WFD_NAME> 
<SOAPAttachments>
    <SOAPAttachment1 Content-ID='cid:http://productheaven.com/234sdaim3324.xml'
      Content-Location='http://productheaven.com/234sdaim3324.xml'
      SCIObjectID='neith:4aedaa:eb9e01efbe:-7d3e'/>
   <SOAPAttachment2 Content-ID='cid:http://productheaven.com/3874923874.xml'
     Content-Location='http://productheaven.com/3874923874.xml' 
     SCIObjectID='neith:4aedaa:eb9e01efbe:-7d3c'/> 
</SOAPAttachments> 
<SOAP-ENV:ReceivedSOAPHeaders>
    <abc:Extension2 s:mustUnderstand='0' xmlns:abc=
         'http://example.org/2001/06/ext'/> 
</SOAP-ENV:ReceivedSOAPHeaders> 
<PrimaryDocument SCIObjectID='neith:4aedaa:eb9e01efbe:-7d3a'/> 
</ProcessData>

Accessing the SOAP Payload and Attachments in Process Data.

The SOAP payload is the primary document, but to work on an attached document that is referenced by the primary document, additional steps must be taken. Essentially, we want to make the referenced attachment the new primary document. See the following example SOAP payload:

<Products>
   <product href="cid:http://productheaven.com/234sdaim3324.xml"/>
   <product href="cid:http://productheaven.com/3874923874.xml"/> 
</Products>

First, use the XML Encoder service to put the actual contents of the soap payload into process data. Then use an assign statement to make a referenced attachment the new primary document.

The xpath expression would be:

<assign to="PrimaryDocument" 
              from="SOAPAttachments/*[@Content-ID=//product[1]/ 
                    @href/text()]/@SCIObjectID"
        />

This xpath expression says to set the primary document to the node under SOAPAttachments having a content ID attribute value that matches the href attribute value of the first occurrence of “product” in process data. You can perform whatever operations are needed on that attachment.

To make the old primary document the current primary document again, use a statement such as:

<assign to="." from="/ProcessData/OldPrimary/PrimaryDocument" 
           append="false"/>