SFTP/FTP/FTPS Client

The SFTP/FTP/FTPS Client origin reads files from a server using the Secure File Transfer Protocol (SFTP), File Transfer Protocol (FTP), or FTP Secure (FTPS) protocol. For information about supported versions, see Supported Systems and VersionsSupported Systems and Versions in the Data Collector documentation.

The origin uses the file name as the offset and does not reprocess a file with a changed timestamp. As a result, the files to be processed must be fully written. The origin does not support reading data from an active file that is still being written to.

When you configure the SFTP/FTP/FTPS Client origin, you specify the protocol to use and the URL where the files reside on the remote server. You can also use a connection connection connection to configure the origin. You can specify whether to process files in subdirectories, a file name pattern, and the first file to process. You can use glob patterns or regular expressions to define the file name pattern that you want to use.

When needed, you can connect to the server through an HTTP or SOCKS proxy. You can also specify a file processing delay.

If the server requires authentication, configure the credentials for the protocol you are using. For the SFTP protocol, the origin can require that the server be listed in a known hosts file. For the FTPS protocol, the origin can authenticate with the server using a client certificate and can authenticate the certificate from the FTPS server.

You can configure the origin to download files to an archive directory if the origin encounters errors while reading the files.

When the stops, the SFTP/FTP/FTPS Client origin notes where it stops reading. When the starts again, the origin continues processing from where it stopped by default. You can reset the origin reset the origin reset the origin to process all requested files.

Note: The origin processes files based on file names and locations. Having files with the same name in the same location can cause the origin to skip reading the duplicate files.

The origin can generate events for an event stream. For more information about dataflow triggers and the event framework, see Dataflow Triggers Overview.

After processing a file, the origin can keep, archive, or delete the file.