Warning

title	DEPRECATED ETL

The Dimension ETL is deprecated as of 9/7/2021. Key information is as follows:

Dimension ETL Replacement:

The Catalog Object ETL should be leveraged in place of the Dimension ETL to populate data against blogs, articles, or user created catalog object types
The Catalog Object ETL provides the exact same functionality as the Dimension ETL, but reflects the updated platform nomenclature and transition away from the term "dimension"

Customers Currently Using the Dimension ETL:

Customers using the Dimension ETL to load in blog, article, or dimension data can continue to leverage existing files.
The term dimension is no longer used in the platform interface. Instead of Items and Dimensions, there are simply catalog objects and related catalog objects
If a customer using the dimension ETL needs to update their file or creates a new catalog object, we recommend taking the opportunity to transition to the new Catalog Object ETL to populate data
If you are transitioning from the Dimension ETL to the Catalog Object ETL, make sure to review the Catalog Object ETL documentation carefully, as column header format does change slightly

-- THE INFORMATION BELOW SHOULD ONLY BE REFERENCED BY CUSTOMERS THAT HAVE AN EXISTING DIMENSION ETL RUNNING. ALL OTHER CUSTOMERS SHOULD LEVERAGE THE CATALOG OBJECT ETL. --

Note

title	New Name: Marketing Cloud Personalization

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.

pixintegrations

Interaction Studio supports the ingestion of Articles, Blogs, and Dimensions into the catalog through ETL file feeds. The built-in dimension ETL is leveraged to ingest dimension data, Blog data, and Article data. This article outlines proper file formatting for each.

Section
Dimension Types cannot be created through an ETL feed and must be configured in Catalog Setup prior to importing dimension instances. Once the dimension types have been defined with appropriate custom attributes, instances of the dimension type can be created or updated using this ETL. The built-in system attributes associated with dimension types are defined in the schema section below.

Section

Articles & Blogs may be imported or updated using this ETL. For best results configure custom attributes and dimensions for articles and blogs in Catalog Object Setup to extend the built-in system attributes associated with each item type. While articles and blogs, along with their associated system attributes, can be imported without any prior configuration in Catalog Setup, custom attributes and dimensions must be configured to be supported by this ETL feed. The built-in system attributes associated with each item type are defined in the Requirements and Schema section below.

Panel

borderColor	#ccc
titleColor	#404040
borderWidth	1
titleBGColor	#f4f5f7
title	This Article Explains

This article details the requirements and configuration settings of the Dimension ETL gear for ingesting articles, blogs, and dimensions. It also provides the file schemas for each item type along with downloadable sample files.

Panel

borderColor	#ccc
titleColor	#404040
borderWidth	1
titleBGColor	#f4f5f7
title	Sections in this Article

Table of Contents

maxLevel	2

Requirements and Schema

Importing Dimensions

The Dimension ETL supports loading information for multiple Dimension Types (dimensionId) in a single file. It is expected that dimension values are grouped together by Dimension Type when included in the file. If the Dimension values are not provided in consecutive rows, a system administrator can sort the file on the Gear Configuration screen.

Values for id and dimensionId are required for all records, but if other columns have no value, the corresponding dimension attribute will be unset resulting in a null value for that attribute.

Importing Articles and Blogs

Each article and blog should only appear in a single record of any given file. In the case where there are multiple records with the same article or blog ID, the last complete and valid record in the file will be the one whose data is loaded into the system.

Articles and blogs lacking an attribute value in one of the attribute columns will have any existing value(s) for that attribute removed. This means that if an attribute column is included in the file, all records in the file should have a value for that column, not just the records whose values have changed.

File Naming Conventions

ETL processing will begin when an appropriately named file lands in the 'inbound' directory of your Salesforce SFTP site. The name of the file determines which type of data is loaded. The following file-name convention should be used:

dimension-YYYY-MM-DD_HH-MM-SS.csv.[zip|gz|pgp|gpg] for adding or updating instances of existing dimension types.

blog-YYYY-MM-DD_HH-MM-SS.csv.[zip|gz|pgp|gpg] for adding or updating blog posts.

article-YYYY-MM-DD_HH-MM-SS.csv.[zip|gz|pgp|gpg] for adding or updating articles.

File Formats

Dimension ETL

