This Snap calls the SOAP endpoint using the incoming data and writes out a SOAP response.

• Expected upstream Snaps: References in the generated envelope can be mapped using a Mapper or Structure Snap.
• Expected downstream Snaps: The Snap will output one document for every SOAP response, hence any document processing Snap can be used downstream.
• Expected input: Document that conforms to the input view schema of the Snap (the Target Schema column in Mapper or Structure Snap)
• Expected output: Document which represents the SOAP response (an XML transformed into JSON)

Clicking Customize Envelope will attempt to generate a SOAP envelope based on the information defined in the properties and the selected WSDL. The action will launch the XML Editor.

 In general, you will most likely always use Customize Envelope. 

The envelope will be stored in the Snap after clicking OK. Further, the envelope can be exported to SnapLogic's file system using the export action or be imported from there using the import action. The Generate template action will regenerate the template, but the content of the editor must be removed prior to that. The envelope can be customized to meet specific endpoint needs. The Snap is fully configured and executable once the envelope is finalized.  

The generated envelope will have velocity references in it. These references (here, $session_id) will be exposed to the Target Schema column of the upstream Mapper or Structure Snap. However, any changes made by the user in the generated envelope won't be reflected to this Target Schema column. In this case, the user has to remember the references added/modified in the generated envelope to map them in the upstream Snap.

To execute a create request through an NTLM account in the SOAP Execute Snap, use the generic envelope similar to the following sample. This ensures the output is rendered as excepted. See the example for a demo on how this works.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope 
	xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
	xmlns:ns0="http://schemas.microsoft.com/dynamics/2010/01/datacontracts" 
	xmlns:ns2="http://schemas.microsoft.com/dynamics/2008/01/services" 
	xmlns:ns1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" 
	xmlns:ns4="http://schemas.microsoft.com/dynamics/2008/01/sharedtypes" 
	xmlns:ns3="http://schemas.microsoft.com/dynamics/2008/01/documents/Customer">
	<SOAP-ENV:Header/>
	<SOAP-ENV:Body>
		<ns2:CustomerServiceCreateRequest xmlns="http://schemas.microsoft.com/dynamics/2008/01/services">
			<ns3:Customer xmlns="http://schemas.microsoft.com/dynamics/2008/01/documents/Customer">
				<ns3:CustTable class="entity">
					<ns3:Currency>USD</ns3:Currency>
					<ns3:CustGroup>group</ns3:CustGroup>
					<ns3:Name>SL_Name_3123</ns3:Name>
					<ns3:DirParty xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
						class="entity" xsi:type="AxdEntity_DirParty_DirOrganization">
					<ns3:Name>dirparty_SL_3123</ns3:Name>
					</ns3:DirParty>
				</ns3:CustTable>
			</ns3:Customer>
		</ns2:CustomerServiceCreateRequest>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

In the upstream Mapper or Structure Snap, these references can be mapped to static values (such as 1234) or to the references exposed in the Input Schema column. 

We map the reference session_id in the upstream Mapper (Data) Snap in the example below. Note that the content of the editor must be saved prior to selecting the schema upstream.

How to use the default value for substitution

To use the Default value for substitution property of the Snap:

1. Provide a value for Default value for substitution. This value is placed between the leaf elements—the elements that don't have any child elements.

   The substitution won't work if these leaf elements are contained within an array that does not exist in the incoming documents.

   
   

2. Select the Use default value for substitution property.

Example

Incoming document:

Here, the session_id element doesn't exist in the incoming document. In this case, using Default value for substitution will give us the following envelope: 

<?xml version="1.0" encoding="UTF-8"?> 
	<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
					   xmlns:ns0="http://api.clickatell.com/soap/webservice"> 
			<SOAP-ENV:Header /> 
			<SOAP-ENV:Body> 
				<ns0:ping> 
					<session_id>NO VALUE</session_id> 
				</ns0:ping> 
			</SOAP-ENV:Body> 
	</SOAP-ENV:Envelope>

• Works in Ultra Pipelines if timeout is specified.
• After upgrading your Snaplex to 4.20 GA version, Pipelines with SOAP Execute Snap that uses the Apache CXF library might hang without executing. The Snap using HTTPComponents library executes successfully.

Specify the URL for the WSDL.

Example: http://www.webservicex.net/stockquote.asmx?WSDL 

Specify the endpoint (in WSDL 2.0 terminology)/Port name (in WSDL 1.1 terminology).

Example: {http://www.webserviceX.NET/}StockQuote

Select this checkbox to enable the Snap replace the XML special characters  in XML template variable values with the respective character entity references (> <, and so on) while inserting these values into the Apache Velocity template. For example, the Snap replaces < with &It;. 

Default value: Selected.

Select this checkbox to enable content processing to multipart, application/xop+xml type.

The following example shows how contents of the file, salesforce_sample.csv, are inserted into the SOAP response and what updates are required to the Snap.

After selecting the Enable MTOM Processing field, the following updates to the Snap are required for successful execution:  

• Attachments: Specify the Binary filename (salesfoorce_sample.csv), and its Content-ID and Content-Type.
  
  
  
  

  With MTOM processing enabled, entering attachment part value to the Part field is: Mandatory if you are using the Apache HttpComponents library. Optional if you are using the Apache CXF library.

  
  

• Customize Envelope: Click Customize Envelope to update the SOAP envelope to import the attached file and its contents.

• 
  
  
  Note that to reference the attached file; you must specify the following line of code in the SOAP envelope:

<xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include"  
href="cid:<Content-ID_of_the_filename>"/>

Default value: Not selected

An expression to match success criteria in the SOAP response.

Example: (with expression toggle on) $['SOAP-ENV:Body']['ns2:orderResponse']['ns2:result'] == "success"

This would match the success criteria in this SOAP response:

[
  {
    "SOAP-ENV:Body": {
      "@xmlns:SOAP-ENV": "http://schemas.xmlsoap.org/soap/envelope/",
      "ns2:orderResponse": {
        "@xmlns:ns2": "http://www.Snaplogic.com/Snapbox/order",
        "ns2:result": "success",
        "ns2:transactionId": "533822"
      }
    }
  }
]

You can see that the user can find the SOAP output by setting Snap Execution on the SOAP Execute Snap, then seeing what comes out. You can also hook up a Mapper Snap and see the schema there. You can do that on the input view, but not the output view.

Use this field set to define HTTP header key-value pairs.

This property enables Snap execution over HTTP. Use the appropriate library to utilize the latest SOAP capabilities. The available options are:

• Apache HttpComponents
• Apache CXF

Default value: Apache CXF
Example: Apache HttpComponents

Default value: Execute only
Example: Validate & Execute