# tSOAP
Calls a method via a Web service in order to retrieve the values of the parameters defined in the component editor.
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.
## tSOAP Standard properties
These properties are used to configure tSOAP running in the Standard Job framework.
The Standard tSOAP component belongs to the Internet family.
Information noteNote: This component is designed for Data Integration Jobs. It is not supported in ESB use cases. To build Jobs that need to be deployed into the Talend Runtime, use the tESBConsumer component which is best suited for the Talend Runtime.
The component in this framework is available in all Talend products.
## Basic settings
| Properties | Description |
| --- | --- |
| 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.
Information noteWarning:
*Changing the schema type may result in loss of the schema
structure and therefore failure of the component.* |
| Use NTLM | 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, enter the password in double quotes in the pop-up dialog box,
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. |
| ENDPOINT | 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.
Information noteWarning:
*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.
Information noteWarning:
*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 Document | Select 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.
Information noteNote:
To use special Latin characters, use encoding CP1252 in the SOAP message
instead.
For further information about the context variables, see [Using contexts and variables](https://help.qlik.com/talend/r/en-US/8.0/studio-user-guide/contexts-and-variables). |
## Advanced settings
| Properties | Description |
| --- | --- |
| Use Kerberos | Select this check box to choose a tSetKerberosConfiguration component from the Kerberos configuration list.
Information noteNote:
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
| Variables | Description |
| --- | --- |
| 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 checkbox is
cleared, if the component has this checkbox.
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 more information about variables, see [Using contexts and variables](https://help.qlik.com/talend/r/en-US/8.0/studio-user-guide/contexts-and-variables). |
## Usage
| Usage guidance | Description |
| --- | --- |
| **Usage rule** | This component can be used as an input or as an intermediate
component. |
| Connections | 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 [Using connections in a Job](https://help.qlik.com/talend/r/en-US/8.0/studio-user-guide/using-connections-in-job). |
**Related concepts**
* [Fetching the country name information using a Web service](https://help.qlik.com/talend/en-US/components/8.0/soap/tsoap-tlogrow-fetching-country-name-information-using-web-service-standard-component "This scenario describes a two-component Job that uses a Web service to retrieve the country name information of a given country code.")
* [Using a SOAP message from an XML file to get country name information and saving the information to an XML file](https://help.qlik.com/talend/en-US/components/8.0/soap/tsoap-tfileinputxml-tfileoutputxml-tfileoutputxml-using-soap-message-from-xml-file-to-get-country-name-information-and-saving-information-to-xml-file-standard-component-this)