# tESBConsumer Calls the defined method from the invoked Web service and returns the class as defined, based on the given parameters. This component is not shipped with your Talend Studio by default. You need to install it using the Feature Manager. For more information, see [Installing features using the Feature Manager](https://help.qlik.com/talend/r/en-US/8.0/studio-user-guide/install-features-to-talend-studio). ## tESBConsumer Standard properties These properties are used to configure tESBConsumer running in the Standard Job framework. The Standard tESBConsumer component belongs to the ESB family. The component in this framework is available in all Talend products. ## Basic settings | Properties | Description | | --- | --- | | Service configuration | Description of Web service bindings and configuration. The
Endpoint field gets filled in
automatically upon completion of the service configuration. | | Input Schema and Edit schema |

A schema is a row description. It defines the number of fields (columns) to be processed and passed on to the next component. When you create a Spark Job, avoid the reserved word line when naming the fields.

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: The schema is created and stored locally for this component only. Related topic: see Setting a Built-in schema in Jobs.
Repository: The schema already exists and is stored in the Repository, hence can be reused. Related topic: see Setting a repository schema in a Job.

| | Response Schema and Edit schema |

A schema is a row description. It defines the number of fields (columns) to be processed and passed on to the next component. When you create a Spark Job, avoid the reserved word line when naming the fields.

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: The schema is created and stored locally for this component only. Related topic: see Setting a Built-in schema in Jobs.
Repository: The schema already exists and is stored in the Repository, hence can be reused. Related topic: see Setting a repository schema in a Job.

| | Fault Schema and Edit schema |

A schema is a row description. It defines the number of fields (columns) to be processed and passed on to the next component. When you create a Spark Job, avoid the reserved word line when naming the fields.

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: The schema is created and stored locally for this component only. Related topic: see Setting a Built-in schema in Jobs.
Repository: The schema already exists and is stored in the Repository, hence can be reused. Related topic: see Setting a repository schema in a Job.

| | Use Service Registry | This option is only available if you subscribed to Talend Enterprise ESB solutions.

Select this check box to enable the Service Registry. It provides dynamic endpoint lookup and allows services to be redirected
based upon information retrieved from the registry. It works in runtime
only.

Enter the authentication credentials in the Username and Password field.

