Set Up Dynamic Context Variables

Use dynamic context variables to send user-defined attributes to the Personalization service with every personalization request. These attributes help refine recommendation responses and support advanced filtering logic in your recommenders. Dynamic variables reduce the number of recommenders you need to deliver your use cases. Define context variables in the Interactions SDK Sitemap globally or for specific page types.

Context Variable Fields

A dynamic context variable contains two fields: a name and a value.

Define a Dynamic Context Variable

Define dynamic context variables in the Interactions SDK Sitemap globally in the global configuration. Alternatively, define them for specific page types in the pageTypes configuration.

Example: Defining Dynamic Context Variables in the Global Configuration of the Sitemap

const sitemapConfig = {
  global: {
    contextualAttributes: {
      loyaltyTier: "GOLD",
      story: SalesforceInteractions.resolvers.fromSelector("#stories"),
    },
  }, // ...The rest of your sitemap configuration
};

Example: Defining Dynamic Context Variables in the pageTypes Configuration of the Sitemap

...
pageTypes: [
  {
    name: "Product",
    isMatch: () => window.location.pathname.includes("/product/"),
    contextualAttributes: {
      categoryAttribute: "Footwear",
      colorAttribute: SalesforceInteractions.cashDom('.btn.btn-primary.btn-lg').text()
    }
  }
],
...

Dynamic context variables work with string, number, and date filter fields. Use dynamic context variables with single-value operators, the Between operator (minimum and maximum values), and date-specific operators such as Last/Next Number of Days and Last/Next Number of Minutes.

To learn more about advanced filtering with dynamic context variables, see Filter Recommendations Using Dynamic Context Variables.

Reserved Contextual Attributes

The Interactions SDK automatically sends a set of standard contextual attributes with every personalization request. You can override some of these attributes in your sitemap configuration, but if the SDK has a valid value for an attribute, it overwrites your custom value. Before overriding a reserved attribute, verify that your custom value takes precedence in your implementation and that it doesn't interfere with expected personalization results.