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

Interaction Studio stores user profiles for each anonymous and named user in the system. These users can represent users of any of the supported channels including: web, mobile, email and in store. Custom attributes may be defined for user profiles with types and additional fields can be imported to those attributes with additional columns.


Per Dataset Limit

Review attribute limits on the CSV Feed Requirements Page


This Article Explains

This article details the requirements and schema for the User ETL and provides a sample file to download.

Sections in this Article

Requirements and Schema

Column names starting with attribute: should then match the custom attribute names set in the Attributes screen. When processed, the attribute: fields will be processed as the type the attribute is configured as in the platform.


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.  Only unique identities can be included and updated through etl.

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.


File Name Format: user-YYYY-MM-DD_HH-MM-SS.csv


Field NameMinimum RequirementsExample ValuesMax LengthData Type
userId OR an Identity Attribute

Required.

  • Four (4) character minimum.
  • 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 c2e384084c8ac233120String
attribute:The custom attributes for this user. Column titles are the word 'attribute' followed by colon followed by the attribute name as configured in the Attributes screen. These values must match the type of the attribute when configured.attribute:isLoggedIn true attribute:userLevel 51023Any Valid Interaction Studio Data type
System Fields



attribute:nameOptional: Display name for user

Bob Newhart

John Standard

120String
attribute:accountIdOptional. If provided, a string value of the account ID to associate with the user. Must be lowercase. This is only available with Interaction Studio B2B functionality enabled. Contact your account representative for more information.example.com120String

       

Sample File

Sample File Download (For Clients NOT leveraging Interaction Studio's multiple identities system)

userIdattribute:nameattribute:emailAddressattribute:accountIdattribute:isLoggedInattribute:visitNumberattribute:firstVisitDate
jdoeJohn Doejohndoe@example.com
TRUE402017-07-17
tester@test.comTestertester@test.comtestaccountTRUE152009-10-19T08:42:58Z
user103925


FALSE12020-07-07
a30bkcqfo941afcJane Smithexample@example.comexampleTRUE32020-04-01
interactionstudiouserInteraction Studio Usertesting@test.cominteractionstudioTRUE61302010-01-01

Sample File Structure: Leveraging the IS Multiple Identity System

attribute:emailAddressattribute:customerIdattribute:nameattribute:accountIdattribute:isLoggedInattribute:visitNumberattribute:firstVisitDate
johndoe@example.com3910vi2msp38g4John Doe
TRUE402017-07-17
tester@test.com8491505268e12fTestertestaccountTRUE152009-10-19T08:42:58Z

8f138t9fd128d1v

FALSE12020-07-07
example@example.com19218sdfee31savJane SmithexampleTRUE32020-04-01
testing@test.com9851ar4vbt450emInteraction Studio UserinteractionstudioTRUE61302010-01-01