tFTPPut
directory.
tFTPPut Standard properties
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 generally available.
Basic settings
Property Type |
Either Built-in or Repository. |
|
Built-in: No property data stored |
|
Repository: Select the Repository |
Use an existing connection/Component List |
Select this check box and in the Component |
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 |
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 |
Transfer mode |
Different FTP transfer modes. |
Overwrite file |
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
Authentication method: Select the SFTP authentication
method, either Public key or Password.
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 |
FTPS Support |
Select this check box to connect to the FTP server via an FTPS |
Keystore File |
Specify the path to the file containing the keystore data. This field appears only when the FTPS |
Keystore Password |
Specify the keystore password. To enter the password, click the […] button next to the This field appears only when the FTPS |
Use Perl5 Regex Expression as Filemask |
Select this check box if you want to use Perl5 regular expressions in the Files field as file For information about Perl5 regular expression syntax, see Perl5 Regular Expression Syntax. |
Files |
Click the [+] button to add a new
Filemask: file names or path to the
New name: name to give the FTP file |
Connection Mode |
Select the connect mode from the list, either Passive or |
Encoding |
Select an encoding type from the list, or select Custom |
Die on error |
This check box is selected by default. Clear the check box to skip |
Advanced settings
tStatCatcher Statistics |
Select this check box to gather the Job processing metadata at a |
Global Variables
Global Variables |
ERROR_MESSAGE: the error message generated by the
NB_FILE: the number of files processed. This is an After
CURRENT_STATUS: the execution result of the component.
CURRENT_FILE_EXISTS: the result of whether the current
TRANSFER_MESSAGES: file transferred information. This is A Flow variable functions during the execution of a component while an After variable To fill up a field or expression with a variable, press Ctrl + For further information about variables, see |
Usage
Usage rule |
This component is typically used as a single-component sub-job but |
Limitation |
Due to license incompatibility, one or more JARs required to use this component are not |
Scenario: Putting files onto an FTP server
a local directory onto an FTP server.
Creating a Job for putting files onto an FTP server
Create a Job to connect to an FTP server, then put several local files
onto the server, finally close the connection to the server.

-
Create a new Job and add a tFTPConnection component, a tFTPPut
component, and a tFTPClose component by typing
their names in the design workspace or dropping them from the Palette. -
Link the tFTPConnection component to
the tFTPPut component using a Trigger > OnSubjobOk
connection. -
Link the tFTPPut component to the
tFTPClose component using a Trigger > OnSubjobOk
connection.
Opening a connection to the FTP server
component to open a connection to the FTP server.
-
Double-click the tFTPConnection
component to open its Basic settings view. -
In the Host and Port fields, enter the FTP server IP address and the listening port
number respectively. - In the Username and Password fields, enter the authentication details.
-
From the Connection Mode drop-down
list, select the FTP connection mode you want to use, Active in this example.
Putting files onto the FTP server
component to put several local files onto the FTP server root directory.
-
Double-click the tFTPPut component to
open its Basic settings view. -
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. -
In the Local directory field, specify
the local directory that contains the files to be put onto the FTP server. In this
example, it is D:/components. -
In the Remote directory field, specify
the FTP server directory onto which the files will be put. In this example, it is
/, which means the root directory of the FTP
server. -
Clear the Move to the current
directory check box. -
In the Files table, click twice the
[+] button to add two lines, and in the two
Filemask column fields, enter *.txt and *.png
respectively, which means only the text and png files in the specified local
directory will be put onto the FTP server root directory.
Closing the connection to the FTP server
component to close the connection to the FTP server.
-
Double-click the tFTPClose component
to open its Basic settings view. -
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 put files on the FTP server
the Job for putting files onto the FTP server, you can then execute the Job and verify
the Job execution result.
-
Press Ctrl + S to save the Job and
then F6 to execute the Job. -
Connect to the FTP server to verify the result.
As shown above, only the text and png files in the local directory are put onto
the FTP server.