tWebServiceInput - 6.3

Talend Open Studio for Big Data Components Reference Guide

Talend Open Studio for Big Data
Data Governance
Data Quality and Preparation
Design and Development
Talend Studio


Calls the defined method from the invoked Web service, and returns the class as defined, based on the given parameters.


Invokes a Method through a Web service.


To handle complex hierarchical data, use the advanced features of tWebServiceInput and provide Java code directly in the Code field of the Advanced Settings view.

tWebServiceInput Properties

Component family



Basic settings

Property type

Either Built-in or Repository.

Since version 5.6, both the Built-In mode and the Repository mode are available in any of the Talend solutions.



Built-in: No property data stored centrally.



Repository: Select the Repository file where the properties are stored. The fields that follow are completed automatically using the data retrieved.


Click this icon to open a WSDL schema wizard and store your WSDL connection in the Repository tree view.

For more information about setting up and storing database connection parameters, see Talend Studio User Guide.


Schema and Edit Schema

A schema is a row description, it defines the number of fields to be processed and passed on to the next component. The schema is either Built-in or stored remotely in the Repository.

Since version 5.6, both the Built-In mode and the Repository mode are available in any of the Talend solutions.

Click Edit schema to make changes to the schema. If the current schema is of the Repository type, three options are available:

  • View schema: choose this option to view the schema only.

  • Change to built-in property: choose this option to change the schema to Built-in for local changes.

  • Update repository connection: choose this option to change the schema stored in the repository and decide whether to propagate the changes to all the Jobs upon completion. If you just want to propagate the changes to the current Job, you can select No upon completion and choose this schema metadata again in the [Repository Content] window.



Built-in: You create the schema and store it locally for the relevant component. Related topic: see Talend Studio User Guide.



Repository: You have already created the schema and stored it in the Repository. You can reuse it in various projects and job flowcharts. Related topic: see Talend Studio User Guide.



Description of Web service bindings and configuration.


Need authentication / Username and Password

Select this check box and:

-enter a username and a password in the corresponding fields if this is necessary to access the service. Or,

-select the Windows authentication check box and enter the windows domain in the corresponding field 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.


Time out (second)

Set a value in seconds for Web service connection time out.


Method Name

Enter the exact name of the Method to be invoked.

The Method name MUST match the corresponding method described in the Web Service. The Method name is also case-sensitive.



Enter the parameters expected and the sought values to be returned. Make sure that the parameters entered fully match the names and the case of the parameters described in the method.


Advanced Use

Select this check box to display the fields dedicated for the advanced use of tWebServiceInput:

WSDL2java: click the three-dot button to generate Talend routines that hold the Java code necessary to connect and query the Web service.

Code: replace the generated model Java code with the code necessary to connect and query the specified Web service using the code in the generated Talend routines.

Match Brackets: select the number of brackets to be used to close the for loop based on the number of open brackets.


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.

NB_LINE: the number of rows processed. This is an After variable and it returns an integer.

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 is generally used as a Start component. It must be linked to an output component.


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



Scenario: Getting country names using tWebServiceInput

This scenario describes a two-component Job which uses a Web service method to obtain the country name corresponding to a given country code and displays the output on the Run console view.

  1. Drop a tWebServiceInput component and a tLogRow component from the Palette onto the design workspace.

  2. Link the two components using a Row > Main connection.

  3. Double-click the tWebServiceInput component to open its Basic settings view.

  4. Click the [...] button next to Edit schema to open the [Schema] dialog box and define the schema for the response from the Web service.

    In this example, the schema is composed of only one column: Result.

  5. In the WSDL field, specify the WSDL URL of the Web service to be used, in this example.

  6. If you are using a proxy server, select the Use http proxy check box and enter the necessary connection information.

  7. In the Method name field, enter the method to be used. Note that the method name is case sensitive.

    In this example, we use the method GetCountryByCountryCode.

  8. In the Parameters area, click the plus [+] button to add a row to the table, then enter a country code, fr in this example..

  9. Then save your Job and press F6 to execute it.

    The country information is returned from the Web service and displayed on the Run view.