Hawksearch Field Setup
- Vidhya Ananthanarayanan
What you’ll find on this page:
You might find these useful:
Â
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} | Numeric | Field values are NOT stemmed | Include in results?: Yes |
Price_{MarketId}_{Currency}** | Price_{MarketId}_{Currency} | 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 https://luminoslabs.atlassian.net/wiki/spaces/HC/pages/3747905553 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 |