Configure entities

Entity templates

In Sitecore Search, an entity, representing a type of content, is a structure or grouping of attributes. Sitecore Search is configured with templates to use when creating custom entities.

The sections in this topic describe the various entity templates built into Sitecore Search including the default entity, Content.

Here are links to procedures to manage your entities:

To create a custom entity, select a template and follow the procedure in Edit or create entities.
To add a custom attribute to an entity, follow the procedure in Add an attribute.
To edit a custom attribute of an entity, follow the procedure in Edit an attribute.

Content (default)

Content is the default entity in Sitecore Search and has attributes typical to content items including id, name, url, among others.

Display name	Attribute name	Data type	Required
Breadcrumbs	breadcrumbs	Array of strings
Content Type	type	String	Required
Description	description	String
Document Activeness	is_active	Boolean
Id	id	String	Required
Image url	image_url	String
Name/Title	name	String
Questions and Answering	rfk_questions	Array of composites
Review rating	review_rating	Float
Source	rfk_source	Composite
Stats	rfk_stats	Composite
Tags	tags	Array of strings
Url	url	String

Base entity

All entities in Sitecore Search, including the default entity Content inherit the attributes of this entity. This is the simplest and most basic entity.

Display name	Attribute name	Data type	Required
Document Activeness	is_active	Boolean
Id	id	String	Required
Source	rfk_source	Composite
Stats	rfk_stats	Composite

Product

Use this template to create a custom entity with attributes typical to products including category_names, brand, sku among others.

Display name	Attribute name	Data type	Required
Add to cart	add_to_cart	String
Additional image SKU urls	additional_sku_image_urls	String
Additional image urls	additional_image_urls	String
All category names	all_category_names	Array of strings
Brand	brand	String
Brand code	brand_code	String
Breadcrumbs	breadcrumbs	String
Bundle SKUs	bundle_skus	String
Category	all_category_ids	Array of strings
Category breadcrumbs	category_breadcrumbs	String
Category ids	category_ids	Array of strings
Category names	category_names	Array of strings
Color	color	String
Color display name	color_display_name	String
Color rgb value	color_rgb	String
Customer Category Identifiers	ccids	Array of strings
Description	description	String
Document Activeness	is_active	Boolean
Expiration Date	expiration_date	String
Final Price	final_price	Float
Hashed image url	image_id	String
Id	id	String	Required
Image url	image_url	String
Is in stock	is_in_stock	Boolean
Margin	margin	Float
Mobile SKU image url	mobile_sku_image_url	String
Mobile SKU url	mobile_sku_url	String
Mobile image url	mobile_image_url	String
Mobile product url	mobile_product_url	String
Name	name	String	Required
On sale	on_sale	Boolean
Price	price	Float
Product	product_group	String
Product lookup field	prod_lookup	Array of strings
Product type	product_type	String
Product url	product_url	String
Quick look	quick_look	String
Quick view	quick_view	String
RFK tags	rfk_tags	Object
Rank By 1	rankby1	Float
Rank By 2	rankby2	Float
Release Date	release_date	String
Review Count	review_count	Integer
Review link	review_link	String
Review rating	review_rating	Float
SKU	sku	String
SKU description	sku_description	String
SKU name	sku_name	String
Save off	save_off	Float
Search keywords	search_keywords	String
Set SKUs keywords	set_skus	String
Short_description	short_description	String
Sku Lookup	sku_lookup	Array of strings
Sku image url	sku_image_url	String
Sku sequence	sku_sequence	Integer
Sku url	sku_url	String
Source	rfk_source	Composite
Stats	rfk_stats	Composite
Stock quantity	stock_quantity	Integer
Stock unit	stock_unit	String
prod_url_key	prod_url_key	String
sku_url_key	sku_url_key	String
swatch	swatch	Array of objects

Category

Use this template to create a custom entity with attributes typical to a category including name, parent_ids, is_primary, among others.

Display name	Attribute name	Data type	Required
All Category Ids	all_ids	Array of strings
All Category Names	all_names	Array of strings	Required
All Category URL Keys	all_url_keys	Array of strings
All Category URL Paths	all_url_paths	Array of strings
All Customer Category Identifiers	all_ccids	Array of strings
Category Breadcrumbs	breadcrumb	Array of strings
Category Name	name	String	Required
Category Primary	is_primary	Boolean
Category Primary URL	url_path	String
Category Primary Url Key	url_key	String	Required
Customer Category Identifier	ccid	String	Required
Document Activeness	is_active	Boolean
Id	id	String	Required
Parent Category Ids	parent_ids	Array of strings
Parent Customer Category Identifiers	parent_ccids	Array of strings
Source	rfk_source	Composite
Stats	rfk_stats	Composite

If you have suggestions for improving this article, let us know!