Field Name	Minimum Requirements	Example Values	Max Length	Interaction Studio Data Type
id	Required. A dimension instance Id must exactly match the id captured by the web SDK sitemap. A specific id value is only expected once per file feed. When an id appears multiple times in the same feed file, the content of the last row with the id will overwrite any previous updates and load into the catalog.	prod1237723	255	String
dimensionId	Required. Dimension Id must be one of the dimension types configured in the Catalog Object Setup screen.	SaleStatus Brand	255	String
attribute:<attribute name>	The custom attributes for this dimension. Column titles are the word attribute followed by a colon, followed by the attribute name as configured in the attributes portion of Catalog Setup > Dimension in Interaction Studio. Attributes are parsed as the data type defined in the catalog (See Catalog Setup).	attribute:fit wide attribute:length long	1023	any
dimension:<dimension name>	Dimensions may have additional dimensions associated with them. Column titles are the word dimension followed by colon, followed by the dimension name. Each dimension name must match one configured in Catalog Setup in Integration Studio. A dimension can have multiple dimensions in separate columns. A dimension can have multiple values for the same dimension, separated by the pipe character.	dimension:Color Blue\|Yellow dimension:Materia Leather	1023	String
System Fields
attribute:name	Represents the name of the dimension and must contain at least one alphanumeric character.	Sale Regular Price	1023	String
attribute:url	RFC-3986 Complete URLs that represent the canonical dimension display page for this dimension.	https://example.com/onsale.html	1023	String
attribute:imageUrl	Fully-qualified URL for an image of this dimension.	https://example.com/img/sale.png	1023	String
attribute:description	Represents the description of the dimension and must contain at least one alphanumeric character.	Products on Sale	1023	String
attribute:promotable	Boolean, which defaults to true even if no value is set. When false, the item will not be returned by the Interaction Studio recommendation system.	TRUE	1023	Boolean
attribute:archived	Boolean, which defaults to false when no value is set. When true, the item will not be visible in the catalog. If this column is omitted from the feed file, no changes will be made to the archived attribute.	FALSE false TRUE true	1023	Boolean

Article and Blog ETL

Field Name	Minimum Requirements	Example Values	Max Length	Interaction Studio Data Type
id	Required. Article and Blog IDs must exactly match the ids captured by the Integration Studio Web SDK Sitemap or they will load as separate items.	prod1237723	255	String
attribute:<attribute name>	The custom attributes for this article. Column titles are the word 'attribute' followed by colon followed by the attribute name as configured in the attributes portion of the Catalog Setup -> Article screen. Attributes are parsed as the data type they are defined as in the config screen.	attribute:topic Hats attribute:readtime 10 minutes	1023	any
dimension:	Additional dimensions such as brand and color may be defined and imported with matching column names. Each dimension name must match a dimension configured in Catalog Setup. Column titles are the word dimension followed by colon followed by the attribute name. An article can have multiple dimensions in separate columns. An article can have multiple values for the same dimension, separated by the pipe character.	dimension:author R. Frost	1023	String
categories	List of category IDs that may be defined using pipe delimiting.	Footwear \| Running Men \| Footwear \| Running Women \| Footwear \| Running	1023	String
System Fields
attribute:name	Represents the name of the article and must contain at least one alphanumeric character.	Slick New Kicks	1023	String
attribute:url	RFC-3986 Complete URLs that represent the canonical article display page for this article.	https://example.com/articles/prod1.html	1023	String
attribute:imageUrl	Fully-qualified URL for an image of this item.	https://example.com/img/img1.png	1023	String
attribute:description	Represents the description of the article and must contain at least one alphanumeric character to be set.	Some excellent new shoes	250	String
attribute:promotable	Boolean which defaults to true, even if no value is set. When false, the item will not be returned by our recommendation system	TRUE	1023	Boolean
attribute:published	ISO 8601 Date time string for article published date.	2017-04-22T10:23:37Z	1023	Date
attribute:expiration	ISO 8601 Date time string for article expiration date.	2017-04-22T10:23:37Z	1023	Date
attribute:rating	The rating value associated with an article, While no specific scale is required, only the value should be provided. For example, the value 9/10 is invalid, while 9 is valid.	4.5	1023	Decimal/Float
attribute:numRatings	The number of ratings associated with an article.	5	1023	Integer
attribute:archived	Boolean, which defaults to false when no value is set. When true, the item will not be visible in the catalog. If this column is omitted from the feed file, no changes will be made to the archived attribute.	FALSE false TRUE true	1023	Boolean

Sample Files

Note
As a reminder, the Dimension ETL cannot create a new Dimension Type. All dimension types identified in the dimensionid column must already exist in the catalog for the sample file(s) to run correctly. Please refer to Catalog Setup for instructions on how to define dimension types.

Sample Dimension File Download