If SAML token is registered in the service registry, you need
to specify the client's role in the Role
field. You can also select the Propagate
Credentials check box to make the call on behalf of an already
authenticated user by propagating the existing credentials. You can enter the
username and the password to authenticate via STS to propagate using username
and password, or provide the alias, username and the password to propagate
using certificate. For more information, see the Use
Authentication option. Select the Encryption/Signature body check box to enable XML
Encryption/XML Signature. For more information, see [XKMS service](https://help.qlik.com/talend/r/en-US/8.0/esb-infra-services-configuration-guide/xkms-service).

In the Correlation Value
field, specify a correlation ID or leave this field empty. For more
information, see the Use Business
Correlation option.

For more information about how to set up and use the Service Registry, see [Setting up ESB Service Registry](https://help.qlik.com/talend/r/en-US/8.0/administration-center-user-guide/setting-up-esb-service-registry) and
[Service Registry](https://help.qlik.com/talend/r/en-US/8.0/esb-infra-services-configuration-guide/service-registry). | | Use Service Locator | Maintains the availability of the service to help meet demands
and service level agreements (SLAs).

This option will not show if the Use
Service Registry
check box is selected. | | Use Service Activity
Monitor | Captures events and stores this information to facilitate
in-depth analysis of service activity and track-and-trace of messages
throughout a business transaction. This can be used to analyze service response
times, identify traffic patterns, perform root cause analysis and more.

This option is disabled when the Use
Service Registry
check box is selected if you subscribed to Talend Enterprise ESB solutions. | | Use Authentication | Select this check box to enable the authentication option.
Select from Basic HTTP, HTTP Digest, Username
Token, and SAML Token (ESB runtime
only). Enter a username and a password in the corresponding
fields as required. Authentication with Basic
HTTP, HTTP Digest, and
Username Token work in both Talend Studio and Talend Runtime. Authentication with the SAML Token
works in runtime only.

When SAML Token (ESB runtime
only) is selected, you can either provide the user credentials
to send the request or make the call on behalf of an already authenticated user
by propagating the existing credentials. Select from:

-: Enter the username and the password
in the corresponding fields to access the service.

Propagate using U/P: Enter the user name
and the password used to authenticate against STS.

Propagate using Certificate: Enter the
alias and the password used to authenticate against STS.

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.

This option will not show if the Use
Service Registry
check box is selected. | | Use Authorization | This option is only available if you subscribed to Talend Enterprise ESB solutions.

Select this check box to enable authorized call. Specify the
client's role in the Role field. This
option appears when SAML Token (ESB runtime
only) is selected in the Use
Authentication list.

For more information about the management of user roles and
rights, see [Managing ESB Resources and
authorization](https://help.qlik.com/talend/r/en-US/8.0/administration-center-user-guide/managing-esb-resources-and-authorizations) and [Talend Identity and Access
Management](https://help.qlik.com/talend/r/en-US/8.0/esb-infra-services-configuration-guide/talend-identity-and-access-management). | | Encryption/Signature body | Select this check box to enable XML Encryption/XML Signature.
For more information, see [XKMS service](https://help.qlik.com/talend/r/en-US/8.0/esb-infra-services-configuration-guide/xkms-service).

This option appears when SAML Token
(ESB runtime only) is selected in the Use Authentication list. | | Use Business Correlation | Select this check box to create a correlation ID in this
component.

You can specify a correlation ID in the Correlation Value field. In this case the
correlation ID will be passed on to the service it calls so that chained
service calls will be grouped under this correlation ID. If you leave this
field empty, this value will be generated automatically at runtime.

When this option is enabled, tESBConsumer will also extract the correlation ID from the
response header and store it in the component variable for further use in the
flow.

This option will be enabled automatically when the Use Service Registry
check box is selected. | | Use GZip Compress | Select this check box to compress the incoming messages into GZip format before
sending. | | Die on error | Select this check box to kill the Job when an error occurs. | ## Advanced settings | Properties | Description | | --- | --- | | Log messages | Select this check box to log the message exchange between
the service provider and the consumer. | | Service Locator Custom Properties | This table appears when Use Service Locator
is selected. You can add as many lines as needed in the table
to customize the relevant properties. Enter the name and the value of each
property between double quotation marks in the Property Name field and the Property
Value field respectively. | | Service Activity Custom Properties | This table appears when Use Service Activity
Monitor is selected. You can add as many lines as needed
in the table to customize the relevant properties. Enter the name and
the value of each property between double quotation marks in the
Property Name field and the
Property Value field
respectively. | | Connection time out(second) | Set a value in seconds for Web service connection time out.

This option only works in Talend Studio. To use it after the component is deployed in runtime:

Create a configuration file with the name org.apache.cxf.http.conduits-<endpoint_name>.cfg in the <TalendRuntimePath>/container/etc/ folder.
Specify the url of the Web service and the client.ConnectionTimeout parameter in milliseconds in the configuration file. If you need to use the Receive time out option, specify the client.ReceiveTimeout in milliseconds too. The url can be a full endpoint address or a regular expression containing wild cards, for example:
```
url = http://localhost:8040/*client.ConnectionTimeout=10000000client.ReceiveTimeout=20000000
```
, in which http://localhost:8040/* matches all URLs starting with http://localhost:8040/.

| | Receive time out(second) | Set a value in seconds for server answer.

This option only works in Talend Studio. For how to use it after the component is deployed in runtime, see the
Connection time out option. | | Disable Chunking | Select this check box to disable encoding the payload as chunks. In
general, chunking will perform better as the streaming can take place
directly. But sometimes the payload is truncated with chunking enabled.
If you are getting strange errors when trying to interact with a
service, try turning off chunking to see if that helps. | | Trust server with SSL/TrustStore
file and TrustStore password | 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. | | Use http proxy/Proxy host, Proxy
port, Proxy user, and
Proxy password | Select this check box if you are using a proxy server and fill in the
necessary information.

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. | | HTTP Headers | Click [+] as many times as
required to add the name-value pair(s) for HTTP headers to define the
parameters of the requested HTTP operation. | | 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 | NB\_LINE:
the number of rows processed. This is an After variable and it returns an integer.

CORRELATION\_ID:
the correlation ID by which chained service calls will be grouped. This is a Flow
variable and it returns a string.

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.

HTTP\_RESPONSE\_CODE: HTTP response status code. This is an After
variable and it returns an Integer.

HTTP\_HEADERS: the set of HTTP headers
from response. This is a Flow variable and it returns map object java.util.Map<String, java.util.List<?>>.
Header name is represented by map key. Header values are represented by java.util.List<?>.

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 intermediate component. It requires
to be linked to an output component. | | Dynamic settings | Click the [+] button to add a row in the
table and fill the Code field with a context variable
to turn on or off the Use Authentication or
Use HTTP proxy option dynamically at runtime. You
can add two rows in the table to set both options.

Once a dynamic parameter is defined, the corresponding option becomes
highlighted and unusable in the Basic settings view
or Advanced settings view.

For examples on using dynamic parameters, see [Reading data from databases through
context-based dynamic connections](https://help.qlik.com/talend/r/en-US/8.0/components/defining-context-groups/reading-data-from-databases-through-context-based-dynamic-connections) and [Reading data from different MySQL databases
using dynamically loaded connection parameters](https://help.qlik.com/talend/r/en-US/8.0/components/context/reading-data-from-different-mysql-databases-using-dynamically-loaded-connection-parameters). For more information on
Dynamic settings and context variables, see
[Dynamic schema](https://help.qlik.com/talend/r/en-US/8.0/studio-user-guide/dynamic-schema) and [Creating a context group and define context
variables in it](https://help.qlik.com/talend/r/en-US/8.0/studio-user-guide/creating-context-group-and-define-context-variables-in-it). | | Limitation | A JDK is required for this component to operate. | **Related concepts** * [Requesting airport names based on country codes](https://help.qlik.com/talend/en-US/components/8.0/esb-soap/tesbconsumer-tesbproviderfault-tmap-requesting-airport-names-based-on-country-codes-standard-component-esb-this) * [Returning Hello world response](https://help.qlik.com/talend/en-US/components/8.0/esb-soap/tesbconsumer-tesbproviderrequest-tfixedflowinput-returning-hello-world-response-standard-component-esb-the) * [Sending a message without expecting a response](https://help.qlik.com/talend/en-US/components/8.0/esb-soap/tesbconsumer-tesbproviderrequest-tlogrow-tfixedflowinput-sending-message-without-expecting-response-standard-component-esb-the) * [Using tESBConsumer with custom SOAP Headers](https://help.qlik.com/talend/en-US/components/8.0/esb-soap/tesbconsumer-txmlmap-tfixedflowinput-tlogrow-using-tesbconsumer-with-custom-soap-headers-standard-component-this)