Scenario: Renaming a file located on an FTP server - 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

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.