Cloud SDK glossary

Version: 0.5

This topic explains general concepts and terms used within the Cloud SDK.

Sitecore and general Cloud SDK concepts

module

Cloud SDK packages consist of browser and server modules. Each module contains all the functions required to set up specific Sitecore DXP capabilities. The browser module is for setting them up on the browser side, and the server module is for setting them up on the server side.

package

The Cloud SDK consists of packages. Each package represents a set of Sitecore DXP capabilities. Cloud SDK packages consist of browser and server modules.

Sitecore Cloud SDK

A set of JavaScript packages. JavaScript developers use the Cloud SDK to extend web applications with Sitecore digital experience platform capabilities such as tracking, personalization, and search.

Sitecore digital experience platform (Sitecore DXP)

A suite of SaaS-enabled Sitecore products, each offering rich digital experience capabilities such as tracking, personalization, and search. The Cloud SDK supports the following Sitecore products:

  • Sitecore CDP

  • Sitecore Personalize

  • Sitecore Search

XM Cloud Front End Application Starter Kits

A code base that’s intended to be the basis of most XM Cloud implementations for Next.js and Angular applications. To use it, you select the foundation template option when creating a new project. It is open source, and available on GitHub. Using the starter kit ensures you get the most stable and up-to-date version of the assets, references, assemblies, and artifacts we recommend using when you start building a solution with XM Cloud. It includes:

  • Local development workstation resources that support debugging and testing.

  • JSS and headless libraries.

  • Headless SXA reference components, written in Next.js.

  • Personalization and analytics middleware.

Tracking

browser ID

A universally unique identifier (UUID) that Sitecore CDP assigns to every site visitor of your site. It is unique per browser, and it associates sessions and events with the respective site visitor. The Cloud SDK stores the browser ID as the value for the first-party sc_{SitecoreEdgeContextId} cookie in the web browser.

event

An action a site visitor performs in your app. For example, viewing a webpage, clicking a button, submitting an XM Cloud form, searching for content, or any other interaction you want to track.

When an event triggers, the event with all its data is sent to Sitecore and becomes available in the various Sitecore DXP products your organization has access to. This data drives real-time, unified tracking.

guest

A site visitor, also known as a user of your app. Site visitors are called guests in Sitecore CDP. That's why Cloud SDK developers encounter the term guest when they use the events package, and when they log in to Sitecore CDP to find captured events.

tracking

The process of capturing events in response to site visitors' actions.

unified tracking

A type of tracking where a single event sent from a web app becomes available in the various Sitecore DXP products your organization has access to. Developers only have to use the Cloud SDK and its single tracking implementation to send rich tracking data to Sitecore.

Personalization

friendly ID

A unique identifier that Sitecore Personalize assigns to every experience and experiment. Cloud SDK developers use the friendly ID to run a specific interactive experience or interactive experiment.

guest ID

The guest ID, called guest reference in Sitecore CDP, is a universally unique identifier (UUID) that Sitecore CDP assigns to every site visitor of your site. It is unique per site visitor. The Cloud SDK personalize package stores the guest ID as a first-party cookie in the web browser.

interactive personalization

A type of personalization (experience or experiment) created in Sitecore Personalize typically by developers, and delivered to site visitors via APIs.

An interactive experience or interactive experiment enables developers to create dynamic content by using APIs to access back-end systems for maximum server-side personalization. These personalizations are used to show offers or operational messages with personalized, dynamic content.

personalization

The process of creating multiple variants of pages or components and then displaying those variants to different audiences depending on specific conditions. The Cloud SDK supports the personalization process by displaying the relevant content to your site visitors.

web personalization

A type of personalization (experience or experiment) created in Sitecore Personalize typically by marketers.

A web experience or web experiment enables marketers to create personalized content, offers, and operational messages using web templates.

XM Cloud personalizations

Page-level personalizations of layouts and content for different audiences, typically created by marketers. These personalizations and tests run in Content SDK and JSS apps automatically, with no coding required.

Search experiences

boost

A way to increase the relevance of the item or the group of items by making them appear higher in the results list. You can use this to improve the visibility of certain content.

bury

A way to decrease the relevance of the item or the group of items by making them appear lower in the search results. You can use this to reduce the visibility of certain content.

content collection

A list of all indexed items for each entity.

context

A set of contextual information (background details) about a site visitor's search request, such as locale, location, device, and web browser information. Sitecore Search uses this data for personalizing search results.

entity

A core data object within a domain, representing a real-world concept, object, or resource. Attributes capture data related to the entity such as ID, price, data modified etc. An entity can be Content, Product, Category, or Store, and custom entities can be created.

facet

A tool for further refining the search results that are already returned to your app. Facets are displayed in the user interface and site visitors use them to narrow down the search results.

filter

A tool for limiting the search results before Sitecore Search returns them to your app.

index document

A JSON object that represents a single item in the content collection.

pin

A way to set the position of a particular item in search results that overrides other search filters. You can use this to highlight content that is important or relevant for your visitors or if you want to highlight a recommendation.

questions-answers widget

A widget that provides an AI-generated answer to the site visitor's question, and, optionally, more related questions.

recommendation widget

A widget that provides items based on an associated recipe with the purpose of driving conversions.

rule

A modification to widget behavior that can be used to overwrite the natural set of results, for example, to boost, bury, pin, and blacklist items. A rule can have its own variations as well as its own rules, and is evaluated when called from the customer website.

search experience

An interaction that a site visitor has with a Sitecore Search implementation that influences their satisfaction and future behavior.

search results page

A page displaying items as a result of an entered search query.

search results widget

A widget that provides a comprehensive and ordered list of search results, based on a site visitor query. The site visitor can refine the list using facets, filters, and other features.

slot

A position in a list of search results to which you can pin an item or apply a boost rule.

source

A connector that retrieves items from a specified website, document, or repository, and indexes them so they are searchable. A source can be, for example, a web crawler, an API crawler, or an API push.

suggestion block

An algorithm in the preview search widget that provides site visitors with relevant suggestions.

widget

A configurable page component that collects and transmits search-related content to your app. Widgets are set up and published in Sitecore Search, and Cloud SDK developers request widget data in their app. After Sitecore Search responds with the widget data, developers can use the data to display search experiences to site visitors.

widget ID

A widget ID, also known as the RFK ID, is a unique identifier assigned to every widget in Sitecore Search. Cloud SDK developers use the widget ID when requesting widget data and when capturing events that occur in a specific widget.

Do you have some feedback for us?

If you have suggestions for improving this article,