July 30, 2023

tFTPDelete – Docs for ESB 7.x

tFTPDelete

Deletes files or folders in a specified directory on an FTP server.

tFTPDelete Standard properties

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

The Standard
tFTPDelete component belongs to the Internet
family.

The component in this framework is available in all Talend
products
.

Basic settings

Property Type

Select the way the connection details
will be set.

  • Built-In: The connection details will be set
    locally for this component. You need to specify the values for all
    related connection properties manually.

  • Repository: The connection details stored
    centrally in Repository > Metadata will be reused by this component. You need to click
    the […] button next to it and in the pop-up
    Repository Content dialog box, select the
    connection details to be reused, and all related connection
    properties will be automatically filled in.

Use an existing connection

Select this check box and in the Component List click the relevant connection component to
reuse the connection details you already defined.

Host

The IP address or hostname of the FTP server.

Port

The listening port number of the FTP server.

Username and Password

The user authentication data to access the FTP server.

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

The directory where the files/folders to be deleted are located.

Move to the current directory

Select this check box to change the directory to the one specified in the
Remote directory field. The next FTP component in the Job will
take this directory as the root of the remote directory when using the same
connection.

This property is available only when the Use an existing
connection
check box is selected.

SFTP Support

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

Warning: This option does not work with an HTTP/HTTPS proxy. If you need a
proxy, set a SOCKS proxy in the Advanced settings tab.

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.

This property is available only when the
SFTP Support check box is selected.

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. If the SFTP server’s
version is greater than 3, the encoding should be UTF-8, or else
an error occurs.

This property is available only when the
SFTP Support check box is selected.

FTPS Support

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

If you are using an HTTP proxy, via a tSetProxy component for example,
you need to select this check box and set the connection mode to
Passive.

Keystore File

The path to your keystore file, a password protected file containing several keys and
certificates.

This property is available only when the
FTPS Support check box is selected.

Keystore Password

The password for your keystore file.

This property is available only when the
FTPS Support check box is selected.

Security Mode

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

This property is available only when the
FTPS Support check box is selected.

Use Perl5 Regex Expression as Filemask

Select this check box to use Perl5 regular expressions in the
or
Files field as file filters. This is useful when the name of
the file to be processed contains special characters such as parentheses.

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

Files

The names of the files/folders or the paths to the
files/folders to be deleted. You can specify multiple files/folders in a line
by using wildcards or a regular expression.

Target Type

Select the type of the target to be deleted, either File
or Directory.

Connection mode

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

Encoding

Specify the encoding type by selecting an encoding type from the list or selecting
CUSTOM and enter the encoding type manually.

Die on error

Select the check box to stop the execution of the Job when an error occurs.

Clear the check box to skip any error and continue the Job execution process.

Advanced settings

Use Socks Proxy

Select this check box if you are using a proxy, and in the Proxy
host
, Proxy port, Proxy user
and Proxy password fields displayed, specify the proxy server
settings information.

Ignore Failure At Quit (FTP)

Select this check box to ignore library closing errors or FTP closing errors.

Data Channel Protection Level

The data channel protection level with which data is transferred between the client and
the server. For more information, see RFC
2228: FTP Security Extensions
.

This property is available only
when the FTPS Support check box is selected.

Protection Buffer Size

The maximum size (in bytes) of the encoded data blocks to be transferred between the
client and the server. For more information, see RFC
2228: FTP Security Extensions
.

This property is available only
when the FTPS Support check box is selected.

Connection timeout

Specify the timeout value (in ms) for the connection. A value of 0
or any negative values will be ignored. In this case, the default value (that is, 60000ms)
will be used.

tStatCatcher Statistics

Select this check box to gather the Job processing metadata at the 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.

NB_FILE

The number of the 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.

Usage

Usage rule

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

Related scenario

No scenario is available for this component yet.


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