Page tree
Skip to end of metadata
Go to start of metadata

You can use the Manual Segment ETL in Interaction Studio to easily maintain manual segments using an ETL feed.

This Article Explains

This article details the requirements, schema, and configuration required to use the Manual Segment ETL and provides a downloadable .zip file containing example feed file formats.

Sections in this Article

Overview

Interaction Studio supports the following ETL modes for updating manual segments:

  • Delta mode - add or remove one or more users from one or more manual segments. This mode can support changes to multiple segments in a single feed. If you need to update multiple segments, you can use a single file for changes to all manual segments affected.
  • Replace mode - replace the entire membership of a single manual segment with only users in the current file. This mode can only support a single segment in a feed. If you need to update multiple segments, you will need a separate file for each segment.

Prior to using the Manual Segment ETL to update any manual segments, you must create those segments in Interaction Studio. The Manual Segment ETL can only update existing segments and cannot create new segments. It also only adds or removes individuals from the segment(s) - it will not bring over any user attributes.


Filename Format

The name of the file determines if processing is in Delta mode or Replace mode. The following file name formats should be used:

    • segment-delta--YYYY-MM-DD_HH-MM-SS.csv.[zip|gz|pgp|gpg] for adding/removing users from manual segments.

    • segment-replace-YYYY-MM-DD_HH-MM-SS.csv.[zip|gz|pgp|gpg] for replacing all users in a single manual segment.


Requirements and Schema

Feed files are expected to arrive in .csv file format adhering to the schema below. Files that do not follow the naming conventions or the appropriate schema will result in one or more errors and will fail to process.

IMPORTANT NOTE

For customers leveraging Interaction Studio’s multiple identities system, at least one identity attribute is required to be present in the ETL file. If you would like to send in multiple identity attributes for a single customer, this is supported by simply having multiple identity attribute columns in the file. 

The correct ETL header format for identity attributes is attribute:value. Examples of the out-of-the box identity attributes with proper formatting is as follows:

  • attribute:emailAddress
  • attribute:sfmcContactKey
  • attribute:customerId
  • attribute:sfcrmContactId
  • attribute:sfcrmLeadId

userId is not referenced in ETL processing when the multiple identities system is enabled. For customers NOT leveraging Interaction Studio’s multiple identities system, userId will still be supported for profile merging.


Schema Definition

Field Name

Minimum Requirements

Example Values

Max Length

userId OR an Identity Attribute

Required.

  • For clients that ARE NOT using Interaction Studio's multiple identities system, a userId must be included. This ID must be one that is tracked within the Evergage platform so that the events can be tied to the specific user profile.
  • For clients that ARE using Interaction Studio's multiple identities system, userId is not referenced in ETL file loads. At least one identity attribute is required. Multiple identity attributes can be included for a single user by simply including multiple columns in the file. The proper format for identity attributes is detailed in the comment above.

jdoe

john.doe@example.com

c2e384084c8ac233

120

segmentId

Required. The ID of the segment this record will apply to. Segment IDs can be found in the URL of the Interaction Studio UI when selecting the segment from the segment list page. These are typically 5 character alphanumeric values.

abcde


updateType

Only used by Delta mode.

Optional: Identifies if the record should be added to a segment, or a removed from a segment. Accepted values are: Add and Remove.

Defaults to Add when not specified.

Add


       

Sample Files

For Clients NOT leveraging Interaction Studio's multiple identities system

Delta

Sample Manual Segment Delta File Download

userIdsegmentIdupdateType
user1abcdeAdd
user2abcdeAdd
user3abcdeRemove
user4fghijAdd
user5fghijRemove

Replace

Sample Manual Segment Replace File.

userIdsegmentId
user6klmno
user7klmno
user8klmno
user9klmno

For Clients leveraging Interaction Studio's multiple identities system

Delta

attribute:alternateIdattribute:emailAddressupdateType
fifthuseruser5@user.comAdd

johndoe@jdoe.comAdd

janedoe@jdoe.comRemove
sampleuser
Add
exampleuseridexample@example.comRemove

Replace

attribute:emailAddressattribute:alternateIdsegmentId
johndoe@jdoe.com
segm1
janedoe@jdoe.com
segm1

sampleusersegm1

testalternateidsegm1
user5@user.comfifthusersegm1