Overview

Fields below have to be defined in Hawksearch in order for indexing to be working properly. Go to your environment to the Dashboard → Workbench → Data Configuration → Fields to define them.

Settings mentioned in the Field Type & Other / Advanced columns represent the minimum required settings to be configured on each field. Extra settings can be added as needed, for example: making fields queryable, defining boosting, or switching between different field types.

General Fields

These fields apply to both Optimizely commerce entities (products/variants/packages/bundles) and cms entities (cms pages) and are automatically sent by the Optimizely-Hawksearch Connector.

Label	Field Name	Save As	Field Type	Other / Advanced
Id	Id	Text	Field values are NOT stemmed	Primary Key?: Yes Include in results?: Yes
Name	Name	Text	Field values indexed "as is" AND are stemmed	Include in results?: Yes
StartPublish	StartPublish	Datetime	Field values are NOT stemmed	Include in results?: Yes
StopPublish	StopPublish	Datetime	Field values are NOT stemmed	Include in results?: Yes
IndexedOn	IndexedOn	Datetime	Stored only, not used for search nor facets	Include in results?: Yes
ContentLink	ContentLink	Text	Stored only, not used for search nor facets	Include in results?: Yes
ParentLink	ParentLink	Text	Stored only, not used for search nor facets	Include in results?: Yes
Item Type	ItemType	Text	Field values are NOT stemmed	Include in results?: Yes
Url	Url	Text	Stored only, not used for search nor facets	Include in results?: Yes

Commerce specific fields

These fields apply to only to commerce entities (products/variants/packages/bundles) and are automatically sent by the Optimizely-Hawksearch Connector.

Label	Field Name	Save As	Field Type	Other / Advanced
Code	Code	Text	Field values indexed "as is" AND are stemmed	Include in results?: Yes
Category	category	Text	Field values indexed "as is" AND are stemmed	Is Hierarchical Field?: Yes Include in results?: Yes
CatalogId	CatalogId	Text	Field values are NOT stemmed	Include in results?: Yes
DisplayName	DisplayName	Text	Field values indexed "as is" AND are stemmed	Include in results?: Yes
Markets	Markets	Text	Field values indexed "as is" AND are stemmed	Include in results?: Yes
Inventory_{WarehouseCode}**	Inventory_{WarehouseCode} ex: Inventory_London	Numeric	Field values are NOT stemmed	Include in results?: Yes
Price{MarketId}{Currency}**	Price{MarketId}{Currency} ex: Price_UK_GBP	Numeric	Field values are NOT stemmed	Include in results?: Yes
Child_DisplayName***	Child_DisplayName	Text	Field values indexed "as is" AND are stemmed	Is Child Field?: Yes Include in results?: Yes
Child_Code***	Child_Code	Text	Field values indexed "as is" AND are stemmed	Is Child Field?: Yes Include in results?: Yes
Child_Url***	Child_Url	Text	Stored only, not used for search nor facets	Is Child Field?: Yes Include in results?: Yes

** Inventory and price fields should be defined only if indexing this information is enabled. Please refer to Configuring the Connector for more details on how to enable/disable price or inventory indexing. For variants, only the Separate Documents indexing strategy is available for the price and inventory indexing out of the box. For packages, each strategy is available.

*** These fields are variant specific fields and are indexed only in the case of Variant as Child of Parent indexing strategy.

CMS specific fields

These fields apply to only to CMS entities (CMS pages) and are automatically sent by the Optimizely-Hawksearch Connector.

Label	Field Name	Save As	Field Type	Other / Advanced
SiteId	SiteId	Text	Stored only, not used for search nor facets	Include in results?: Yes

Extended Field Setup - For Optimizely Foundation

These fields were added to exemplify how the structure of the indexed documents can be enhanced with project specific properties (based on the Optimizely Foundation solution).

Foundation Commerce Entity

These fields apply to any to any commerce entity (product/variant/package/bundle).

Label	Field Name	Save As	Field Type	Other / Advanced
ImageUrl**	ImageUrl	Text	Stored only, not used for search nor facets	Include in results?: Yes
ImageAlt	ImageAlt	Text	Stored only, not used for search nor facets	Include in results?: Yes

Foundation Generic Variant

