August 17, 2023

tFTPDelete – Docs for ESB 5.x

tFTPDelete

tFTPDelete_icon32.png

tFTPDelete properties

Component family

Internet/FTP

 

Function

This component deletes specified files via an FTP
connection.

Purpose

tFTPDelete deletes files on a
remote 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.

 

Host

FTP IP address

 

Port

The FTP server listening port number.

 

Username and
Password

FTP user authentication data.

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

Source directory where the files to be deleted are located.

 

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.

 

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.

Note

If you select Public Key as
the SFTP authentication method, make sure that the key is added
to the agent or that no passphrase (secret phrase) is required.

  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 name or path to the files to be deleted. You can specify
multiple files in a line by using wildcards or a regular
expression.

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.

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

Related scenario

For tFTPDelete related scenario, see Scenario: Putting files on a remote FTP server.


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