Skip to main content

SFTP

Pick up files from, or drop files on, an SFTP server - CSV, Excel, HL7 batches, PDFs.

Files↓ Inbound↑ Outbound
Type codeSFTP
Camel componentcamel-ftp (sftp)
Formats carried
HL7 v2FHIR R4JSONXMLCSVExcel (XLSX)Fixed-width textPDF
Terms used on this page

HL7 - Health Level Seven - the standard family for exchanging healthcare messages · SFTP - SSH File Transfer Protocol - file transfer over a secure SSH connection · CSV - comma-separated values - a text file with one record per row

See the Glossary for every term.

Host key required

Without the server's public key the engine cannot tell the real server from an impostor feeding it orders, so an SFTP connection carries nothing until the Server host key is set. Get it with ssh-keyscan -t ed25519 sftp.example.org.

Worked example​

Lab X order files (SFTP) · Inbound · CSV · Test passes on any engine: No - placeholder values

Placeholder host on example.com - replace with the lab's SFTP server, username and password.

Values entered by Fill example
{
"direction": "Inbound",
"format": "CSV",
"settings": {
"host": "sftp.labx.example.com",
"port": "22",
"username": "xellabs",
"folder": "/outbound/orders",
"filePattern": "*.csv",
"pollSeconds": "60"
}
}
Placeholder values

The addresses above are placeholders on example.com. Replace them with your partner's real details before running Test connection.

This is what the console's Fill example button enters. Secrets are never part of an example. Every setting is explained below.

Settings​

Required fields are marked Yes. Fields marked 🔒 (password, privateKey) are stored encrypted and never sent back to the browser - the console only shows Set / Not set. A field marked inbound only or outbound only appears just for that direction.

SettingTypeRequiredDefaultWhat to enter
host
Host
textYes—Required: the server's address, e.g. sftp.lab.example.org.
port
Port
numberYes22Required: usually 22.
username
Username
textYes—Required: the account the server gave you, e.g. xellabs.
password
Password
passwordNo—🔒 secret. The account's password - or leave blank and use a private key. Stored encrypted.
privateKey
Private key
textareaNo—🔒 secret. OpenSSH private key, instead of a password.
hostKey
Server host key
textareaNo—The server's public key, one line as ssh-keyscan prints it (e.g. ssh-ed25519 AAAA...). The engine refuses a server whose key does not match.
folder
Folder
textYes/Required: the folder on the server, e.g. /outbound/orders.
filePattern
File name pattern
textNo*.csvinbound only. Which files to pick up, e.g. *.hl7.
pollSeconds
Poll every (seconds)
numberNo60inbound only. How often to look for new files, e.g. 60 (seconds).

What "Test connection" checks​

The host answers as an SSH server. Signing in is checked once the SFTP component is installed (Stage 2).

Test connection is read-only and says how far it got: verified, reached, checked or failed. See Testing a connection, and Troubleshooting if it fails.