Contents x
    File Transmissions
    • 13 Nov 2024
    • 2 Minutes to read
    • Print
    • Dark
      Light
    Contents

    File Transmissions

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

    SFTP Configuration and Usage

    Overview

    Relay hosts an SFTP service that provides business users the ability to securely both send and receive flat files (.csv) supporting your customer onboarding, deactivation, and overall customer engagement leveraging the Relay platform. SFTP, or SSH File Transfer Protocol, is a network protocol that provides file access, file transfer, and file management over a reliable data stream. Based on your use cases, review the implementation flow, best practices, and configuration setup guide.

    Client Implementation Flow

    sftp client implementation flow

    Drop Off and Pickup Folders.

    Once configured, the Dropoff and Pickup folders can be used to upload files from CX Builder, drop files directly to trigger messaging or update customer records, and to retrieve Relay standard reporting.

    Below are descriptions regarding each of the Dropoff and Pickup folder structures.

    For information about .csv file formats when uploading files, go to:Upload File Processing

    Drop Off Folder Structure

    Description

    📁 dropoff

           📁 cca

           📁 consent_update

           📁 deactivation

           📁 messaging

           📁 mobile_analysis

           📁 onboarding

           📁 phone_management

    • This is where the client drops off files that they want pushed through CX Builder. (Example: Onboarding Files, Messaging Files, etc.)

      1. post all cca files into /dropoff/cca 

      2. post all consent_update files into /dropoff/consent_update

      3. post all deactivation files into /dropoff/deactivation

      4. post all messaging files into /dropoff/messaging

      5. post all mobile analysis files into /dropoff/mobile_analysis

      6. post all onboarding files into /dropoff/onboarding

      7. post all phone number management files into /dropoff/phone_management

    • When clients are dropping files to Relay, they have encrypted it with Relay’s public PGP key. We maintain the private PGP key that enables only Relay to decrypt the files.

    Pick Up Folder Structure

    Description

    📁 pickup

           📁 cca

           📁 consent_update

           📁 deactivation

           📁 messaging

           📁 mobile_analysis

           📁 onboarding

           📁 phone_management

           📁 report

    This is where return data and files that the client is picking up from Relay are placed. (Example: Connection Feed, Message Funnel, and Reject Files)

    1. pickup all cca REJECT files from  /pickup/cca 

    2. pickup all consent_update REJECT files from /pickup/consent_update

    3. pickup all deactivation REJECT files from  /pickup/deactivation

    4. pickup all messaging REJECT files from /pickup/messaging

    5. pickup all mobile analysis REJECT files from  /pickup/mobile_analysis

    6. pickup all onboarding REJECT files from  /pickup/onboarding

    7. pickup all standard reports from  /pickup/report

    • The File Engine in CX Builder uses the client-provided public PGP/GPG key to encrypt all files going into the pickup folders.

    • Client will use their private PGP key to decrypt the files placed in the pick-up location of the SFTP.

    Power-Ups Form Reporting

    • Relay’s Power-Ups offering allows for clients to send online forms to their customers on the Relay feed. From their Relay feed, customers can electronically complete client specific data and questions, submit the form, and/or sign via an Electronic Signature. The data populated on the forms by customers (i.e. First Name, Last Name, or simple Form Responses to Questions) is then stored within the Relay platform. Clients can access this data through the Relay SFTP offering as both .csv files and individual PDF submissions.

    • Files are available in the below folder:

      •  /pickup/report

    • Metadata submitted by customers on the form are found in the .csv files with the naming convention: FormID_YYYY_MM_DD_UUID.csv.

    • Individual Forms submitted can be compressed into the .zip files with the naming convention: FormID_YYYY_MM_DD_UUID-pdfs.zip (Note: Please contact your Relay Account Team to have this feature turned on)

    Was this article helpful?
    What's Next
    ESC

    Eddy AI, facilitating knowledge discovery through conversational intelligence