tFTPFileProperties Standard properties

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.

A schema is a row description, and it defines the fields to be processed and passed on to the next component.

The schema of this component is read-only. It describes the main properties of the specified file. You can click the [...] button next to Edit schema to view the predefined schema which contains the following fields:

• abs_path: the absolute path of the file.

• dirname: the directory of the file.

• basename: the name of the file.

• size: the file size in bytes.

• mtime: the timestamp indicating the period between the Unix epoch (00:00:00 UTC, Jan 1, 1970) and the time the file was last modified, measured in milliseconds in the FTP/FTPS mode and in seconds in the SFTP mode (that is, the SFTP Support option is selected in the Basic settings view).

• mtime_string: the date and time the file was last modified.

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, and then in the pop-up dialog box enter the password between double quotes and click OK to save the settings.

Remote directory

The path to the directory where the file is available.

File

The name of the file or the path to the file whose properties will be retrieved.

Transfer mode

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

SFTP Support

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

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.

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.

Calculate MD5 Hash

Select this check box to check the file's MD5.

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.

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.

Connection timeout

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.

tStatCatcher Statistics

Select this check box to gather the Job processing metadata at the Job level as well as at each component level.

ERROR_MESSAGE

The error message generated by the component when an error occurs. This is an After variable and it returns a string.

Usage rule

This component can be used as standalone component.