August 15, 2023

tFTPPut – Docs for ESB 6.x

tFTPPut

Copies selected files from a defined local directory to a destination remote FTP
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
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

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

Usage rule

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

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. You can find more details about how to install external modules in Talend Help Center (https://help.talend.com).

Scenario: Putting files onto an FTP server

Here is an example of using Talend FTP components to put several files in
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.

Use_Case_tFTP.png

  1. 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.
  2. Link the tFTPConnection component to
    the tFTPPut component using a Trigger > OnSubjobOk
    connection.
  3. Link the tFTPPut component to the
    tFTPClose component using a Trigger > OnSubjobOk
    connection.

Opening a connection to the FTP server

Configure the tFTPConnection
component to open a connection to the FTP server.

  1. Double-click the tFTPConnection
    component to open its Basic settings view.

    Use_Case_tFTP0.png

  2. In the Host and Port fields, enter the FTP server IP address and the listening port
    number respectively.
  3. In the Username and Password fields, enter the authentication details.
  4. 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

Configure the tFTPPut
component to put several local files onto the FTP server root directory.

  1. Double-click the tFTPPut component to
    open its Basic settings view.

    Use_Case_tFTP1.png

  2. 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.
  3. 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.
  4. 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.
  5. Clear the Move to the current
    directory
    check box.
  6. 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

Configure the tFTPClose
component to close the connection to the FTP server.

  1. Double-click the tFTPClose component
    to open its Basic settings view.

    ftp_tftpclose_basic.png

  2. 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

After setting up the Job and configuring the components used in
the Job for putting files onto the FTP server, you can then execute the Job and verify
the Job execution result.

  1. Press Ctrl + S to save the Job and
    then F6 to execute the Job.
  2. Connect to the FTP server to verify the result.

    ftp_job_put_files_result.png

    As shown above, only the text and png files in the local directory are put onto
    the FTP server.

Document get from Talend https://help.talend.com
Thank you for watching.
Subscribe
Notify of
guest
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x