SFTP/FTP/FTPS Client
The SFTP/FTP/FTPS Client destination writes whole files to a URL 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 Versions in the Data Collector documentation.
When you configure the SFTP/FTP/FTPS Client destination, you specify the protocol to use and the URL where the destination writes files on the remote server. You can also use a connection to configure the destination. The destination can create paths that do not exist. You also specify an expression for the file name to write and the action to take when the file already exists on the server.
When needed, you can connect to the server through an HTTP or SOCKS proxy.
If the server requires authentication, configure the credentials for the protocol you are using. For the SFTP protocol, the destination can require that the server be listed in a known hosts file. For the FTPS protocol, the destination can authenticate with the server using a client certificate and can authenticate the certificate from the FTPS server.
The destination can generate events for an event stream. For more information about the event framework, see Dataflow Triggers Overview.
Credentials
The SFTP/FTP/FTPS Client destination can use several methods to authenticate with the remote server. From the Credentials tab, configure the authentication required by the remote server.
Authentication options differ for each protocol:
- For all protocols, select an authentication method to log in to
the remote server. Choose the method based on the protocol and remote server
requirements:
- None - The stage does not authenticate with the server.
- Password - The stage authenticates with the server using a user name and password. You must specify the user name and password.
- Private key - The stage authenticates using a private key. Use only with the SFTP protocol. You must specify the private key, either in a local file or in plain text.
- For the SFTP protocol, the stage can require that the server be listed in a known hosts file. You must specify the path to the known hosts file that contains the host keys for the approved SFTP servers.
- For the FTPS protocol, the stage can use certificates to authenticate with the server. You must specify the keystore file and password. You can also configure the stage to authenticate the server by specifying a truststore provider. For more information about keystores and truststores, see Keystore and Truststore Configuration.
Event Generation
The SFTP/FTP/FTPS Client destination can generate events that you can use in an event stream. When you enable event generation, the destination generates event records each time the destination closes a file or completes streaming a whole file.
- With the SFTP/FTP/FTPS Client executor to move closed files.
For an example, see Managing Output Files.
- With the Email executor to send a custom email
after receiving an event.
For an example, see Sending Email During Pipeline Processing.
- With a destination to store event information.
For an example, see Preserving an Audit Trail of Events.
For more information about dataflow triggers and the event framework, see Dataflow Triggers Overview.
Event Records
Event records generated by the SFTP/FTP/FTPS Client destination include the following event-related record header attributes. Record header attributes are stored as String values:
Record Header Attribute | Description |
---|---|
sdc.event.type | Event type. Uses one of the following types:
|
sdc.event.version | Integer that indicates the version of the event record type. |
sdc.event.creation_timestamp | Epoch timestamp when the stage created the event. |
- File closure
- The destination generates a file closure event record when it closes an output file.
- Whole file processed
- The
destination generates an event record when it completes
streaming a whole file. Whole file event records have the
sdc.event.type
record header attribute set towholeFileProcessed
and have the following fields:Field Description sourceFileInfo A map of attributes about the original whole file that was processed. The attributes include: - size - Size of the whole file in bytes.
Additional attributes depend on the information provided by the origin system.
targetFileInfo A map of attributes about the whole file written to the destination. The attributes include: - path - An absolute path to the processed whole file.
Data Format
- Whole File
- Streams whole files to the destination system. The destination writes the data to the file and location defined in the stage. If a file of the same name already exists, you can configure the destination to overwrite the existing file or send the current file to error.
Configuring an SFTP/FTP/FTPS Client Destination
Configure an SFTP/FTP/FTPS Client destination to send data to a URL using SFTP, FTP, or FTPS.