tFTPFileExist – Docs for ESB 5.x

Component family

Internet/FTP

Function

tFTPFileExist checks if a file
exists on an FTP server.

Purpose

tFTPFileExist allows you to check
if a file exists on an FTP server.

Basic settings

Property type

Either Built-in or Repository.

Since version 5.6, both the Built-In mode and the Repository mode are
available in any of the Talend solutions.

Built-in: No property data stored
centrally.

Repository: Select the Repository
file where properties are stored. The following fields are
pre-filled in using fetched data.

Use an existing connection/Component List

Select this check box and in the Component List click the
relevant connection component to reuse the connection details you already defined.

Host

FTP IP address.

Port

The FTP server listening port number.

Username and Password
(or Private key)

User authentication information.

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.

Remote directory

Path to the remote directory.

File Name

Name of the file you want to check exists.

SFTPSupport/ Authentication method

Select this check box and then in the Authentication method list, select the SFTP
authentication method:

Password: Type in the password
required in the relevant field.

Public key: Type in the private key
or click the three dot button next to the Private key field to browse to it.

Connection Mode

Select the SFTP connection mode you want to use:

Active: You determine the
connection port to use to allow data transfer.

Passive: the FTP server determines
the connection port to use to allow data transfer.

Encoding Type

Select an encoding type from the list, or select Custom and define it manually. This field
is compulsory for DB data handling.

Advanced settings

Use Socks Proxy

Select this check box if you want to use a proxy. Then, set the
Host, Port, User and
Password proxy fields.

Ignore Failure At Quit (FTP)

Select this check box to ignore library closing errors or FTP
closing errors.

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

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.

EXISTS: the result of whether a specified file exists.
This is a Flow variable and it returns a boolean.

FILENAME: the name of the file processed. This is an
After variable and it returns a string.

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 typically used as a single-component sub-job but
can also be used with other components.

Log4j

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.

Due to license incompatibility, one or more JARs required to use this component are not
provided. You can install the missing JARs for this particular component by clicking the
Install button on the Component tab view. You can also find out and add all missing JARs easily on
the Modules tab in the Integration perspective
of your studio. For details, see https://help.talend.com/display/KB/How+to+install+external+modules+in+the+Talend+products
or the section describing how to configure the Studio in the Talend Installation and Upgrade
Guide.