Page History
| Note | ||
|---|---|---|
| ||
Interaction Studio (formerly Evergage) is now known as Marketing Cloud Personalization. The new name reflects our mission and vision for innovation in Salesforce Marketing Cloud. We wish we could snap our fingers to update the name everywhere, but you can expect to see the previous name in various places until we replace it. |
You can use the Manual Segment ETL in Interaction Studio to easily maintain manual segments using an ETL feed.pixintegrations
| Panel | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
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. |
| Panel | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
|
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.
| Warning | ||
|---|---|---|
| ||
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:
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.
| 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. | Add |
Sample Files
For Clients NOT leveraging Interaction Studio's multiple identities system
Delta
Sample Manual Segment Delta File Download
| userId | segmentId | updateType |
|---|---|---|
| user1 | abcde | Add |
| user2 | abcde | Add |
| user3 | abcde | Remove |
| user4 | fghij | Add |
| user5 | fghij | Remove |
Replace
Sample Manual Segment Replace File.
| userId | segmentId |
|---|---|
| user6 | klmno |
| user7 | klmno |
| user8 | klmno |
| user9 | klmno |
For Clients leveraging Interaction Studio's multiple identities system
Delta
| attribute:alternateId | attribute:emailAddress | updateType |
|---|---|---|
| fifthuser | user5@user.com | Add |
| johndoe@jdoe.com | Add | |
| janedoe@jdoe.com | Remove | |
| sampleuser | Add | |
| exampleuserid | example@example.com | Remove |
Replace
| attribute:emailAddress | attribute:alternateId | segmentId |
|---|---|---|
| johndoe@jdoe.com | segm1 | |
| janedoe@jdoe.com | segm1 | |
| sampleuser | segm1 | |
| testalternateid | segm1 | |
| user5@user.com | fifthuser | segm1 |
| Hidestuff |
|---|
Overview
Content Tools