August 15, 2023

tFTPGet – Docs for ESB 6.x

tFTPGet

Retrieves selected files from a defined remote FTP directory and copies them to a
local directory.

tFTPGet Standard properties

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

The Standard
tFTPGet component belongs to the Internet family.

The component in this framework is generally available.

Basic settings

Property Type

Either Built-in or Repository.

 

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.

  • never: Never overwrite
    the file.

  • always: Always overwrite
    the file.

  • size different: Overwrite
    the file when the file size is different.

  • 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.

overwrite, resume, and append
are available when the SFTP Support
check box is selected.

Append

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

SFTP Support

Select this check box to connect to the FTP server via an SFTP connection. The following
properties will be available:

Authentication method: Select the SFTP authentication
method, either Public key or Password.

  • Public key: Enter the path to the private key
    and the passphrase for the key in the Private
    key
    and Key Passphrase fields
    correspondingly.

  • Password: Enter the password required.

Filename encoding: Select this check box to set the
encoding used to convert file names from Strings to bytes. It should be the same encoding
used on the SFTP server.

Note:

If the SFTP server’s version is greater than 3, the encoding should be UTF-8, or
else an error occurs.

FTPS Support

Select this check box to connect to the FTP server via an FTPS connection. The following
properties will be available:

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

Keystore Password: Enter your keystore password.

Security Mode: Select the security mode from the list,
either Implicit or Explicit.

Use Perl5 Regex Expression as
Filemask

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.

Connection Mode

Select the connect mode from the list, either Passive or
Active.

Encoding

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

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

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

Usage rule

This component is typically used as a single-component sub-job but
can also be used as output or end object.

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. You can find more details about how to install external modules in Talend Help Center (https://help.talend.com).

Related scenario


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