DocumentationExperience PlatformDestinations Guide

SFTP connection

Last update: Mon Jan 08 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • User
  • Admin
  • Leader

Destination changelog changelog

With the July 2023 Experience Platform release, the SFTP destination provides new functionality, as listed below:

Overview overview

Create a live outbound connection to your SFTP server to periodically export delimited data files from Adobe Experience Platform.

IMPORTANT
While Experience Platform supports data exports to SFTP servers, the recommended cloud storage locations to export data are Amazon S3 and Azure Blob.

Connect to SFTP through API or UI connect-api-or-ui

Supported audiences supported-audiences

This section describes which types of audiences you can export to this destination.

Audience origin
Supported
Description
Segmentation Service
✓
Audiences generated through the Experience Platform Segmentation Service.
Custom uploads
✓
Audiences imported into Experience Platform from CSV files.

Export type and frequency export-type-frequency

Refer to the table below for information about the destination export type and frequency.

Item
Type
Notes
Export type
Profile-based
You are exporting all members of a segment, together with the desired schema fields (for example: email address, phone number, last name), as chosen in the select profile attributes screen of the destination activation workflow.
Export frequency
Batch
Batch destinations export files to downstream platforms in increments of three, six, eight, twelve, or twenty-four hours. Read more about batch file-based destinations.

SFTP profile-based export type highlighted in the destinations catalog.

Connect to the destination connect

IMPORTANT
To connect to the destination, you need the View Destinations and Manage Destinations access control permissions. Read the access control overview or contact your product administrator to obtain the required permissions.

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:

SFTP destination basic authentication with password.

  • 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.

    Image showing an example of a correctly formatted PGP key in the UI.

If you select the SFTP with SSH key authentication type to connect to your SFTP location:

SFTP destination SSH key authentication.

  • 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.

    Image showing an example of a correctly formatted PGP key in the UI.

Destination details destination-details

After establishing the authentication connection to the SFTP location, provide the following information for the destination:

Destination details fields for the SFTP 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

IMPORTANT

See Activate audience data to batch profile export destinations for instructions on activating audiences to this destination.

Export datasets export-datasets

This destination supports dataset exports. For complete information on how to set up dataset exports, read the tutorials:

Exported data exported-data

For SFTP destinations, Platform creates a .csv file in the storage location that you provided. For more information about the files, see Activate audience data to batch profile export destinations in the audience activation tutorial.

IP address allowlist ip-address-allow-list

Refer to IP address allowlist for SFTP destinations if you need to add Adobe IPs to an allowlist.

recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6