Contents x
    Installation and Configuration
    • 13 Nov 2024
    • 3 Minutes to read
    • Print
    • Dark
      Light
    Contents

    Installation and Configuration

    • Updated on 13 Nov 2024
    • 3 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    Salesforce Marketing Cloud Package Installation

    STOP

    In order to continue, you should have received a .zip file from Relay that will be used for the installation process.

    SFTP File Location Setup

    Prior to Installing the Package, you will need to setup File Locations.

    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 INTEGRATION VIA SFTP:

    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

    Configuration - Package Installation

    Step #

    Description

    Salesforce Marketing Cloud

    1

    • Select Package Manager from the Platform tab.

    select package manager app

    2

    • Select the Deployment tab, press the Deploy button and Select Upload from File

    select deployment tab

    3

    • Browse for the .zip file provided on the day of your integration and drop it into the Package Upload area.

    browse for zip drag drop

    4

    • Select Next under Package Customization.

    select next package customization

    5

    • Review the items to be deployed and then select Deploy under Item Validation and Usage.

    • After the deployment of the zip file is complete, the deployment details will be displayed in the window.

    review click deploy

    Configuration - Creating the Application Package

    Step #

    Description

    Salesforce Marketing Cloud

    1

    • Login into Salesforce Marketing cloud using an administrator account.

    • Under the logged in user drop down menu, select Setup.

    cfg setup

    2

    • Under Setup → Platform Tools → Apps select Installed Packages

    • Click New

    cfg new

    3

    • Enter package Name and optional Description

    cfg name desc

    Configuration - Adding API Component

    Step #

    Description

    Salesforce Marketing Cloud

    1

    • Under Components – click Add Component.

    cfg add component

    2

    • Select API Integration – click Next.

    cfg api integration

    3

    • Select Server to Server – click Next.

    cfg server to server

    4

    • Under Add Component, scroll down to section Data and for data extensions select Read & Write Permissions and click Save

    cfg read and write perms

    Configuration - Relay Custom Journey Activity

    Clients can create two custom journey activities as part of the package if they wish to have two components displayed in the journey builder palette – one for production and one for staging. The difference being the URL, which is explained in the steps below.

    Step #

    Description

    Salesforce Marketing Cloud

    1

    • Under Components – click Add Component

    • Select the option Journey Builder Activity and click Next

    cact journey builder activity

    2

    cact hosted activity

    Setup Access to Receive Relay Push Events

    In order to subscribe to Relay Push Events/Web Hooks which flow into the relay_response_log data extension in your Salesforce Marketing Cloud instance, certain Salesforce Marketing Cloud keys must be obtained and provided to the Relay Client Success Team representative to be setup in Relay CX Builder.

    Checklist of Salesforce Marketing Cloud Keys to be sent to Relay are:

    • Client Id

    • Client Secret

    • REST Based URI

    • Authentication Base URI

    • JSON Web Token (JWT) Signing Secret

    • Account ID

    Step #

    Description

    Salesforce Marketing Cloud

    1

    • Login to Salesforce Marketing Cloud and go to Setup.

    • In the Quick Find, search for “Installed Packages”

    • Click on Relay Network and obtain the below details:

    1. Client Id

    2. Client Secret

    3. REST Based URI

    4. Authentication Based URI

    5. JWT Signing Secret

    2

    • Login to Salesforce Marketing Cloud and go to Setup

    • In the Quick Find, search for “Account Settings”

    • Obtain the below details:

    1. Account ID

    account id find details

    Setup Access to Call the Relay API to Trigger Experiences

    In order to call the Relay APIs to trigger experiences from your Salesforce Marketing Cloud instance you need to store certain keys in Salesforce Marketing Cloud that have been provided by your Relay Client Success representative.

    Checklist of Salesforce Marketing Cloud Keys to be sent to Relay are:

    • Auth Hash

    Data Extension Mapping:

    Field

    Staging Connection

    Production Connection

    Metadata Id

    1

    2

    Metadata Name

    relayauthhash_staging

    relayauthhash_production

    Metadata Value

    Value provided by Relay.

    Value provided by Relay.

    Step #

    Description

    Salesforce Marketing Cloud

    1

    Store the Auth Hash in Salesforce Marketing Cloud:

    • Login to Salesforce Marketing Cloud, go to the Audience Builder>Contact Builder.

    • Go to and select Data Extensions.

    • Click on relay_network_metadata, click the Records tab.

    • Select Add Record

    Update External Keys

    Step #

    Description

    Salesforce Marketing Cloud

    1

    • Navigate to Email Studio

    • Navigate to Subscribers, and then to Data Extensions

    2

    • Under Data Extensions (subfolder relay network if data extensions are in a sub folder) select the data extension relay_network_metadata

    3

    • Change the external key of the data extension to the data extension name – relay_network_metadata and click DONE. This should update the external key of the data extension.  If the external key already matches, there is no action to be taken.

    4

    • Repeat the steps above for each main Data Extension listed below so the external keys match the name of the data extension.

    Was this article helpful?
    What's Next
    ESC

    Eddy AI, facilitating knowledge discovery through conversational intelligence