tFTPRename - 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

tFTPRename renames the selected files via an FTP connection.

Purpose

tFTPRename renames files on an FTP server.

tFTPRename 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/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

FTP server listening port number.

 

Username

Connection login to the FTP server.

 

Password

Connection password to 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

Path to the remote directory.

 

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.

 

Overwrite file

List of available options for the transferred file.

 

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.

 

Files

Click the [+] button to add the lines you want to use as filters:

Filemask: enter the filename or filemask using wildcharacters (*) or regular expressions.

New name: name to give to the FTP file after the transfer.

 

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.

 

Die on error

This check box is selected by default. Clear the check box to skip the row in 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.

 

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

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 generally used as a subjob with one component, but it can also be used as an output or end component..

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.

Scenario: Renaming a file located on an FTP server

Here is an example of using Talend FTP components to rename a file located on an FTP server.

Creating a Job for renaming a file on an FTP server

Create a Job to connect to an FTP server, then rename a file on the server, finally close the connection to the server.

Prerequisites: To replicate this scenario, an FTP server must be started and a file must be put onto the server. In this example, the file movies.json has been put into the folder movies under the root directory of the FTP server.

  1. Create a new Job and add a tFTPConnection component, a tFTPRename component, and a tFTPClose component by typing their names in the design workspace or dropping them from the Palette.

  2. Link the tFTPConnection component to the tFTPRename component using a Trigger > OnSubjobOk connection.

  3. Link the tFTPRename component to the tFTPClose component using a Trigger > OnSubjobOk connection.

Opening a connection to the FTP server

Configure the tFTPConnection component to open a connection to the FTP server.

  1. Double-click the tFTPConnection component to open its Basic settings view.

  2. In the Host and Port fields, enter the FTP server IP address and the listening port number respectively.

  3. In the Username and Password fields, enter the authentication details.

Renaming the file on the FTP server

Configure the tFTPRename component to rename the file on the FTP server.

  1. Double-click the tFTPRename component to open its Basic settings view.

  2. Specify the connection details required to access the FTP server. In this example, select the Use an existing connection check box and from the Component list drop-down list displayed, select the connection component to reuse its connection details you have already defined.

  3. In the Remote directory field, enter the directory on the FTP server where the file to be renamed exists. In this example, it is /movies.

  4. Clear the Move to the current directory check box.

  5. In the Files table, click the [+] button to add a line, and then enter the existing file name in the Filemask column field and the new file name in the New name column field. In this example, they are movies.json and action_movies.json respectively.

Closing the connection to the FTP server

Configure the tFTPClose component to close the connection to the FTP server.

  1. Double-click the tFTPClose component to open its Basic settings view.

  2. From the Component list drop-down list, select the tFTPConnection component that opens the connection you need to close. In this example, only one tFTPConnection component is used and it is selected by default.

Executing the Job to rename the file on the FTP server

After setting up the Job and configuring the components used in the Job for renaming the file on the FTP server, you can then execute the Job and verify the Job execution result.

  1. Press Ctrl + S to save the Job and then F6 to execute the Job.

  2. Connect to the FTP server to verify the result.

    As shown above, the file on the FTP server has been renamed from movies.json to action_movies.json.