tFTPDelete - 6.3

Talend Open Studio for Big Data Components Reference Guide

EnrichVersion
6.3
EnrichProdName
Talend Open Studio for Big Data
task
Data Governance
Data Quality and Preparation
Design and Development
EnrichPlatform
Talend Studio

Function

This component deletes specified files via an FTP connection.

Purpose

tFTPDelete deletes files on a remote FTP server.

tFTPDelete properties

Component family

Internet/FTP

 

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.

 

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

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.

 

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.

  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.

 

Target Type

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

 

Connection Mode

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

 

Die on error

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

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

If you are using a subscription-based version of the Studio, 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 the article Installing External Modules on Talend Help Center (https://help.talend.com) how to configure the Studio in the Talend Installation and Upgrade Guide.

Related scenario

For a related scenario, see Scenario: Putting files onto an FTP server.