tFTPPut - 6.1

Talend Components Reference Guide

EnrichVersion
6.1
EnrichProdName
Talend Big Data
Talend Big Data Platform
Talend Data Fabric
Talend Data Integration
Talend Data Management Platform
Talend Data Services Platform
Talend ESB
Talend MDM Platform
Talend Open Studio for Big Data
Talend Open Studio for Data Integration
Talend Open Studio for Data Quality
Talend Open Studio for ESB
Talend Open Studio for MDM
Talend Real-Time Big Data Platform
task
Data Governance
Data Quality and Preparation
Design and Development
EnrichPlatform
Talend Studio

tFTPPut properties

Component family

Internet/FTP

 

Function

This component copies selected files via an FTP connection.

Purpose

tFTPPut copies selected files from a defined local directory to a destination remote FTP directory.

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

FTP user name.

 

Password

FTP password.

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.

 

Local directory

Path to the source location of the file(s).

 

Remote directory

Path to the destination directory of the file(s).

 

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.

 

Transfer mode

Different FTP transfer modes.

 

Overwrite file or Append

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.

 

FTPS Support

Select this check box to connect to the FTP server via an FTPS connection. Once selected, you need to fill the Keystore File and Keystore Password fields.

 

Keystore File

Specify the path to the file containing the keystore data.

This field appears only when the FTPS Support check box is selected.

 

Keystore Password

Specify the keystore password.

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.

This field appears only when the FTPS Support check box is selected.

  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. This is useful when the name of the file to be used contains special characters such as parentheses.

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

 

Files

Click the [+] button to add a new line, then fill in the columns.

Filemask: file names or path to the files to be transferred.

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

 

Connection Mode

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

 

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 on error and complete the process for error-free rows.

Advanced settings

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.

CURRENT_FILE_EXISTS: the result of whether the current file exists. This is a Flow variable and it returns a boolean.

TRANSFER_MESSAGES: file transferred information. This is an After 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 output 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 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 Guide.

Scenario: Putting files on a remote FTP server

This two-component Job allows you to open a connection to a remote FTP server in order to put specific files on the remote server in one transaction.

Dropping and linking components

  1. Drop tFTPConnection and tFTPPut from the Palette onto the design workspace. tFTPConnection allows you to perform all operations in one transaction.

  2. Connect the two components together using an OnSubJobOK link.

Configuring the components

Configuring a connection to the FTP server

  1. Double-click tFTPConnection to display its Basic settings view and define its properties.

  2. In the Host field, enter the server IP address.

  3. In the Port field, enter the listening port number.

  4. In the Username and Password fields, enter your login and password for the remote server.

  5. From the Connect Mode list, select the FTP connection mode you want to use, Active in this example.

Configuring file upload to the FTP server

  1. In the design workspace, double-click tFTPPut to display its Basic settings view and define its properties.

  2. Select the Use an existing connection check box and then select tFTPConnection_1 from the Component List. The connection information is automatically filled in.

  3. In the Local directory field, enter the path to the local directory containing the files, if all your files are in the same directory. If the files are in different directories, enter the path for each file in the Filemask column of the Files table.

  4. In the Remote directory field, enter the path to the destination directory on the remote server. Clear the Move to the current directory check box.

  5. From the Transfer mode list, select the transfer mode to be used.

  6. From the Overwrite file list, select an option for the transferred file.

  7. In the Files table, click twice the plus button to add two lines to the Filemask column and then fill in the filemasks of all files to be copied onto the remote directory.

Saving and executing the Job

  1. Press Ctrl+S to save your Job.

  2. Press F6 or click Run on the Run tab to execute the Job.

    The files specified in the Filemask column are copied to the remote server.