Open FTP file

I/O and network
Open FTP file
Success
File(FTP file)
Error
Stream(Input stream)

Description

Downloads a file from an FTP/SFTP server and exposes its contents as a stream. Takes an FTP file object from Find/Get FTP files — the server connection comes from the file itself. Branches on success/error; the error branch is taken when the file does not exist. The downloaded bytes are buffered to a temporary file so the stream remains usable after the FTP session closes.

When to use

Use Open FTP file to fetch a file from a remote FTP, FTPS, or SFTP server. Wire in a file object from Find FTP files or Get FTP file — the connection is read off the file itself, so there’s no Credentials input to fill in. The downloaded bytes are buffered to a temporary location, so the resulting stream remains usable after the underlying FTP session closes. The Error pin fires if the file input isn’t connected, or if the upstream node reported exists = false (e.g. Get FTP file on a missing path) — check that flag on a Break node before wiring the file in if you need to distinguish “missing” from other failures.

Pins

Input pins

Pin Type Default Notes
File FTP file FTP file object from Find FTP files or Get FTP file. The error branch fires if this input isn't connected, or if the file's exists field is false — the server connection is read from the file object itself, so there's no separate Credentials input.

Output pins

Pin Type Notes
Stream Input stream Stream of the downloaded file's contents. Pipe through Stream to string for text payloads, or wire to another consumer.

Execution pins

Pin Direction
In Input
Success Output
Error Output

Example

Download a CSV from an SFTP server and log its first 100 characters. Wire FTP username/password credentials (Protocol set to SFTP) into Get FTP file, set Path to incoming/orders.csv, then on its Success pin pass the File output straight into Open FTP file. On Open FTP file’s Success pin, pass the Stream output through Stream to string and a Substring into Log message. Wire the Error pin to Fail so the pipeline aborts on a missing or unreachable file.

See also