tFTPFileProperties – Docs for ESB 5.x

Component family

Internet

Function

tFTPFileProperties iterates on
files and/or folders of a given directory on a remote host.

Purpose

tFTPFileProperties retrieves
files and /or folders based on a defined filemask pattern and
iterates on each of them by connecting to a remote directory via an
FTP protocol.

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.

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:

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.

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.

Remote directory

Path to the source directory where the files can be
fetched.

File

Name or path to the file to be processed and/or the variable to be
used.

For further information about how to define and use a variable in
a Job, see Talend Studio
User Guide.

SFTP Support and 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.

If you do not select the check box, choose the 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

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

Calculate MD5 Hash

Select this check box to check the downloaded file’s MD5.

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.

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 as standalone component.

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.