SFTP Activities Extension Library

Exchange files with partner systems over SFTP from inside Integration Soup.

The SFTP Activities Extension Library adds SFTP Upload and SFTP Download. Use it when you need to send files securely to trading partners, collect files from partner folders, or automate file-based integrations that depend on SFTP.

Download IntegrationSoup.SftpActivities.msi

Using SFTP Upload In A Workflow

1. Run the MSI on the Integration Soup server.
2. Restart the Integration Soup service if needed.
3. Add SFTP Upload after the step that produces the content you want to send.
4. Open the activity message template and right click to Insert Activity Message from the receiver or earlier activity that contains the content to upload.
5. Fill in the connection and destination parameters described below.

Using SFTP Download In A Workflow

1. Add SFTP Download where your workflow needs to fetch a file from a partner server.
2. Fill in the connection and remote file parameters.
3. The downloaded file content is returned in the response message, ready for the next step in the workflow.

What To Place In The Parameters

  • Host Name: the SFTP server name, for example sftp.partner.example.
  • Port: leave blank for port 22, or enter another positive port number if your partner uses a different one.
  • User Name: the login user for the SFTP server.
  • Password: the login password when password authentication is used.
  • Private Key Path: the full path on the Integration Soup server to the private key file when key-based authentication is used.
  • Private Key Passphrase: the passphrase for the private key if one is required.
  • SSH Host Key Fingerprint: the server fingerprint in WinSCP format, for example ssh-rsa 2048 xx:xx:xx:xx.
  • Remote Path: the full remote file path, for example /outbound/messages/ADT_A01_20260320.hl7 for upload or /inbound/orders/order001.hl7 for download.
  • Create Remote Directory on SFTP Upload: set this to true if the remote folder should be created automatically when it does not exist.
  • Treat Message As Base64 on SFTP Upload: set this to true when the activity message text already contains base64-encoded file bytes that should be uploaded exactly. Leave it blank or false for normal text uploads.
  • Delete Remote File After Download on SFTP Download: set this to true when the source file should be removed after a successful download.

What To Place In The Activity Message

For SFTP Upload, place the content to upload into the activity message. The incoming message type is selectable in the workflow designer, so you can choose a text-based type for HL7, CSV, XML, JSON, or plain text, or choose Binary or DICOM when you want the underlying file bytes uploaded.

If an earlier step returns file bytes as base64 text and you want to upload those bytes exactly, insert that base64 content into the activity message and set Treat Message As Base64 to true.

SFTP Download does not require an incoming activity message. It works from the connection settings and the remote path you provide.

What The Activity Returns

SFTP Upload returns a text result confirming the upload. SFTP Download lets you choose the response message type in the workflow designer. Choose Binary or DICOM when you want to preserve the downloaded file bytes, or choose a text-based type when the remote file is UTF-8 text and should be interpreted as HL7, text, XML, JSON, CSV, or another text message.

If you choose a text-based response type for a file that is not valid UTF-8, the activity returns an error.

Typical Uses

  • Sending generated reports or documents to external partners.
  • Polling for partner files that need to be imported into Integration Soup.
  • Automating traditional file-based integrations without leaving the Workflow Designer.
Extension Library Directory Helpful Links

Download HL7 Soup and Integration Host

Return to the Tutorials Directory