tFTPGet – Docs for ESB 5.x

Component family

Internet/FTP

Function

This component retrieves specified files via an FTP
connection.

Purpose

tFTPGet retrieves selected files
from a defined remote FTP directory and cop them to a local
directory.

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

Listening port number of the FTP server.

Username

FTP user name.

Password

FTP password.

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.

Local directory

Path to where the file is to be saved locally.

Remote directory

Path to source directory where the files can be fetched.

Move to the current directory

This option appears when Use an existing
connection is enabled. Select this check box to
change the directory to the one specified in the Remote directory field. The next FTP
component that is linked to the tFTPFileList in the Job will take this directory as
the root of the remote directory when using the same
connection.

Transfer mode

Different FTP transfer modes.

Overwrite file

List of file transfer options.

Append: Select this check box to
append the data at the end of the file in order to avoid overwriting
data.

SFTP Support

When you select this check box, the Overwrite file and Authentication method appear.

Overwrite file: Offers three
options:

Overwrite: Overwrite the existing
file.

Resume: Resume downloading the file
from the point of interruption.

Append: Add data to the end of the
file without overwriting data.

Authentication Offers two means of
authentication:

Public key: Enter the access path
to the public key.

Password: Enter the
password.

FTPS Support

Select this check box to connect to an FTP server via an FTPS
connection.

Two fields appear:

Keystore file: Enter the access
path to the keystore file (password protected file containing
several keys and certificates).

Keystore Password: Enter your
keystore password.

Select this check box if you want to use Perl5 regular expressions
in the Files field as file
filters.

For information about Perl5 regular expression syntax, see Perl5 Regular Expression Syntax.

Files

File names or paths to the files to be transferred. You can
specify multiple files in a line by using wildcards or a regular
expression.

Die on error

This check box is selected by default. Clear the check box to skip
the row on error and complete the process for error-free
rows.

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.

Print message

Select this check box to display in the Console the list of files
downloaded.

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.

NB_FILE: the number of files processed. This is an After
variable and it returns an integer.

CURRENT_STATUS: the execution result of the component.
This is a Flow variable and it returns a string.

TRANSFER_MESSAGES: file transferred information. 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 as output or end object.

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.

Limitation

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.