SFTP
Pick up files from, or drop files on, an SFTP server - CSV, Excel, HL7 batches, PDFs.
Files↓ Inbound↑ OutboundSFTPcamel-ftp (sftp)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.
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.
{
"direction": "Inbound",
"format": "CSV",
"settings": {
"host": "sftp.labx.example.com",
"port": "22",
"username": "xellabs",
"folder": "/outbound/orders",
"filePattern": "*.csv",
"pollSeconds": "60"
}
}
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.
| Setting | Type | Required | Default | What to enter |
|---|---|---|---|---|
hostHost | text | Yes | — | Required: the server's address, e.g. sftp.lab.example.org. |
portPort | number | Yes | 22 | Required: usually 22. |
usernameUsername | text | Yes | — | Required: the account the server gave you, e.g. xellabs. |
passwordPassword | password | No | — | 🔒 secret. The account's password - or leave blank and use a private key. Stored encrypted. |
privateKeyPrivate key | textarea | No | — | 🔒 secret. OpenSSH private key, instead of a password. |
hostKeyServer host key | textarea | No | — | 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. |
folderFolder | text | Yes | / | Required: the folder on the server, e.g. /outbound/orders. |
filePatternFile name pattern | text | No | *.csv | inbound only. Which files to pick up, e.g. *.hl7. |
pollSecondsPoll every (seconds) | number | No | 60 | inbound 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.