tFTPPut Standard properties - Cloud - 8.0

FTP

Version
Cloud
8.0
Language
English
Product
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 ESB
Talend Real-Time Big Data Platform
Module
Talend Studio
Content
Data Governance > Third-party systems > Internet components (Integration) > FTP components
Data Quality and Preparation > Third-party systems > Internet components (Integration) > FTP components
Design and Development > Third-party systems > Internet components (Integration) > FTP components

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

The Standard tFTPPut 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 drop-down list, select the desired 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, enter the password in double quotes in the pop-up dialog box, and click OK to save the settings.

Local directory

The local directory from which the files will be uploaded to the FTP server.

Remote directory

The FTP directory where the uploaded files will be placed.

Transfer mode

Select the transfer mode from the list, either ascii or binary.

Overwrite file

Select the action to be performed when the file already exists.

  • never: Never overwrite the file.

  • always: Always overwrite the file.

  • size different or: Overwrite the file when the file size is different.

  • overwrite: Overwrite the existing file.

  • resume: Resume downloading the file from the point of interruption.

  • append: Add data to the end of the file without overwriting data.

overwrite, resume, and append are available when the SFTP Support check box is selected.

Append

Select this check box to append data at the end of the file in order to avoid overwriting data.

SFTP Support

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

Warning: This option does not work with an HTTPS proxy. If you need an HTTPS proxy, use the tSetProxy component.

Authentication method

Select the SFTP authentication method, Public key, Password, or Public key and 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.

  • Public key and password: Select this option if the SFTP server requires both a public key and a password for authentication. In this case, you need to provide the password, the private key file, and the key passphrase in the corresponding fields.

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.

Depending on the FTPS server configuration, an FTPS server private key or a client certificate is needed to establish an FTPS connection. You can store the FTP server private key or your client certificate in the keystore file.

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.

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

Specify the files to be uploaded.

  • Filemask: the file names or the path to the files to be uploaded.

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

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.

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.

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.

Enable Remote Verification

Select this option to enable remote verification. This option solves FTPS server architecture compatibility issues. See setRemoteVerificationEnabled for related information.

This option is available when FTPS Support is selected in the Basic settings view.

Use strict reply parsing

Select this option to use strict reply parsing.

Config client

Select this option to set JSch encryption algorithm properties. To set an encryption algorithm property, add a row in the table that appears by clicking the plus button on the bottom of the table and enter property name and property value in the Client parameter and Value columns. See Fork of JSch-0.1.55 and the setConfig section at Class JSch for related information.

This option is available when the Use an existing connection option is not selected and the SFTP Support option is selected in the Basic settings view.

Note: This option is available only when you have installed the 8.0.1-R2022-07 Studio Monthly update or a later one delivered by Talend. For more information, check with your administrator.

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.

CURRENT_FILE_EXISTS

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

TRANSFER_MESSAGES

The file transferred information. This is an After 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 output component.