August 15, 2023

tFTPFileExist – Docs for ESB 6.x

tFTPFileExist

Checks if a file exists on an FTP server.

tFTPFileExist Standard properties

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

The Standard
tFTPFileExist 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

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.

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.

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

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

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

Usage rule

This component is typically used as a single-component sub-job but
can also be used with other components.

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

For a related scenario using a different protocol, see Scenario: handling a file using SCP.


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