tHttpRequest Standard properties

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

The Standard tHttpRequest component belongs to the Internet family.

The component in this framework is available in all Talend products.

Basic settings

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. 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 and store the schema locally for this component only. 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 designs. Related topic: see Talend Studio User Guide.
Sync columns	Click this button to retrieve the schema from the preceding component.
URI	Type in the Uniform Resource Identifier (URI) that identifies the data resource on the server. A URI is similar to a URL, but more general.
Method	Select an HTTP method to define the action to be performed: Post: Sends data (for example HTML form data) to the server end. Get: Retrieves data from the server end.
Post parameters from file	Browse to, or enter the path to the file that is used to provide parameters (request body) to the POST method.
Write response content to file	Select this check box to save the HTTP response to a local file. You can either type in the file path in the input field or click the [...] button to browse to the file path.
Create directory if not exists	Select this check box to create the directory defined in the Write response content to file field if it does not exist. This check box appears only when the Write response content to file check box is selected and is cleared by default.
Headers	Type in the name-value pair(s) for HTTP headers to define the parameters of the requested HTTP operation. Key: Fill in the name of the header field of an HTTP header. Value: Fill in the content of the header field of an HTTP header. The following gives an example for a Basic authentication implementation. Key: `Authentication` Value: `"Basic "+java.util.Base64.getEncoder().encodeToString("{your_username}:{your_password}".getBytes())` For more information about definition of HTTP headers, please refer to: en.wikipedia.org/wiki/List_of_HTTP_headers.
Need authentication	Select this check box to fill in a user name and a password in the corresponding fields if authentication is needed: user: Fill in the user name for the authentication. password: Fill in the password for the authentication. 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. Information noteNote: This component supports all the authentication schemas described in Http Authentication. If an authentication schema that requires user and password is enabled on the server side (for example, HTTP Digest authentication, NTLM, HTTP Negotiate (SPNEGO), or Kerberos 5), you need to select this option and provide username and password in the corresponding fields.
Die on error	Select the check box to stop the execution of the Job when an error occurs. Clear the check box to skip any rows on error and complete the process for error-free rows.

Advanced settings

Set timeout	Select this check box to specify the connect and read timeout values in the following two fields: Connect timeout(s): Enter the connect timeout value in seconds. An exception will occur if the timeout expires before the connection can be established. The value of 0 indicates an infinite time out. By default, the connect timeout value is 30. Read timeout(s): Enter the read timeout value in seconds. An exception will occur if the timeout expires before there is data available for read. By default, the read timeout value is 0, which indicates an infinite time out.
tStatCatcher Statistics	Select this check box to gather the Job processing metadata at a Job level and at each component level.

Set timeout

Select this check box to specify the connect and read timeout values in the following two fields:

Connect timeout(s): Enter the connect timeout value in seconds. An exception will occur if the timeout expires before the connection can be established. The value of 0 indicates an infinite time out. By default, the connect timeout value is 30.
Read timeout(s): Enter the read timeout value in seconds. An exception will occur if the timeout expires before there is data available for read. By default, the read timeout value is 0, which indicates an infinite time out.

tStatCatcher Statistics

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

Global Variables

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. CONNECTED: the result of whether a connection to the server established. This is an After variable and it returns a boolean. RESPONSE_CODE: the response code returned by the remote HTTP server. 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.

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.

CONNECTED: the result of whether a connection to the server established. This is an After variable and it returns a boolean.

RESPONSE_CODE: the response code returned by the remote HTTP server. 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.

Usage

Usage rule	This component can be used in sending HTTP requests to server and saving the response information. This component can be used as a standalone component.

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