SFTP connection
Destination changelog changelog
With the July 2023 Experience Platform release, the SFTP destination provides new functionality, as listed below:
- Dataset export support.
- Additional file naming options.
- Ability to set custom file headers in your exported files via the improved mapping step.
- Ability to customize the formatting of exported CSV data files.
Overview overview
Create a live outbound connection to your SFTP server to periodically export delimited data files from ÃÛ¶¹ÊÓƵ Experience Platform.
Connect to SFTP through API or UI connect-api-or-ui
- To connect to your SFTP storage location using the Platform user interface, read the sections Connect to the destination and Activate audiences to this destination below.
- To connect to your SFTP storage location programmatically, read the Activate audiences to file-based destinations by using the Flow Service API tutorial.
Supported audiences supported-audiences
This section describes which types of audiences you can export to this destination.
Export type and frequency export-type-frequency
Refer to the table below for information about the destination export type and frequency.
Export datasets export-datasets
This destination supports dataset exports. For complete information on how to set up dataset exports, read the tutorials:
File format of the exported data file-format
When exporting audience data, Platform creates a .csv, parquet, or .json file in the storage location that you provided. For more information about the files, see the supported file formats for export section in the audience activation tutorial.
When exporting datasets, Platform creates a .parquet or .json file in the storage location that you provided. For more information about the files, see the verify successful dataset export section in the export datasets tutorial.
Connect to the destination connect
To connect to this destination, follow the steps described in the destination configuration tutorial. In the configure destination workflow, fill in the fields listed in the two sections below.
Authentication information authentication-information
If you select the SFTP with password authentication type to connect to your SFTP location:
-
Domain: The address of your SFTP storage location;
-
Username: The username to log into your SFTP storage location;
-
Port: The port used by your SFTP storage location;
-
Password: The password to log into your SFTP storage location.
-
Encryption key: Optionally, you can attach your RSA-formatted public key to add encryption to your exported files. View an example of a correctly formatted encryption key in the image below.
If you select the SFTP with SSH key authentication type to connect to your SFTP location:
-
Domain: Fill in the IP address or the domain name of your SFTP account
-
Port: The port used by your SFTP storage location;
-
Username: The username to log into your SFTP storage location;
-
SSH Key: The private SSH key used to log into your SFTP storage location. The private key must be an RSA-formatted, Base64-encoded string, and must not be password-protected.
-
Encryption key: Optionally, you can attach your RSA-formatted public key to add encryption to your exported files. View an example of a correctly formatted encryption key in the image below.
Destination details destination-details
After establishing the authentication connection to the SFTP location, provide the following information for the destination:
-
Name: Enter a name that helps you identify this destination in the Experience Platform user interface;
-
Description: Enter a description for this destination;
-
Folder path: Enter the path to the folder in your SFTP location where the files will be exported.
-
File type: Select the format Experience Platform should use for the exported files. When selecting the CSV option, you can also configure the file formatting options.
-
Compression format: Select the compression type that Experience Platform should use for the exported files.
-
Include manifest file: Toggle this option on if you’d like the exports to include a manifest JSON file that contains information about the export location, export size, and more. The manifest is named using the format
manifest-<<destinationId>>-<<dataflowRunId>>.json. View a sample manifest file. The manifest file includes the following fields:flowRunId: The dataflow run which generated the exported file.scheduledTime: The time in UTC when the file was exported.exportResults.sinkPath: The path in your storage location where the exported file is deposited.exportResults.name: The name of the exported file.size: The size of the exported file, in bytes.
Activate audiences to this destination activate
-
To activate data, you need the View Destinations, Activate Destinations, View Profiles, and View Segments access control permissions. Read the access control overview or contact your product administrator to obtain the required permissions.
-
To export identities, you need the View Identity Graph access control permission.
See Activate audience data to batch profile export destinations for instructions on activating audiences to this destination.
Validate successful data export exported-data
To verify if data has been exported successfully, check your SFTP storage and make sure that the exported files contain the expected profile populations.
IP address allowlist ip-address-allow-list
Refer to the IP address allowlist article if you need to add ÃÛ¶¹ÊÓƵ IPs to an allowlist.