Skip to main content
Feedback

SFTP connector

The SFTP connector allows you to download files from or upload files to the SFTP-enabled server.

This connector also transfers data from and to an SFTP server using Java Secure Channel (JSch). Unlike the standard FTP connector, the SFTP connector encrypts both data and commands to ensure that no sensitive data is exposed when transmitted over a network. SFTP uses a different protocol from FTP, which means you cannot use a standard FTP client to communicate with the SFTP server. Using this connector, you can use a Boomi Integration process to Read, Write, List, Delete, and Listen for the data in any format.

Connector configuration

To configure the connector to communicate with the SFTP server using the SFTP client, set up the following components:

  • SFTP connection — The connection represents a specific SFTP-enabled server.
  • SFTP operation — The operation represents an action against a specific record type. You will create one or more operations, one for each type of interaction required by your integration scenario.

This design provides reusable components containing connection settings such as connection hostname, username, password, SSL settings, and operation settings. After building your connection and operation, set up your connector within a process. When your connector is configured properly within your process, Boomi Integration can map to and from virtually any system using the SFTP connector to retrieve files from the SFTP server.

Limitations

The SFTP connector has the following limitations:

  • Proxy feature is not supported in the Cloud environment.
  • Proxy settings with basic runtime protocol has not been tested.

Prerequisites

The SFTP connector requires the following:

  • Users have the necessary authorization to access remote directories.

  • Hostname and port number of the SFTP server.

  • One of the following authentication types:

    • Username and Password
    • SSH (Secure Shell) private key authentication
    • Proxy Servers to evaluate the request and perform the required network transactions. Following are the four types of proxy protocols used:
      • ATOM
      • HTTP
      • SOCKS4
      • SOCKS5
    • Third-Party Libraries: The Java Secure Channel (Jsch) library in its 0.2.19 version, to establish connections and transfer data from/to SFTP servers and Remote Directory Poller for java (rdpj) library in its 0.2.1 version for the Listen Operation.
    • Using Public Key (the Client SSH Key File Path or Public and Private Key Content is needed).

  • Correct permissions to perform the various commands. For example, the override command currently takes the existing file, deletes it, and creates a new one, so you must have delete permissions. Another example is you must have permission to rename a file and create temporary files for the upload/upsert commands.

  • SFTP-enabled server is accessible from Boomi Integration.

Testing the process in a Cloud Attachment

To test the process in a cloud attachment, do the following:

  1. Grant permission in the following files for Test Connection and process running.

    1. If the SFTP server IP is not open to the internet

      • /bin/procrunner-HIGH.policy

      • /bin/procbrowser-HIGH.policy

      • Add the following line in the previous files in Custom permission:

        java.net.SocketPermission "<IP>:<PORT>", "connect,resolve";

      Note: See the Boomiverse article Could not create socket Caused by: access denied (java.net.SocketPermission) for more information.

Supported editions

The connector supports:

  • Any version of the SFTP-enabled server
  • SFTP API version of Java Secure Channel (JSch) library is 0.2.19
  • rdpj library 0.2.1 version

Tracked properties

The SFTP connector has the following tracked properties that you can set or reference in various step parameters:

File Name (Write: Input, List, Read: Output) -

  • For Write, the name of the file to create on the SFTP server. For this action to be successful, you must set the File Name as an input document property in the Set Properties step. See the operation topic for more information.
  • For Read and List, the name of the downloaded file from the SFTP server. See the operation topic for more information.

Remote Directory (Write, Read, List: Input, List, Get: Output) -

  • For Write, Read, and List (Input), the directory on the SFTP server. If set with a non-blank value, this property overrides the Remote Directory specified in the connection.
  • For List and Get (Output), the directory on the SFTP server from where the file is downloaded.

Last Modified Date (List, Read: Output) - The last modification date and time of the downloaded file. The Last Modified Date is only included in the output when you select the Include all metadata checkbox in the operation. The format of the date is now using ISO format yyyy-MM-dd’T’HHmmssXXX.

On this Page