Skip to main content

FTP

Securely transfer and read files from remote FTP servers.

Specific Settings

SettingDescription
HostIP address or hostname of the FTP server.
PortPort for the connection (default: 21).
Compress fileEnable gzip compression before North processing

Authentication Methods

MethodDescriptionRequired Parameters
NoneNo authentication (not recommended for production)None
Username/PasswordStandard username/password authentication.Username, Password

File Retrieval Settings

SettingDescriptionExample Values
Remote folderSource directory path on SFTP server/incoming/data
RegExpFile pattern filter (regular expression).*\.txt, .*\.csv
Minimum ageMinimum age (in ms) for files to be retrieved. Avoids corrupted files still being written. Default: 1000 ms.1000
Preserve fileIf enabled, files are not deleted after retrieval. Useful if other applications need access. OIBus tracks modification time to avoid re-retrieving unchanged files.Enabled/Disabled
Ignored modified date(Requires Preserve file) Forces retrieval even if the file's modification time hasn't changed. Useful for ensuring files are always processed.Enabled/Disabled

Regex Tester

Common Examples:
  • .* → All files
  • .*\.txt → Text files
  • .*\.csv → CSV files
  • .*\.csv|.*\.xlsx → CSV or Excel files
  • data_.*\.json → JSON files starting with "data_"