tHttpRequest properties - 6.1

Talend Open Studio for Big Data Components Reference Guide

EnrichVersion
6.1
EnrichProdName
Talend Open Studio for Big Data
task
Data Governance
Data Quality and Preparation
Design and Development
EnrichPlatform
Talend Studio

Component family

Internet

 

Function

This component sends an HTTP request to the server end and gets the corresponding response information from the server end.

Purpose

The tHttpRequest component allows you to send an HTTP request to the server and output the response information locally.

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.

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 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 three-dot 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.

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.

 

Die on error

Select this 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. When errors are skipped, you can collect the rows on error using a Row > Reject link.

Advanced settings

tStatCatcher Statistics

Select this check box to gather the Job processing metadata at a Job level and 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.

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

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.

Log4j

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 http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/Level.html.

Limitation

N/A