Skip to main content

FTP / FTPS

Pick up or drop files over FTP, or FTPS (FTP with TLS).

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

FTPS - FTP with TLS - file transfer on a plain FTP server, encrypted · TLS - Transport Layer Security - the encryption behind https:// and secure sockets

See the Glossary for every term.

FTPS is explicit TLS on the same port

Turning on Use FTPS uses explicit TLS (AUTH TLS) on the same port. If the server does not offer it, Test connection says so; turn FTPS off or ask for it to be enabled.

Worked example​

Reference lab results (FTPS) · Outbound · PDF · Test passes on any engine: No - placeholder values

Placeholder host on example.com - replace with the partner's FTP server and credentials.

Values entered by Fill example
{
"direction": "Outbound",
"format": "PDF",
"settings": {
"host": "ftp.reflab.example.com",
"port": "21",
"username": "xellabs",
"ftps": "true",
"folder": "/results"
}
}
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) 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. ftp.lab.example.org.
port
Port
numberYes21Required: usually 21.
username
Username
textYes—Required: the account the server gave you.
password
Password
passwordNo—🔒 secret. The account's password. Stored encrypted.
ftps
Use FTPS (TLS)
checkboxNofalseExplicit TLS (AUTH TLS) on the same port.
folder
Folder
textYes/Required: the folder on the server, e.g. /orders.
filePattern
File name pattern
textNo*.csvinbound only. Which files to pick up, e.g. *.csv.
pollSeconds
Poll every (seconds)
numberNo60inbound only. How often to look for new files, e.g. 60 (seconds).

What "Test connection" checks​

Signs in with the username and password and opens the folder. Nothing is read or written.

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.