SOAP 1.2 Web Service

This page describes the configuration for setting up a SOAP 1.2 Web Service Source

1. Basic Parameters

To connect SOAP 1.2 Web Service as a Data Source, fill in the following parameters (image 1):

Parameter	Value
authType	None WSSE - Will allow you to use a Username and Password to authenticate via a WS-Security SOAP envelope header. Basic - Will allow you to use a Username and Password to authenticate via a basic auth header
usePasswordDigest	This is an optional boolean parameter and should only be used in the context of WSSE auth when the Password Type is of PasswordDigest.
requestTimeout	Use this to set timeout for the request
endPoint	This is the SOAP 1.2 Web Service API endpoint
hasMtomResponse	This boolean parameter indicates whether or not it has an Mtom Response. Required to be true if the SOAP API response contains an attachment outside of the SOAP response message. See here for an example.
recordXpath	XPATH result set which user want to sync data from. See here for more on XPATH.
envelopeNamespace	The envelope namespace of the SOAP message.

Image 1: Basic Data Sync Parameters

2. Schema Columns

1. Add in your applicable columns (Image 2). Review the documentation here for information on the column types available.

Image 2: Schema Columns

3. Filter

Adding a filter section allows you to enter a CQL filter statement for your results (Image 3). See here for more information on adding a Filter.

Image 3: Adding a Filter Section

3. XML Body Example

<?xml version="1.0" encoding="utf-16" ?>
<BatchDataSyncConfig 
	name="WORKFORCE" 
	version="1.0.0" 
	xmlns="http://www.cinchy.co" 
	xmlns:soap="http://www.w3.org/2003/05/soap-envelope" 
	xmlns:xsd="http://services.workforcesoftware.com/xsd" 
	xmlns:ax2119="http://ws.apache.org/axis2/xsd">
	<!--BatchDataSyncConfig requires attributes xmlns:soap, xmlns:xsd and xmlns:ax2119 to connect to SOAP 1.2 Web Service-->
	<Parameters />
	<Soap12DataSource 
		username="WEB_SERVICE_USER"
		password="gTyhHklRGLo9foH4ztbSoXJ3Q29JM"
		usePasswordDigest="false"
		hasMtomResponse="true"
		endpoint="https://groupex-groupexsandboxte-trn.wfsaas.com/workforce/services/Z_getE2GEmployees.Z_getE2GEmployeesHttpsSoap12Endpoint/"
		recordXpath="//ax2119:result">
		<soap:Body>
			<xsd:Z_getE2GEmployees/>
		</soap:Body>
		<Schema>
			<Column name="./ax2119:EMPLOYEE_ID" ordinal="1" dataType="Text" maxLength="50" isMandatory="false" validateData="false" trimWhitespace="true" description=""/>
			<Column name="./ax2119:LOCATION_CODE" ordinal="2" dataType="Text" maxLength="500" isMandatory="false" validateData="false" trimWhitespace="true" description=""/>
			<Column name="./ax2119:firstName" ordinal="3" dataType="Text" maxLength="50" isMandatory="false" validateData="false" trimWhitespace="true" description=""/>
			<Column name="./ax2119:lastName" ordinal="4" dataType="Text" maxLength="50" isMandatory="false" validateData="false" trimWhitespace="true" description=""/>
		</Schema>
	</Soap12DataSource>
	<CinchyTableTarget model="" domain="Workforce" table="WORKFORCE_EMPLOYEES">
		<ColumnMappings>
			<ColumnMapping sourceColumn="./ax2119:EMPLOYEE_ID" targetColumn="Employee ID" /> 
			<ColumnMapping sourceColumn="./ax2119:LOCATION_CODE" targetColumn="Location Code" />
			<ColumnMapping sourceColumn="./ax2119:firstName" targetColumn="FirstName" />
			<ColumnMapping sourceColumn="./ax2119:lastName" targetColumn="LastName" />
		</ColumnMappings>
		<SyncKey>
		  <SyncKeyColumnReference name="Employee ID" />
		</SyncKey>
		<Filter />
		<DroppedRecordBehaviour type="IGNORE" />
	</CinchyTableTarget>
</BatchDataSyncConfig>