id	dimensionId	attribute:name	attribute:archived	attribute:url	attribute:imageUrl	attribute:description	dimension:SaleStatus	attribute:saleLanguage	attribute:materialUsability
onSale	SaleStatus	On Sale	FALSE	http://www.sample.com/sale	http://www.sample.com/image/sale.jpg	Items associated are on sale	OnSale	Super Sale
normal	SaleStatus	Normal	FALSE	http://www.sample.com/normalpricing	http://www.sample.com/image/normal.jpg	Items associated are not on sale		Half Off
lastChance	SaleStatus	Last Chance	FALSE	http://www.sample.com/l astchance	http://www.sample.com/image/lastchance.jpg	Last opportunity to get these items	OnSale	Sale Ends Soon
Sequins	Material	Sequins	FALSE	http://www.sample.com/sequins	http://www.sample.com/image/sequins.png	Sequins are a classic disc shaped bead used for clothing			difficult
Denim	Material	Denim	FALSE	http://www.sample.com/denim	http://www.sample.com/image/denim.png	Most commonly used in jeans, also a common material for jackets and less commonly socks			moderate
Wool	Material	Wool	FALSE	http://www.sample.com/wool	http://www.sample.com/image/wool.png	Procured from sheep wool is one of the most easy to use materials when crafting clothing			easy
Cotton	Material	Cotton	FALSE	http://www.sample.com/cotton	http://www.sample.com/image/cotton.png	A delightfully soft material used in crafting many garments			easy

Sample Article File Download

id	attribute:name	attribute:archived	attribute:url	attribute:imageUrl	attribute:description	attribute:promotable	categories	attribute:published	attribute:expiration	attribute:rating	attribute:numRatings	dimension:author	attribute:numViews
12568	What is Interaction Studio	FALSE	http://www.sample.com/article/12568	http://www.sample.com/image/article12568.jpg	Explore what Interaction Studio has to offer	TRUE	interactionstudio\|marketing	2020-01-15	2100-10-18	5	78	interactionstudio	650
67455	Marketing in 2020	FALSE	http://www.sample.com/article/67455	http://www.sample.com/image/article67455.jpg	Marketing in the time of wfh	False	interactionstudio\|Marketing\|2020	2020-03-09	2025-03-15	4.8	614	tolkien	1026
12054	Setup your account	FALSE	http://www.sample.com/article/12054	http://www.sample.com/image/article12054.jpg	Setting up your Interaction Studio Account	True	interactionstudio\|Account\|2020	2019-11-18	2024-10-16	4.99	322	anonymous	87165
98466	Understanding Einstein	FALSE	http://www.sample.com/article/98466	http://www.sample.com/image/article98466.jpg	Understand how Einstein interacts with Interaction Studio	True	interactionstudio\|Einstein\|Marketing	2020-02-14	2029-10-19	3.57	9	anonymous	10021

Sample Blog File Download

id	attribute:name	attribute: archived	attribute:url	attribute:imageUrl	attribute:description	attribute:promotable	categories	attribute:published	attribute:expiration	attribute:rating	attribute:numRatings	dimension:author	attribute:numViews
customerinsight	What is Interaction Studio	FALSE	http://www.sample.com/blog/customer-insight	http://www.sample.com/image/blog12568.jpg	Explore our view on customers and gain insight about them	TRUE	interactionstudio\|marketing\|customer	2020-01-15	2100-10-18	5	78	interactionstudio	650
fallfashion	Fall Fashion	FALSE	http://www.sample.com/blog/fall-fashion	http://www.sample.com/image/blog67455.jpg	Get the hottest looks in fall fashion now	False	fall\|fashion\|clothing\|2020	2020-03-09	2025-03-15	4.8	614	John Smith	1026
devTrends	Web Developer Trends	FALSE	http://www.sample.com/blog/web-dev-trend	http://www.sample.com/image/blog12054.jpg	Know what's trending today in web dev	True	webdev\|git\|2019\|current	2019-11-18	2024-10-16	4.99	322	anonymous	87165
Einstein	Understanding Einstein	FALSE	http://www.sample.com/blog/einstein	http://www.sample.com/image/blog98466.jpg	Learn about how Einstein can be applied	True	interactionstudio\|Einstein\|Marketing	2020-02-14	2029-10-19	3.57	9	anonymous	10021
12120	Understanding Interaction Studio	FALSE	http://www.sample.com/blog/understandis	http://www.sample.com/image/blog12120.jpg	Take a peek into Interaction Studio Einstein	TRUE	interactionstudio\|Einstein\|2020\|actions	2020-08-19	2080-01-02	4.15	41	interactionstudio	36451

Hidestuff

Space shortcuts

Page tree

Versions Compared

Old Version 10

New Version Current

Key

Requirements and Schema

Importing Dimensions

Importing Articles and Blogs

File Naming Conventions

File Formats

Dimension ETL

Article and Blog ETL

Sample Files

Sample Dimension File Download

Sample Article File Download

Sample Blog File Download

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 10

New Version Current

Key

Requirements and Schema

Importing Dimensions

Importing Articles and Blogs

File Naming Conventions

File Formats

Dimension ETL

Article and Blog ETL

Sample Files

Sample Dimension File Download

Sample Article File Download

Sample Blog File Download