Configuration- SFTP

Prev Next

Salesforce Marketing Cloud (SFMC) can use SFTP to move files to a specific location on the Relay SFTP server. Each directory will need to be set up as a file location in SFMC. Reach out to your Relay team to obtain the Relay public PGP key to be stored in your Salesforce Marketing Cloud instance.  Your team will need to generate an SSH2 key pair; you will store the private key within SFMC and provide the public key to your Relay team for connectivity.

STOP

You will need the following before proceeding with the steps below:

  • You will need to create an SSH2 key pair.  Instructions can be found here: Generating SSH Keys

  • Reach out to your Relay team for Relay’s public PGP key

Setup SSH Keys for Authentication

Step #

Description

Salesforce Marketing Cloud

1

  • Login to Salesforce Marketing Cloud, go to the Email Studio>Email section.

  • Go to and select Admin.

  • Under Data Management, select Key Management.

pubkey key management

2

  • Select Create

  • Enter Name and External Key fields.

  • Browse to the correct private SSH key to select.

  • Select Save.

pubkey key file

Setup PGP Key for Encryption

Step #

Description

Salesforce Marketing Cloud

1

  • In the Marketing Cloud Email Section, select Admin

  • Under Data Management, select Key Management

  • Select Create

pubkey key management

2

  • Enter Name and External Key fields.

  • Browse to the correct key to select.

  • Select Save.

pubkey key file

SFTP File Location Setup

Step #

Description

Salesforce Marketing Cloud

1

  • In the Marketing Cloud Email Section, select the Admin tab

sftp admin tab

2

  • Under Data Management, select File Locations

sftp file locations

3

  • Select the Create Button and fill in the appropriate information:

    • NOTE: Six file locations are available to push batch files to within each Relay environment. Each location must be set up separately and are listed in the “FILE LOCATIONS FOR BATCH INTEGRATION VIA SFTP:” table.

  • Location Type: External SFTP Site

  • Username: [client_id]

  • Auth Type: Auth key

  • Environment:

    • Production: sftpv3.relayzone.com

    • Staging: sftp-staging.relaystaging.com

These File locations will match the FTP location in the File Transfer Activities within the Relay – Batch File Automation

File Locations for Batch Automation Setup

Name & External Key & Description

File Path

Relay_Customer_Consent_Management

[environment]/dropoff/consent_update

Relay_Customer_Onboarding

[environment]/dropoff/onboarding

Relay_Customer_Phone_Management

[environment]/dropoff/phone_management

Relay_Customer_Deactivation

[environment]/dropoff/deactivation

Relay_Customer_Data

[environment]/dropoff/cca

Relay_Customer_Message

[environment]/dropoff/messaging

Establish Connectivity with CX Builder

The SFTP connection can be configured within CX Builder by any user with Client Admin or Client User with Integration permissions in the system.  This feature is available in both the Staging and Production environments.

Step #

Description

CX Builder

1

Once you are signed in, click on the SFTP & GPG in the left menu column. Remain on the Relay Hosted SFTP tab. This is the “home page” of the connections to the Relay SFTP site.

Note: If you do not see the SFTP & GPG module on the left menu, please check that you have either Client Admin or Client User with Integration Permissions in the system.

2

Locate the Public SSH2 key you created for the connection, and copy and paste the contents of the key into the SSH key contents box, and then click Upload below it.

Note: If your key does not start with “---- BEGIN SSH2 PUBLIC KEY ----” then you will need to convert it from standard SSH format to SSH2 format.  This can be done by clicking on the carrot to the right for instructions on how to create a converted key before loading it into the SSH key contents box.  

3

Once the key is successfully loaded, it will be listed on the main screen as shown to the right.

To test connectivity to the SFTP, you will authenticate with your username and the private SSH2 key you created.  The username is listed next to “SFTP keys for:” within the UI.

4

Automated File Processing - ON or OFF

Once a file is loaded to the appropriate Relay SFTP folder, it will automatically be processed by the system.  To turn this feature off and have the file stay in idle status for manual processing/scheduling, toggle the switch to OFF in the right hand corner.

5

Adding Additional Connections

Relay can support multiple connections to the SFTP site.  To add an additional SSH2 key, click on Add SFTP Key above the current key.  This will take you back to Step 2 where you can copy the contents of the key into UI.

6

Deleting Old Connections

To delete an old or expired SSH2 key, click on the trash can icon to the right.