Send data to any SFTP Site

The SSH File Transfer Protocol (also Secure File Transfer Protocol, or SFTP) is a network protocol that provides file access, file transfer, and file management over any reliable data stream.

This topic describes the steps that are required to send files to SFTP from Amperity:

  1. Get details

  2. Add destination

  3. Add data template

Get details

An SFTP destintion to which Amperity sends data requires the following configuration details:

  1. The username.

  2. The host public key.

  3. The hostname, to which data will be sent.

  4. For passphrase credentials, the passphrase; for private key credentials, the private key.

  5. The remote folder to which Amperity will send data.

  6. The public key to use for PGP encryption.

Included SFTP site

Every Amperity tenant includes an SFTP site with a hostname of <tenant>.sftp.amperity.com. For example, if your company name is ACME, then your tenant’s SFTP hostname is acme.sftp.amperity.com. (The hostname is always all lowercase.)

Note

The SFTP site is provisioned by an Amperity administrator after the initial tenant creation. As such, the SFTP site is not immediately available, but this is not a long process. When the SFTP site is ready, Amperity will use SnapPass to send you the connection details. If you wish to use RSA key-based authentication, please provide the public key to your Amperity administrator when requesting SFTP access.

Once this site is provisioned, you may configure the SFTP site as an SFTP source or an SFTP destination to support any desired workflow. External customer processes can be configured to connect to the site using SFTP, after which they can add data to or pick up data from the site to support any external workflow.

Caution

The SFTP server has a 30-day limit on data and after 30 days, data may be moved automatically to an archive location. This location is still accessible to Amperity in case it becomes necessary to reuse it.

Important

The hostname for the SFTP site is always <tenant-name>.sftp.amperity.com. Some older tenants may still be using the legacy address sftp.amperity.com, if so, please contact your Amperity administrator about migrating.

Filedrop requirements

An SFTP location requires the following:

Add destination

Any SFTP site may be used as a supported destination and may be configured directly from Amperity.

To add a destination to any SFTP site

  1. From the Destinations tab, click Add Destination. This opens the Add Destination dialog box.

  2. Enter the name of the destination and a description. For example: “SFTP” and “This sends query results to “SFTP”.

  3. From the Plugin drop-down, select SFTP.

    This automatically selects passphrase or private-key as the Credential Type and assigns hostname as the location to which data is sent.

  4. From the Credential drop-down, select Create a new credential. This opens the Create New Credential dialog box. Enter a name for the credential (typically “SFTP”), and then enter the username and password required to access this SFTP location.

  5. Under Settings, enter the path to the remote folder.

  6. From the File Format drop-down, select File format options include Apache Parquet (recommended when supported by the downstream workflow), CSV, TSV, and PSV.

  7. Add a single character to be used as an escape character in the output file. (This should match the escape character required by SFTP.)

    Note

    If an escape character is not specified and quote mode is set to “None” this may result in unescaped, unquoted files. When an escape character is not specified, you should select a non-“None” option from the Quote Mode setting.

  8. Specify the encoding method. Encoding method options include “Tar”, “Tgz”, “Zip”, “GZip”, and “None”.

  9. Add the PGP public key that is used to encrypt files sent to SFTP.

  10. Optional. Specify the line ending type: LF or CRLF.

  11. Optional. Set the quote mode.

    Note

    If the quote mode is set to “None” and the Escape Character setting is empty this may result in unescaped, unquoted files. When quote mode is “None”, you should specify an escape character.

  12. Optional. Select Include success file upon completion to add a .DONE file to indicate when an orchestration has finished sending data.

    Tip

    If a downstream sensor is listening for files sent from Amperity, configure that sensor to listen for the presence of the .DONE file.

  13. Optional. Select Include header row in output files if headers are included in the output.

  14. Select Allow customers to use this destination.

  15. Select Allow orchestrations from users with limited PII access. (A user with limited PII access has been assigned the Restrict PII Access policy option.)

  16. Click Save.

Add data template

A data template defines how columns in Amperity data structures are sent to downstream workflows. A data template is part of the configuration for sending query and segment results from Amperity to an external location.

You have two options for setting up data templates for SFTP:

  1. For use with campaigns

  2. For use with orchestrations

for campaigns

You can configure Amperity to send campaigns to any SFTP site. These results are sent from the Campaigns tab. Results default to a list of email addresses, but you may configure a campaign to send additional attributes to SFTP.

To add a data template for campaigns

  1. From the Destinations tab, open the menu for a destination that is configured for SFTP, and then select Add data template.

    This opens the Add Data Template dialog box.

  2. Enter the name of the data template and a description. For example: “SFTP email list” and “Send email addresses to SFTP.”

  3. Enable the Allow customers to use this data template option, and then enable the Make available to campaigns option. This allows users to send campaign results from Amperity to SFTP.

  4. Verify all template settings and make any required updates.

  5. Click Save.

for orchestrations

You can configure Amperity to send query results to any SFTP site. These results are sent using an orchestration and will include all columns that were specified in the query.

To add a data template for orchestrations

  1. From the Destinations tab, open the menu for a destination that is configured for SFTP, and then select Add data template.

    This opens the Add Data Template dialog box.

  2. Enter the name of the data template and a description. For example: “SFTP customer profiles” and “Send email addresses and customer profiles to SFTP.”

  3. Enable the Allow customers to use this data template option. This allows users to build queries, and then configure orchestrations that send results from Amperity to a configured destination.

  4. Optional. Enable the Allow orchestrations from customers with limited PII access option. This allows users who have been assigned the Restrict PII Access policy option to send results from Amperity.

  5. Verify all template settings and make any required updates.

  6. Click Save.