FetchFTP

Description

Fetches the content of a file from a remote FTP server and overwrites the contents of an incoming FlowFile with the content of the remote file.

Tags

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

Properties

In the list below required Properties are shown with an asterisk (*). Other properties are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display Name	API Name	Default Value	Allowable Values	Description
Hostname *	Hostname			The fully-qualified hostname or IP address of the host to fetch the data from Supports Expression Language, using FlowFile attributes and Environment variables.
Port *	Port	21		The port to connect to on the remote host to fetch the data from Supports Expression Language, using FlowFile attributes and Environment variables.
Username *	Username			Username Supports Expression Language, using FlowFile attributes and Environment variables.
Password	Password			Password for the user account Supports Expression Language, using FlowFile attributes and Environment variables.
Remote File *	Remote File			The fully qualified filename on the remote system Supports Expression Language, using FlowFile attributes and Environment variables.
Completion Strategy *	Completion Strategy	None	None Move File Delete File	Specifies what to do with the original file on the server once it has been pulled into NiFi. If the Completion Strategy fails, a warning will be logged but the data will still be transferred.
Move Destination Directory	Move Destination Directory			The directory on the remote server to move the original file to once it has been ingested into NiFi. This property is ignored unless the Completion Strategy is set to 'Move File'. The specified directory must already exist on the remote system if 'Create Directory' is disabled, or the rename will fail. Supports Expression Language, using FlowFile attributes and Environment variables.
Create Directory	Create Directory	false	true false	Used when 'Completion Strategy' is 'Move File'. Specifies whether or not the remote directory should be created if it does not exist.
Connection Timeout *	Connection Timeout	30 sec		Amount of time to wait before timing out while creating a connection
Data Timeout *	Data Timeout	30 sec		When transferring a file between the local and remote system, this value specifies how long is allowed to elapse without any data being transferred between systems
Use Compression *	Use Compression	false	true false	Indicates whether or not ZLIB compression should be used when transferring files
Connection Mode	Connection Mode	Passive	Active Passive	The FTP Connection Mode
Transfer Mode	Transfer Mode	Binary	Binary ASCII	The FTP Transfer Mode
Proxy Configuration Service	proxy-configuration-service		Controller Service: ProxyConfigurationService Implementations: StandardProxyConfigurationService	Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN, SOCKS + AuthN
Internal Buffer Size	Internal Buffer Size	16KB		Set the internal buffer size for buffered data streams
Log level when file not found *	fetchfiletransfer-notfound-loglevel	ERROR	TRACE DEBUG INFO WARN ERROR FATAL NONE	Log level to use in case the file does not exist when the processor is triggered
Use UTF-8 Encoding *	ftp-use-utf8	false	true false	Tells the client to use UTF-8 encoding when processing files and filenames. If set to true, the server must also support UTF-8 encoding.

Dynamic Properties

This component does not support dynamic properties.

Relationships

Name	Description
comms.failure	Any FlowFile that could not be fetched from the remote server due to a communications failure will be transferred to this Relationship.
not.found	Any FlowFile for which we receive a 'Not Found' message from the remote server will be transferred to this Relationship.
permission.denied	Any FlowFile that could not be fetched from the remote server due to insufficient permissions will be transferred to this Relationship.
success	All FlowFiles that are received are routed to success

Reads Attributes

This processor does not read attributes.

Writes Attributes

Name	Description
fetch.failure.reason	The name of the failure relationship applied when routing to any failure relationship
filename	The filename is updated to point to the filename fo the remote file
ftp.remote.filename	The name of the remote file that was pulled
ftp.remote.host	The hostname or IP address from which the file was pulled
ftp.remote.port	The port that was used to communicate with the remote FTP server
path	If the Remote File contains a directory name, that directory name will be added to the FlowFile using the 'path' attribute

State Management

This component does not store state.

Restricted

This component is not restricted.

Input Requirement

This component requires an incoming relationship.

Example Use Cases Involving Other Components

Multiprocessor Use Case 1

Retrieve all files in a directory of an FTP Server

Components Involved

• ListFTP
  1. The "Hostname" property should be set to the fully qualified hostname of the FTP Server. It's a good idea to parameterize this property by setting it to something like #{FTP_SERVER}.
  2. The "Remote Path" property must be set to the directory on the FTP Server where the files reside. If the flow being built is to be reused elsewhere, it's a good idea to parameterize this property by setting it to something like #{FTP_REMOTE_PATH}.
  3. Configure the "Username" property to the appropriate username for logging into the FTP Server. It's usually a good idea to parameterize this property by setting it to something like #{FTP_USERNAME}.
  4. Configure the "Password" property to the appropriate password for the provided username. It's usually a good idea to parameterize this property by setting it to something like #{FTP_PASSWORD}.
  5. The 'success' Relationship of this Processor is then connected to FetchFTP.
• FetchFTP
  1. "Hostname" = "${ftp.remote.host}"
  2. "Remote File" = "${path}/${filename}"
  3. "Username" = "${ftp.listing.user}"
  4. "Password" = "#{FTP_PASSWORD}"

System Resource Considerations

This component does not specify system resource considerations.

See Also

GetFTP, GetSFTP, PutFTP, PutSFTP