tSOAP properties - 6.1

Talend Components Reference Guide

Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for Big Data
Talend Open Studio for Data Integration
Talend Open Studio for Data Quality
Talend Open Studio for ESB
Talend Open Studio for MDM
Talend Real-Time Big Data Platform
Talend Studio
Data Governance
Data Quality and Preparation
Design and Development

Component family




tSOAP sends the defined SOAP message with the given parameters to the invoked Web service and returns the value as defined, based on the given parameters.


This component calls a method via a Web service in order to retrieve the values of the parameters defined in the component editor.

Basic settings

Schema and Edit schema

A schema is a row description, it defines the number of fields that will be processed and passed on to the next component.

This component always uses a built-in, read-only schema.

By default, the schema contains three String type columns:

- Header: stores the SOAP message header of the response from the server end.

- Body: stores the SOAP message body of the response from the server end.

- Fault: stores the error information when an error occurs during the SOAP message processing.

If the Output in Document check box is selected, the schema then contains only one Document type column named Soap, which stores the whole response SOAP message in the XML format.

Click Edit schema to view the schema structure.


Changing the schema type may result in loss of the schema structure and therefore failure of the component.



Select this check box if you want to use the NTLM authentication protocol.

Domain: Name of the client domain.


Need authentication

Select this check box and enter a user name and a password in the corresponding fields if this is necessary to access the service.

To enter the password, click the [...] button next to the password field, and then in the pop-up dialog box enter the password between double quotes and click OK to save the settings.


Use http proxy

Select this check box if you are using a proxy server and fill in the necessary information.


Trust server with SSL

Select this check box to validate the server certificate to the client via an SSL protocol and fill in the corresponding fields:

TrustStore file: enter the path (including filename) to the certificate TrustStore file that contains the list of certificates that the client trusts.

TrustStore password: enter the password used to check the integrity of the TrustStore data.



Type in the URL address of the invoked Web server.


SOAP Action

Type in the URL address of the SOAPAction HTTP header field to be used to identify the intent of the SOAP HTTP request.


SOAP version

Select the version of the SOAP system you are using.


The required SOAP Envelope varies among versions.

 Use a message from the input schema

Select this check box to read a SOAP message from the preceding component to send to the invoked Web service.

When this check box is selected, the SOAP message field becomes a drop-down list allowing you to select a Document type column to read an input XML file.


This option makes sense only when the tSOAP component is connected with an input component the schema of which contains a Document type column to read a valid SOAP message.

 Output in DocumentSelect this check box to output the response message in XML format.


SOAP message

Type in the SOAP message to be sent to the invoked Web service. The global and context variables can be used when you write a SOAP message.

For further information about the context variables, see Talend Studio User Guide.

Advanced settings

Use Kerberos

Select this check box to choose a tSetKerberosConfiguration component from the Kerberos configuration list.


The OnSubjobOk trigger of tSetKerberosConfiguration should be used for connection with tSoap.


tStatCatcher Statistics

Select this check box to gather the Job processing metadata at a Job level as well as at each component level.

Global Variables

ERROR_MESSAGE: the error message generated by the component when an error occurs. This is an After variable and it returns a string. This variable functions only if the Die on error check box is cleared, if the component has this check box.

A Flow variable functions during the execution of a component while an After variable functions after the execution of the component.

To fill up a field or expression with a variable, press Ctrl + Space to access the variable list and choose the variable to use from it.

For further information about variables, see Talend Studio User Guide.


This component can be used as an input or as an intermediate component.


Outgoing links (from this component to another):

Row: Main; Iterate

Trigger: Run if; On Component Ok; On Component Error.

Incoming links (from one component to this one):

Row: Main; Iterate

Trigger: Run if; On Component Ok; On Component Error.

For further information regarding connections, see Talend Studio User Guide.


If you are using a subscription-based version of the Studio, the activity of this component can be logged using the log4j feature. For more information on this feature, see Talend Studio User Guide.

For more information on the log4j logging levels, see the Apache documentation at http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/Level.html.