tESBProviderRequest Standard properties

These properties are used to configure tESBProviderRequest running in the Standard Job framework.

The Standard tESBProviderRequest component belongs to the ESB family.

This component is relevant only when used with one of the Talend solutions with ESB, as it should be used with the Service Repository node and the Data Service creation related wizard(s).

Basic settings

Property Type	Either Built-in or Repository .
	Built-in: No WSDL file is configured for the Job.
	Repository: Select the desired web service from the Repository, to the granularity of the port name and operation.
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 Talend Studio User Guide.
	Repository: The schema is created and stored in the Repository, hence can be reused. Related topic: see Talend Studio User Guide.
Keep listening	Check this box when you want to ensure that the provider (and therefore Talend Job) will continue listening for requests after processing the first incoming request.

Advanced settings

Log messages (Studio only)	Select this check box to log the message exchange between the service provider and the consumer. This option works in the Studio only.
Response timeout, sec	Specify the time limit in seconds for sending response to the consumer. This parameter is necessary to avoid locking of message exchanges.
Request processing queue size	Specify the maximum number of received requests that can be processed in parallel by the components between tESBProviderRequest and tESBProviderResponse. Note that this parameter is different from the queueSize in the <TalendRuntimePath>\etc\org.apache.cxf.workqueues-default.cfg which defines pool configuration for incoming requests on CXF level.
Request processing timeout, sec	Specify the time limit in seconds for requests to be processed by the components between the tESBProviderRequest and the tESBProviderResponse.
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

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. SECURITY_TOKEN: the user identity information in the request header. This is a Flow variable and it returns an XML node. HEADERS_SOAP: the headers of the SOAP request. This is a Flow variable and it returns all SOAP request headers. HEADERS_HTTP: the headers of the HTTP request. This is a Flow variable and it returns all HTTP request headers. 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.

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.

SECURITY_TOKEN: the user identity information in the request header. This is a Flow variable and it returns an XML node.

HEADERS_SOAP: the headers of the SOAP request. This is a Flow variable and it returns all SOAP request headers.

HEADERS_HTTP: the headers of the HTTP request. This is a Flow variable and it returns all HTTP request headers.

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.

Usage

Usage rule	This component covers the possibility that a Talend Job can be wrapped as a service, with the ability to input a request to a service into a Job and return the Job result as a service response. The tESBProviderResponse component can both deliver the payload of a SOAP message and also access the HTTP and SOAP headers of a service. The tESBProviderRequest component should be used with the tESBProviderResponse component to provide a Job result as a response, in case of a request-response communication style. When the SAML Token or the Service Registry is enabled in the service runtime options and if the SAML Token exists in the request header, the tESBProviderRequest component will get and store the SAML Token in the component variable for further use in the flow. The tESBProviderRequest component will get the Correlation Value in the request header if it exists and stored it in the component variable. When the Business Correlation or the Service Registry is enabled in the service runtime options, the Correlation Value will also be added to the response. In this case, tESBProviderRequest will create a Correlation Value if it does not exist. Note that the Service Registry option is only available if you subscribed to Talend Enterprise ESB solutions. For more information about how to set the runtime options, see the corresponding section in the Talend Studio User Guide.
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 Keep listening option dynamically at runtime. When a dynamic parameter is defined, the corresponding Keep listening option in the Basic settings view becomes unusable. For examples on using dynamic parameters, see Reading data from databases through context-based dynamic connections and Reading data from different MySQL databases using dynamically loaded connection parameters. For more information on Dynamic settings and context variables, see Talend Studio User Guide.
Limitation	A JDK is required for this component to operate.

Usage rule

This component covers the possibility that a Talend Job can be wrapped as a service, with the ability to input a request to a service into a Job and return the Job result as a service response.

The tESBProviderResponse component can both deliver the payload of a SOAP message and also access the HTTP and SOAP headers of a service.

The tESBProviderRequest component should be used with the tESBProviderResponse component to provide a Job result as a response, in case of a request-response communication style.

When the SAML Token or the Service Registry is enabled in the service runtime options and if the SAML Token exists in the request header, the tESBProviderRequest component will get and store the SAML Token in the component variable for further use in the flow.

The tESBProviderRequest component will get the Correlation Value in the request header if it exists and stored it in the component variable. When the Business Correlation or the Service Registry is enabled in the service runtime options, the Correlation Value will also be added to the response. In this case, tESBProviderRequest will create a Correlation Value if it does not exist.

Note that the Service Registry option is only available if you subscribed to Talend Enterprise ESB solutions. For more information about how to set the runtime options, see the corresponding section in the Talend Studio User Guide.

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 Keep listening option dynamically at runtime.

When a dynamic parameter is defined, the corresponding Keep listening option in the Basic settings view becomes unusable.

For examples on using dynamic parameters, see Reading data from databases through context-based dynamic connections and Reading data from different MySQL databases using dynamically loaded connection parameters. For more information on Dynamic settings and context variables, see Talend Studio User Guide.

Limitation

A JDK is required for this component to operate.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!

Leave your feedback here