Articles in this section

Direct Data Onboarding File Formatting

Avatar
Kelly Mead
  • Updated
Follow

Please follow the file formatting requirements specified below so that we can process your data as quickly as possible.  There are two options below for formatting your file, choose option one or two depending on the ID that you have available.

 

Option 1: File Formatting for Existing Hashed Emails, IP Addresses, or MAIDs: Follow these formatting instructions if you have one of the following IDs: MD5, SHA-128, SHA-256, IPv4, or MAID. 

Option 2: File Formatting for Unhashed Emails: Follow these formatting instructions if you have regular email addresses that you need to hash. Once formatted, you will use Resonate's hashing script to hash your emails.

 

Option 1: File Formatting for Hashed Emails, IP Addresses, or MAIDs

1. Resonate accepts multiple types of IDs: HEMs, MAIDs, and IP Addresses. Please see below for the full list and confirm that you have one of the following.

  • HEMs 
    • MD5 (preferred)
    • SHA-128  
    • SHA-256 
  • IP Address 
    • IPv4 
  • MAIDs

2. Your file must contain 4 columns with the following headers. All four column headers are needed within the file even if there is not data for a particular column.

  • Column 1 Header: ID Type
  • Column 2 Header: ID
  • Column 3 Header: Add
  • Column 4 Header: Remove 
HELPFUL RESOURCE
Refer to our sample spreadsheet to ensure that your file is formatted correctly. 

 

3. Once you have your four columns with headers, follow the instructions outlined below to fill out the information needed for each column.

Column 1: ID Type

Must include one of the following and be labeled as follows: 

  1. HEMSHA1 (for SHA-128) 
  2. HEMSHA2 (for SHA-256) 
  3. HEMMD5 (for MD5) 
  4. ip (for IPv4) 
  5. MAID

Column 2: ID  

ID corresponding to the ID type as defined in Column 1.   

 

No trailing or leading 0s (for IP).  

Column 3: Add   

IDs to be added to new or existing Groups and Segments.    

 

Formatted as:  <Group Name>=<Segment Name>  

Column 4: Remove   

IDs to remove that were onboarded in the past. Leave empty if there are no IDs that need to be removed.  

 

Formatted as:  <Group Name>=<Segment Name> 

For example:

28270b9d-9618-4d6c-993c-eb8191a89fba.png

CAUTION

Please ensure that your Add column contains a Group and Segment pair (Group=Segment) otherwise your data will not be viewable in the platform. Learn more about Groups and Segments.

 

4. Once your file is in the correct format, please save with the following name:

  • Name file(s) as follows: <client name>_<onboarding>_<Segment>_<date>
    • Segment is optional 
    • Example: Resonate_Onboarding_Segment1_20230302.csv

CAUTION

  • Do not include spaces in the file name
  • ID Types: HEMSHA1, HEMSHA2, HEMMD5, IP, MAID 
  • Date is the day when data is uploaded, formatted as: YYYYMMDD 

 

5. Save your file and take a moment to verify each column has the correct data:

  • File contains all 4 required column headers  1c3d8a45-216d-4e97-870b-003ef80d5bff.png
  • The data in each column matches the requirements outlined in Step 3 above
  • File is in .csv format
  • File contains the minimum number of records per segment - 20K 
  • File doesn’t contain more than the max number of records per file - 50M  
  • File doesn’t contain more than the max number of segments per file - 100

CAUTION

  • File cannot be compressed 
  • One file per ID type (Example: File #1 with SHA1 and File #2 with SHA2)
  • Do not include commas (,) or pipes (|) within the names of groups or segments
  • Best practices prior to hashing emails include:
    • Lower casing and trimming all leading and trailing spaces (Resonate’s hashing script does this automatically)
    • Using email addresses that are from the US only

 

6. Follow the instructions outlined here to upload your data to Box

 

Option 2: File Formatting for Unhashed Emails

1. Your file must contain 4 columns with the following headers. All four column headers are needed within the file even if there is not data for a particular column.

  • Column 1 Header: ID Type
  • Column 2 Header: Email
  • Column 3 Header: Add
  • Column 4 Header: Remove
HELPFUL RESOURCE
Refer to our sample spreadsheet to ensure that your file is formatted correctly. 

 

2. Once you have your four columns, then fill out the information needed for each column. Note that Resonate's hashing script will create a file for HEMMD5.

Column 1: ID Type

Must include the following label: 

HEMMD5 (for MD5)

Column 2: Email

The email addresses that you would like to hash

Column 3: Add 

IDs to be added to new or existing Groups and Segments.    

 

Formatted as:  <Group Name>=<Segment Name>

Column 4: Remove 

IDs to remove that were onboarded in the past. Leave empty if there are no IDs that need to be removed.  

 

Formatted as:  <Group Name>=<Segment Name>

Example:

image-20221114-190937.png

CAUTION

Please ensure that your Add column contains a Group and Segment pair (Group=Segment) otherwise your data will not be viewable in the platform. Learn more about Groups and Segments.

 

3. Save your file and take a moment to verify each column has the correct data:

  • File contains all 4 required column headers  
  • The data in each column matches the requirements outlined in Step 2 above
  • File is in .csv format
  • File contains the minimum number of records per segment - 20K 
  • File doesn’t contain more than the max number of records per file - 50M  
  • File doesn’t contain more than the max number of segments per file - 100

CAUTION

  • File cannot be compressed 
  • Do not include commas (,) or pipes (|) within the names of groups or segments
  • Best practices prior to hashing emails include:
    • Lower casing and trimming all leading and trailing spaces (Resonate’s hashing script does this automatically)
    • Using email addresses that are from the US only

4. Follow these instructions to hash your emails using Resonate's hashing script and upload directly to Box 

 

 

Related articles

Comments

0 comments

Please sign in to leave a comment.