July 30, 2023

tServerAlive – Docs for ESB 7.x

tServerAlive

Validates the status of the connection to a specified host.

tServerAlive checkes 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.

tServerAlive Standard properties

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

The Standard
tServerAlive component belongs to the Misc family.

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

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

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

Usage rule

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

Limitation

Validating the status of the connection to a remote host

In this scenario, tServerAlive is used to ping a
remote host and the value of its global variable SERVER_ALIVE_RESULT is extracted to show the connection status.

Dropping and linking components

  1. Drop the following components from the Palette onto the design workspace: tServerAlive, tFixedFlowInput, and tLogRow.
  2. Connect tServerAlive to tFixedFlowInput using a Trigger > On Subjob Ok
    connection.
  3. Connect tFixedFlowInput to tLogRow using a Row >
    Main
    connection.

    tServerAlive_1.png

Configuring the components

  1. Double-click tServerAlive to open its
    Basic settings view.

    tServerAlive_2.png

  2. In the Protocol drop-down list, select
    Ping.
  3. In the Host field, enter the IP address
    of the remote server to ping.
  4. In the Timeout Interval field, enter the
    timeout interval in seconds.
  5. Double-click tFixedFlowInput to open its
    Basic settings view.

    tServerAlive_3.png

  6. Click the […] button next to Edit schema to open the schema editor.

    tServerAlive_4.png

  7. Click the [+] button to add one column,
    namely status, of the boolean
    type.

    Click OK to validate the schema and close
    the editor.
    In the dialog box that appears, click Yes
    to propagate the changes to the subsequent component.
  8. In the Values table, press the Ctrl + Space keys in the Value field to select tServerAlive_1_SERVER_ALIVE_RESULT from the variable
    list.

    tServerAlive_5.png

  9. Double-click tLogRow to open its
    Basic settings view.

    tServerAlive_6.png

  10. Select Table (print values in cells of a
    table)
    for a better display of the results.

Saving and executing the Job

  1. Press Ctrl+S to save your Job.
  2. Press F6 to execute the Job.

    tServerAlive_7.png

As shown above, the remote server is pingable.


Document get from Talend https://help.talend.com
Thank you for watching.
Subscribe
Notify of
guest
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x