Coveo for Sitecore 5 is now available!

Coveo for Sitecore Legacy Search UI Framework - User Context Component Properties

Coveo for Sitecore - January 2017 Cloud only Coveo for Sitecore 4.1 - November 2018

This article describes the properties that are available in the User Context component.

To learn how to implement the User Context to your pages, see Inserting and Customizing a User Context Component.

Property Description Additional details
Basic settings
UseIsAnonymous Whether to include if the user was anonymous in the context. Adds the pair "anonymity: true/false"
UseCountry

Whether or not to include the user country in the context.

Tracking must be enabled to use this property (see Analytics tracking).

Adds the pair "country: X"
UseDevice Whether or not to include the user device in the context. Adds the pair "device: X"
UseProfileCards

Whether or not to include the user profile card in the context.

Tracking must be enabled to use this property (see Analytics tracking).

Adds a key matching the profile name and its value
Advanced
EnableContextPipeline Whether to use the userContextPipeline to dynamically change the context with processors. See userContextPipeline.
CustomContext The constant key-value pairs to add to the context. See customContext.

Consult Coveo for Sitecore Hive Components to learn about context components used in the Coveo for Sitecore Hive framework.