Fetches files from an FTP Server and creates FlowFiles from them

Additional Details...


FTP, get, retrieve, files, fetch, remote, ingest, source, input


In the list below, the names of required properties appear in bold. Anyother properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the NiFi Expression Language (or simply EL), and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the file has an entry for the property nifi.sensitive.props.key.

NameDefault ValueValid ValuesExpression Language
Hostname The fully qualified hostname or IP address of the remote systemYes
Port The port that the remote system is listening on for file transfers21No
Username UsernameNo
Password Sensitive Property Password for the user accountNo
Connection Mode The FTP Connection ModePassive
  • Active
  • Passive
Transfer Mode The FTP Transfer ModeBinary
  • Binary
Remote Path The path on the remote system from which to pull or push filesYes
File Filter Regex Provides a Java Regular Expression for filtering Filenames; if a filter is supplied, only files whose names match that Regular Expression will be fetchedNo
Path Filter Regex When Search Recursively is true, then only subdirectories whose path matches the given Regular Expression will be scannedNo
Polling Interval Determines how long to wait between fetching the listing for new files60 secNo
Search Recursively If true, will pull files from arbitrarily nested subdirectories; otherwise, will not traverse subdirectoriesfalse
  • true
  • false
Ignore Dotted Files If true, files whose names begin with a dot (".") will be ignoredtrue
  • true
  • false
Delete Original Determines whether or not the file is deleted from the remote system after it has been successfully transferredtrue
  • true
  • false
Connection Timeout Amount of time to wait before timing out while creating a connection30 secNo
Data Timeout Amount of time to wait before timing out while transferring data30 secNo
Max Selects The maximum number of files to pull in a single connection100No
Remote Poll Batch Size The value specifies how many file paths to find in a given directory on the remote system when doing a file listing. This value in general should not need to be modified but when polling against a remote system with a tremendous number of files this value can be critical.  Setting this value too high can result very poor performance and setting it too low can cause the flow to be slower than normal.5000No
Use Natural Ordering If true, will pull files in the order in which they are naturally listed; otherwise, the order in which the files will be pulled is not definedfalse
  • true
  • false
Sensitive Property indicates that a property is a sensitive property


successAll FlowFiles that are received are routed to success