Label	Field Name	Save As	Field Type	Other / Advanced
Color	Color	Text	Field values are NOT stemmed	Include in results?: Yes Strategies: Variant Attributes Roll-up, Separate Documents
Size	Size	Text	Field values are NOT stemmed	Include in results?: Yes Strategies: Variant Attributes Roll-up, Separate Documents
Sku	Sku	Text	Field values are NOT stemmed	Include in results?: Yes Strategies: All
Mpn	Mpn	Text	Field values are NOT stemmed	Include in results?: Yes Strategies: All
Upc	Upc	Text	Field values are NOT stemmed	Include in results?: Yes Strategies: All
Description**	Description	Text	Field values indexed "as is" AND are stemmed	Include in results?: Yes Strategies: All
Child_Color	Child_Color	Text	Field values are NOT stemmed	Is Child Field?: Yes Include in results?: Yes Strategies: Variant as Child of Parent, Separate Documents
Child_Size	Child_Size	Text	Field values are NOT stemmed	Is Child Field?: Yes Include in results?: Yes Strategies: Variant as Child of Parent, Separate Documents

Note: Strategies refers to the variant indexing strategy adopted in the project.

Foundation Generic Product

Label	Field Name	Save As	Field Type	Other / Advanced
Manufacturer	Manufacturer	Text	Field values indexed "as is" AND are stemmed	Include in results?: Yes
Model	Model	Text	Field values are NOT stemmed	Include in results?: Yes
ModelYear	ModelYear	Text	Field values are NOT stemmed	Include in results?: Yes
Warranty	Warranty	Text	Stored only, not used for search nor facets	Include in results?: Yes
Brand	Brand	Text	Field values indexed "as is" AND are stemmed	Include in results?: Yes
Department	Department	Text	Field values indexed "as is" AND are stemmed	Include in results?: Yes
OnSale	OnSale	Boolean	Field values are NOT stemmed	Include in results?: Yes
NewArrival	NewArrival	Boolean	Field values are NOT stemmed	Include in results?: Yes
ProductStatus	ProductStatus	Text	Field values are NOT stemmed	Include in results?: Yes
Description**	Description	Text	Field values indexed "as is" AND are stemmed	Include in results?: Yes
LongDescription**	LongDescription	Text	Field values indexed "as is" AND are stemmed	Include in results?: Yes

Standard Page

Label	Field Name	Save As	Field Type	Other / Advanced
MetaTitle	MetaTitle	Text	Field values indexed "as is" AND are stemmed	Include in results?: Yes
Keywords	Keywords	Text	Field values indexed "as is" AND are stemmed	Include in results?: Yes
ImageUrl (BackgroundImage property in Foundation)**	ImageUrl	Text	Stored only, not used for search nor facets	Include in results?: Yes
LongDescription (MainBody property in Foundation)**	LongDescription	Text	Field values indexed "as is" AND are stemmed	Include in results?: Yes

Location Item Page

Label	Field Name	Save As	Field Type	Other / Advanced
MetaTitle	MetaTitle	Text	Field values indexed "as is" AND are stemmed	Include in results?: Yes
Keywords	Keywords	Text	Field values indexed "as is" AND are stemmed	Include in results?: Yes
ImageUrl**	ImageUrl	Text	Stored only, not used for search nor facets	Include in results?: Yes
Description (MainIntro property in Foundation)**	Description	Text	Field values indexed "as is" AND are stemmed	Include in results?: Yes
LongDescription (MainBody property in Foundation)**	LongDescription	Text	Field values indexed "as is" AND are stemmed	Include in results?: Yes
Coordinates	Coordinates	GeoPoint	Stored only, not used for search nor facets	Include in results?: Yes

** ImageUrl, Description and LongDescription fields have been reused between different types of entities since in Hawksearch there’s no hard link between fields and entity types (like the ones Optimizely platform requires)

NodeContent - Hierarchy Mapping

This page shows the relations between NodeContent (Optimizely category) and Hierarchy (Hawksearch category).

Optimizely Node Property	Hawksearch Hierarchy Property	Data Type	Always	Description
CategoryId (image)	HierarchyId	String	Yes	Unique identifier for the hierarchy entry
Display Name	Name	String	Yes	Display name for the hierarchy entry
ParentCategoryId	ParentHierarchyId	String	Yes	The HierarchyId of the parent hierarchy for this hierarchy entry. If this hierarchy entry is a top-level, the value passed should be "1". For instance, if in Optimizely a category resides directly below the catalog root, then this category will be indexed as an hierarchy with ParentHierarchyId = “1”.
False if Category is expired, true otherwise	IsActive	Boolean	No	Indicates if the hierarchy entry is active and should be displayed. It is not required to send inactive hierarchies, but some product systems generate them for sending.