tServerAlive Properties - 6.1

Talend Components Reference Guide

EnrichVersion
6.1
EnrichProdName
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for Big Data
Talend Open Studio for Data Integration
Talend Open Studio for Data Quality
Talend Open Studio for ESB
Talend Open Studio for MDM
Talend Real-Time Big Data Platform
task
Data Governance
Data Quality and Preparation
Design and Development
EnrichPlatform
Talend Studio

Component family

Misc

 

Function

tServerAlive validates the status of the connection to a specified host.

Purpose

tServerAlive helps you check whether the connection to a specified host is up or down, which is indicated by the boolean value returned by the global variable SERVER_ALIVE_RESULT.

Basic settings

Protocol

Select either Ping or Telnet from the drop-down list of protocols.

 

Host

IP address or host name of the remote server to be checked.

 

Timeout Interval (in seconds)

Enter the timeout interval in seconds. If the target host is reached within this time, the component's global variable SERVER_ALIVE_RESULT will be set to true, otherwise false.

 

Port

Listening port number of the Telnet server.

Available when Telnet is selected from the Protocol drop-down list.

Advanced settings

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

SERVER_ALIVE_RESULT: the status of the connection to a remote host. This is an After variable and it returns a boolean.

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

This component is generally used as a one-component subjob.

Limitation