Data Factory > protocol-soap-perform

TL;DR;

This task allows you to perform SOAP requests.

Name:

Max execution time: 120 mins

Target

Perform one or more SOAP requests on a web service

Example of use in a job

Send products on a SOAP API that accepts one product per call and update a status for each product correctly sent

1. Export Items - Export products selected by the user
2. XSLT Transformation - for the soap task
3. SOAP - Calls soap
4. XLST Transformation - for item status update
5. Import Items - Import of items

General notes

The result of the task is COMPLETED even if the result of one or more queries are in error. It is the allSuccess output that determines if all the requests were successful.
To date, in the case where the web service cannot be contacted, in REQUEST mode, the result is presented as below

xml

<Soap>
    <Soap-Call>
        <Request>
            <Soap-Message>
                <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                </soapenv:Envelope>
            </Soap-Message>
        </Request>
        <Response>
            <Error>Unable to contact the web service.</Error>
        </Response>
    </Soap-Call>
</Soap>

A number of headers are communicated by default at the time of the request to the web service:
- content-type: text/xml
- cache-control: no-cache
- mime-version: 1.0
Header names are case-insensitive
- Therefore, content-type and Content-Type are strictly equivalent
- If Content-Type is given by the user, the proposed value will override the default value
- If several headers with identical names are given, the last one in order of appearance will be used

Inputs and Outputs

Example of defining this task in JSON

json

{
  "name": "protocol-soap-perform",
  "taskReferenceName": "soap",
  "description": "The business description of the task",
  "type": "SUB_WORKFLOW",
  "optional": false,
  "inputParameters": {
    "endpoint": "http://",
    "useAuthentication": true,
    "login": "admin",
    "password": "",
    "request": "file://assets/request.xml"
  }
}

Inputs

TIP

If at least one task parameters (whether mandatory or not) is invalid, task execution is stopped and the returned status is FAILED. For example:

The proposed value for the allowPartial property is invalid.
The file specified for the request property does not exist

Property	Description
`endpoint`	Obligatoire - String The entry point of the web service
`useAuthentication`	Obligatoire - Boolean `true` : Calling the web service requires authentication, in this case `login` and `password` are required `false`: -
`login`	String Login, only required if `useAuthentication` is `true`
`password`	String Password, only required if `useAuthentication` is `true`
`mode`	Obligatoire - Enum - `REQUEST`, `FILES`, `FILES` `REQUEST`: requires `request` parameter `FILES` requires `files` parameter `FILE` requires `file` parameter
`request`	Obligatoire si `mode = REQUEST` - File A file
`files`	Obligatoire si `mode = FILES` - Array of File
`file`	Obligatoire si `mode = FILE` - File

Outputs

TIP

The outputs of the task defined below are always available if the task completes its execution (status COMPLETED and FAILED). If the task is stopped before the end of its execution (if the task is canceled by the user for example - CANCELED status, or if it exceeds the authorized execution time - TIMED_OUT), the outputs are not available.

Property	Description
`allSuccess`	Enum - `YES` ou `NO` If all request ended up in success : `YES`, otherwise `NO` If no request had to be performed : `YES`
`file`	File Present if the `FILE` mode is used
`files`	Array of File Present if the `FILES` mode is used
`listing`	File Present if the `FILE` or `FILES` mode is used
`responses`	File Present if the `REQUEST` mode is used

Details regarding the `request` document

xml

<Soap>
  <Soap-Call>
    <Request>
        <Soap-Message>
          <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
            <soap:Body xmlns:m="http://www.example.org/stock">
              <m:GetStockPrice>
                <m:StockName>IBM</m:StockName>
              </m:GetStockPrice>
            </soap:Body>
          </soap:Envelope>
        </Soap-Message>
        <Headers>
            <Header key="customHeader">value</Header>
        </Headers>
    </Request>    
    <Metadata>
      <ean>1234567890123</ean>
    </Metadata>  
  </Soap-Call>
</Soap>

XPath	Description	Occurrence
`Soap`	Root of the document	1
`./Soap-Call`	For each call.	0..*
`../Request`	The request element	1
`../Request/@path`	The path containing path params.	0..1
`../Request/Headers`	The headers	0..1
`.../Headers/Header`	A header	1..*
`.../Headers/Header@key`	The name of the header (case-insensitive)	1
`.../Soap-Message`	The soap message	1
`../Metadata`	An element that can be used to store information and retrieve them in the responses.	0..1

Regarding the `responses` output (`REQUEST` mode)

xml

<Soap>
    <Soap-Call>
        <Request>
            <Soap-Message>
                <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
                    <soapenv:Header>
                    </soapenv:Header>
                    <soapenv:Body>
                    </soapenv:Body>
                </soapenv:Envelope>
            </Soap-Message>
            <Headers>
                <Header key="customHeader">value</Header>
            </Headers>
        </Request>
        <Response>
            <Status-Code>200</Status-Code>
            <Content>
              <soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
                <soap:Body xmlns:m="">
                </soap:Body>
              </soap:Envelope>
            </Content>
        </Response>
        <Metadata>
            <key>value</key>
        </Metadata>
    </Soap-Call>
</Soap>

XPath	Description	Occurrence
./Response	The response for each call.	1
../Status-Code	The status code of the response	1
../Content	The content of the response	1

Available logs

Code	Type	Metadata	Remarks
SOAP_REQUEST_START	info	`endpoint`, `file`	Logged once at each soap request. In mode FILE/FILES also once at the beginning of the task.
SOAP_REQUEST_SUCCESS	info	`endpoint`, `file`, `statusCode`	Logged after each successful soap request.
SOAP_REQUEST_ERROR	error	`endpoint`, `file`, `statusCode`	Logged after each soap request that encountered errors. It sometimes throw an error and stop the worker.
SOAP_INVALID_INPUT	error	`message`	Logged when input is invalid. It throws an error and stops the worker.
SOAP_INVALID_XML_INPUT	error	`message`	Logged when input file in request mode is invalid. It sometimes throws an error and stops the worker.
SOAP_TASK_COMPLETE_SUCCESS	info	`listing`, `responses`	Logged after task finished, if no error encountered.
SOAP_TASK_COMPLETE_ERROR	error	`listing`, `responses`	Logged after task finished, if there were errors.

Data Factory > protocol-soap-perform ​

Target ​

Example of use in a job ​

General notes ​

Inputs and Outputs ​

Inputs ​

Outputs ​

Details regarding the request document ​

Regarding the responses output (REQUEST mode) ​

Available logs ​