What is SFTP?

SFTP (Secure File Transfer Protocol) is a secure file transfer protocol that operates over SSH (Secure Shell). Unlike FTP, which sends data in plaintext, SFTP encrypts both data and authentication information. This prevents unauthorized access and ensures secure transmission across networks.

Key Features

1. Security
   SFTP encrypts files and credentials, protecting data in transit and preventing interception.

2. Flexible Authentication
   SFTP supports password authentication as well as public/private key pairs, enabling controlled and authorized access.

SFTP Connector Capabilities

The Boomi SFTP Connector supports the following actions:

• Read

• Write

• List

• Delete

Using the SFTP connector, Boomi processes can GET, CREATE, QUERY, UPSERT, DELETE, or LIST files from an SFTP server. All communication is encrypted to protect sensitive information.

PART 1 — Setting Up a Free SFTP Server

Follow the steps below to create a cloud-based SFTP instance.

1. Create SFTP Instance

1. Open the website:
   https://sftpcloud.io/tools/free-sftp-server

2. Click Start Free Trial.

3. Create an account by entering your name, email, team name, and password.

4. After logging in, select New SFTP Instance.

5. Choose a region and click Create SFTP Instance.

2. Create Directory

1. Open File Manager.

2. Click New Directory and create a folder (e.g., sftp).

3. Collect Connection Details

Navigate to User → Connection Details to gather:

• Host

• Username

• Password

• Port

These details will be used in Boomi to configure the SFTP Connection.

PART 2 — Configuring the SFTP Connection in Boomi

1. Log into Boomi

1. Go to https://platform.boomi.com/

2. Sign in with your Boomi credentials.

2. Create a New SFTP Connection Component

1. Under Services, select Integration.

2. Expand Connections, then click the three dots (…) to create a new component.

3. Select:

   • Type: Connection

   • Connector: SFTP

4. Click Create.

3. Configure Connection Settings

Enter the connection properties:

• Remote Directory

• Host

• Port

• Username

• Password

Click Test Connection → Verify → Save and Close.

PART 3 — Creating the SFTP File Push/Pull Process

This sample process ("SFTP_File_Push_Pull_Process") demonstrates transferring files between your local directory and the SFTP cloud server.

1. Configure Set Properties (Initial File Details)

1. Add a Set Properties shape.

2. Add two SFTP document properties:

   • SFTP – File Name

   • SFTP – Remote Directory

3. Click “+” to statically assign values (example: employee.csv, /sftp directory).

2. Configure the Disk Connector (Retrieve Local File)

1. Create a Disk Connection pointing to your local file directory.

2. Set Action = Get.

3. Import the file by selecting Import Operation → Local Atom.

4. Save and close the operation.

3. Configure Second Set Properties

A second Set Properties shape is added to reassign:

• File Name

• Remote Directory

These values define where the file will be pushed in the SFTP server.

4. Configure the SFTP Connector (Write to SFTP)

1. Add an SFTP connector shape.

2. Select your SFTP Connection component.

3. Set Action = Write.

4. Import the operation using Import Operation → Local Atom.

5. Save and close.

Your process should now resemble a standard File Push/Pull Workflow.

PART 4 — Testing the Process

1. Run the Process

Execute the process and verify it completes successfully.

2. Validate the Output

• Click the Stop shape and open Step Source Data to confirm the output document.

• Log into the SFTP Cloud dashboard.

• Navigate to your SFTP directory and verify employee.csv was uploaded.

Your file should now appear in the SFTP server, confirming a successful transfer.

Summary

This article walked through:

• Creating a cloud SFTP instance
• Retrieving SFTP authentication details
• Configuring an SFTP Connection component in Boomi
• Setting file metadata with Set Properties
• Using Disk to retrieve a local file
• Using the SFTP connector to write the file to the remote server
• Testing and verifying the file transfer

With these steps, you can seamlessly integrate Boomi with any SFTP-enabled endpoint to automate secure file exchanges between cloud and on-premises systems.