Help Center/ ROMA Connect/ User Guide(new)/ Connectors/ Others/ FTP
Updated on 2025-05-08 GMT+08:00
View PDF
Share

FTP

The FTP connector is a channel for file transfer based on the FTP/SFTP protocol. Through the FTP connector, files can be exchanged with an external FTP server.

  • The File Transfer Protocol (FTP) is in the TCP/IP protocol group. It consists of two parts: FTP server and FTP client. The FTP server is used to store files. Users can use the FTP client to access resources on the FTP server.
  • The SSH File Transfer Protocol (SFTP) is a secure version of FTP and a part of the SSH protocol. SFTP enables easy data transmission and data access through the data flow shell. SFTP, also known as the SSH file transfer protocol, provides a secure connection to transfer files and traverses file systems on local and remote systems.

By default, FTP uses TCP ports 20 and 21. Port 20 is used to transmit data, and port 21 is used to transmit control information (commands). Whether to use port 20 as the port for data transmission depends on the FTP transmission mode. In the active mode, the data transmission port number is 20. In the passive mode, the port is determined after the negotiation between the server and the client.

Creating an FTP Connection

  1. Log in to the new ROMA Connect console.
  2. In the navigation pane on the left, choose Connector. On the page displayed, click New Connection.
  3. Select the FTP connector.
  4. In the dialog box displayed, configure the connector and click OK.

    Parameter

    Description

    Name

    Enter the connector instance name.

    Protocol

    Protocol used by the FTP connector. Options are FTP and SFTP.

    Host IP

    IP address of the FTP server.

    Port

    By default, FTP uses TCP ports 20 and 21. Port 20 is used to transmit data, and port 21 is used to transmit control information (commands).

    Username

    FTP username.

    Authority Type

    This parameter is required when Protocol is set to SFTP.

    Select the authentication mode of SFTP.

    • Password
    • Public Key

    Private Key

    This parameter is required when Protocol is set to SFTP and Authority Type is set to Public Key.

    Enter the complete private key content, starting with -----BEGIN.

    Private Key Passphrase

    This parameter is required when Protocol is set to SFTP and Authority Type is set to Public Key.

    Enter the private key password.

    Password

    FTP user password.

    Enable Passive Mode

    This parameter is required when Protocol is set to FTP.

    Whether to enable the passive mode.

    Passive mode resolves FTP connection failures caused by firewalls or routers (server must support passive mode).

    Description

    Enter the description of the connector to identify it.

Action

  • Writing data to a file
  • Listing directory contents
  • Obtaining file content
  • Copying a file
  • Moving a file
  • Deleting a file
  • Obtaining file metadata
  • Extracting a file

Configuration Parameters

Table 1 Writing data to a file

Parameter

Description

Path

Enter the relative path of the directory. If the home directory of the current FTP connection is /home/ftpuser and the directory path is /home/ftpuser/data, set this parameter to /data.

File Name

Enter the name of the target file.

Content

Enter the content to be written.

Write Policy

Select a policy.

  • Overwrite: Overwrite the content of the file with the same name.
  • Append: Add content to the end of the file with the same name.
  • Backup: Back up the file with the same name. The suffix is the execution time.
Table 2 Listing directory contents

Parameter

Description

Path

Enter the relative path of the directory. If the home directory of the current FTP connection is /home/ftpuser and the directory path is /home/ftpuser/data, set this parameter to /data.

Marker

Return the result list from the file specified by the marker path. If this parameter is empty, results from all files are returned. If the home directory of the current FTP connection is /home/ftpuser and the marker path is /home/ftpuser/data/file.txt, set this parameter to /data/file.txt.

Return Limit

Maximum number of files that can be returned. The maximum value is 50.

Is Recursive

Whether to search for files in subdirectories recursively.

  • True
  • False
Table 3 Obtaining file content

Parameter

Description

Path

Enter the relative path of the directory. If the home directory of the current FTP connection is /home/ftpuser and the directory path is /home/ftpuser/data, set this parameter to /data.

File Name

Name of the file to be obtained.
Table 4 Copying a file

Parameter

Description

Path

Enter the relative path of the directory. If the home directory of the current FTP connection is /home/ftpuser and the directory path is /home/ftpuser/data, set this parameter to /data.

File Name

Name of the file to be copied.

New Path

Enter the relative path of the directory. If the home directory of the current FTP connection is /home/ftpuser and the directory path is /home/ftpuser/data, set this parameter to /data.

New File Name

New name of the file after the copy.

Override Policy

Whether to overwrite the file with the same name.

  • Override
  • None
Table 5 Moving a file

Parameter

Description

Original Path

Enter the relative path of the directory. If the home directory of the current FTP connection is /home/ftpuser and the directory path is /home/ftpuser/data, set this parameter to /data.

New Path

Enter the relative path of the directory. If the home directory of the current FTP connection is /home/ftpuser and the directory path is /home/ftpuser/data, set this parameter to /data.

File Name

New name of the file after the move.

Override Policy

Whether to overwrite the file with the same name.

  • Override
  • None
Table 6 Deleting a file

Parameter

Description

Path

Enter the relative path of the directory. If the home directory of the current FTP connection is /home/ftpuser and the directory path is /home/ftpuser/data, set this parameter to /data.

File Name

Name of the file to be deleted.
Table 7 Obtaining file metadata

Parameter

Description

Path

Enter the relative path of the directory. If the home directory of the current FTP connection is /home/ftpuser and the directory path is /home/ftpuser/data, set this parameter to /data.

File Name

Name of the file from which metadata is to be extracted.
Table 8 Extracting a file

Parameter

Description

Compressed Package Path

Enter the relative path of the directory. If the home directory of the current FTP connection is /home/ftpuser and the directory path is /home/ftpuser/data, set this parameter to /data.

Decompression Path

Enter the relative path of the directory. If the home directory of the current FTP connection is /home/ftpuser and the directory path is /home/ftpuser/data, set this parameter to /data.

File Name

Name of the file to be extracted.

Override Policy

Whether to overwrite the file with the same name.

  • Override
  • None
Parent topic: Others