July 30, 2023

tFTPRename – Docs for ESB 7.x

  2. Talend for ESB Docs
  3. Docs 7.x
  4. tFTPRename – Docs for ESB 7.x

tFTPRename

Renames files in an FTP directory.

tFTPRename Standard properties

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

The Standard
tFTPRename 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 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.

Remote directory

The path to the FTP directory where the files to be renamed are
available.

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.

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.

SFTP Support

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

Warning: This option does not work with an HTTP/HTTPS proxy. If you need a
proxy, set a SOCKS proxy in the Advanced settings tab.

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.

Files

Specify the files to be renamed and their new names.

  • Filemask: specify the file to be renamed by
    entering the filename or filemask using wildcharacters or regular
    expressions.

  • New name: enter
    the new name of the file.

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.

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

 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.

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.

Usage

Usage rule

This component is generally used as a subJob with one
component, but it can also be used as an output or end component.

Renaming a file located on an FTP server

Here is an example of using Talend FTP components to rename a file located on an FTP server.

Creating a Job for renaming a file on an FTP server

Create a Job to connect to an FTP server, then rename a file on the
server, finally close the connection to the server.

tFTPRename_1.png

Prerequisites: To replicate this
scenario, an FTP server must be started and a file must be put onto the server. In this
example, the file movies.json has been put into the folder movies under the root directory of the FTP server.

tFTPRename_2.png

  1. Create a new Job and add a tFTPConnection component, a tFTPRename 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 tFTPRename component using a Trigger > OnSubjobOk
    connection.
  3. Link the tFTPRename 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.
  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.

Renaming the file on the FTP server

Configure the tFTPRename
component to rename the file on the FTP server.

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

    tFTPRename_3.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 Remote directory field, enter
    the directory on the FTP server where the file to be renamed exists. In this
    example, it is /movies.
  4. Clear the Move to the current
    directory     check box.
  5. In the Files table, click the
    [+] button to add a line, and then enter the
    existing file name in the Filemask column field and
    the new file name in the New name column field. In
    this example, they are movies.json and action_movies.json respectively.

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.

    tFTPRename_4.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 rename the file on the FTP server

After setting up the Job and configuring the components used in
the Job for renaming the file on 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.

    tFTPRename_5.png

    As shown above, the file on the FTP server has been renamed from movies.json to action_movies.json.
Document get from Talend https://help.talend.com
Thank you for watching.
Docs 7.x
Subscribe
Notify of
guest
0 Comments
Inline Feedbacks
View all comments
0
Would love your thoughts, please comment.x
()
x