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 click the relevant 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.

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.

Move to the current directory

Select this check box to change the directory to the one specified in the
Remote directory field. The next FTP component in the Job will
take this directory as the root of the remote directory when using the same
connection.

This property is available only when the Use an existing
connection check box is selected.

Transfer mode

Select the transfer mode from the list, either asciibinary.

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.

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.

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.

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.

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.

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.

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

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.

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.

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 rule

This component is typically used as a single-component subJob
but can also be used as output component.