---
title: Automatic boosting
slug: '3037'
canonical_url: https://docs.coveo.com/en/3037/
collection: coveo-for-sitecore-v5
source_format: adoc
---
# Automatic boosting

> **Legacy feature**
>
> The Coveo Hive Framework is now in maintenance mode and is no longer recommended for new implementations.
> 
> To build new search experiences, use one of Coveo's more modern, lightweight, and responsive libraries.
> To get started, see the [Build search](https://docs.coveo.com/en/2473/) article.

[.version.c4sc.c4sc-edition.enterprise]
[Enterprise edition^,role=version-tag](https://www.coveo.com/en/pricing/sitecore)


> **Important**
>
> This feature was meant primarily for old on-premises implementations and should no longer be used.
> [Coveo Machine Learning (Coveo ML)](https://docs.coveo.com/en/188/) now drastically improves the quality of results provided to users automatically, without drawing any information from Sitecore pattern and profile cards.

![Coveo for Sitecore Specific Rendering](c4sc-v5/sitecore-20-px-new.png)
Implements the **CoveoForSitecoreRankingExpression** component using rules defined by the Sitecore xDB profiles.
This component adds a [query ranking function (QRF)](https://docs.coveo.com/en/237/) to the [advanced query expression (`aq`)](https://docs.coveo.com/en/175/) of queries to boost documents that match the Pattern Card, assigned to the visitor by Sitecore, based on items previously viewed by the visitor.

## Usage notes

* The **{doctitle}** rendering is added automatically with the **Coveo Search Interface** rendering.

* Automatic Boosting requires the following:

** You have a Sitecore instance with xDB installed.

** You've defined Profiles, Profile Cards, and Pattern Cards in your Sitecore instance and have assigned Profile Cards to your items (see [Use automatic boosting](https://docs.coveo.com/en/2614/)).

** You've indexed documents with the parameter `indexAnalyticsFields` set to `true` (see [About the Coveo Search Provider configuration file](https://docs.coveo.com/en/2562/)).

** You've enabled and configured automatic boosting in the rendering data source.
The `Enable automatic boosting` option is disabled by default.

## Insertion location


<div>
<h3>Coveo Hive</h3>
  <p>The <strong>Automatic Boosting</strong> rendering is an Allowed Control in the following placeholder(s): <code class="highlighter-rouge">UI Header</code>, <code class="highlighter-rouge">Recommendations Components</code></p>
  <video width="690" height="335" controls="">
  <source src="{{ site.baseurl }}/assets/images/c4sc-v5/automatic-boosting-hive.mp4" type="video/mp4" />
  Your browser doesn't support the video tag.
</video>
  <div class="figure-caption">Example insertion sequence for the <strong>Automatic Boosting</strong> rendering.
  </div>
</div>
<div>
<h3>Coveo Hive SXA</h3>
  <p>The Coveo for Sitecore SXA <strong>Automatic Boosting</strong> rendering is meant to be inserted in specific placeholders (that is, <code class="highlighter-rouge">UI Header</code>, <code class="highlighter-rouge">Recommendations Components</code>).</p>
  <video width="690" height="335" controls="">
  <source src="{{ site.baseurl }}/assets/images/c4sc-v5/automatic-boosting-sxa.mp4" type="video/mp4" />
  Your browser doesn't support the video tag.
</video>
  <div class="figure-caption">Example insertion sequence for the <strong>Automatic Boosting</strong> rendering.
  </div>
</div>

## Data source options

The following table lists the available data source options for this rendering.

[%header,cols="33%,66%"]
|===
|Option name
|Description

|Enable automatic boosting
|Enables automatic boosting and allows setting the boosting parameters.

|Focusfootnote:data-source[If custom profiles are added to the default Sitecore profiles, the data source will list these as well.]
|Allows setting the boosting parameters based on the `Focus` profile.

|Functionfootnote:data-source[If custom profiles are added to the default Sitecore profiles, the data source will list these as well.]
|Allows setting the boosting parameters based on the `Function` profile.

|Personafootnote:data-source[If custom profiles are added to the default Sitecore profiles, the data source will list these as well.]
|Allows setting the boosting parameters based on the `Persona` profile.

|Scorefootnote:data-source[If custom profiles are added to the default Sitecore profiles, the data source will list these as well.]
|Allows setting the boosting parameters based on the `Score` profile.

|Boosting influence (%)
|Setting used to specify boosting of current profile (`Focus`, `Function`, `Persona`, etc.) relative to the other profiles being boosted.

|Boosting weight range
|Setting used to be more or less restrictive about the boosting.
A larger value lets you boost profile keys with percentages further from the pattern, and a smaller value makes your boosting affect only items with the exact same profile key percentage as the pattern.

|Dominant keys boosting influence (%)
|Setting used to increase the maximum boost value of the dominant profile key of a pattern by the amount specified.
Its default value is `50%`.
|===

## Sample generated HTML and corresponding visual output

In the Sitecore Marketing Control Panel, under the `Focus` profile, you have set up a profile card called `Do it yourselfer` with the profile key values shown to the right.

![Do it yourselfer | Coveo for Sitecore 5](https://docs.coveo.com/en/assets/images/c4sc-v5/do-it-yourselfer-profile-key-values.png)

You've then associated the `Do it yourselfer` profile card to several items, reindexed those items, and configured your **Coveo Search Interface** data source as follows.

![Autoboost config | Coveo for Sitecore 5](https://docs.coveo.com/en/assets/images/c4sc-v5/auto-boosting-config-sample.png)

**Generated HTML:**

```xml
<div class="CoveoForSitecoreRankingExpression" data-sc-ranking-scope-node=
"{"rankingExpressions" : [],"rankingFunctions" : [],"textualRankingExpressions" :
[{"expression" : "$qrf(expression:\u0027exp(-(@focusz32xbackgroundz32xkeyz32xpercent-0.3)^2/(2*0.01))*30 +
exp(-(@focusz32xpracticalz32xkeyz32xpercent-0.8)^2/(2*0.01))*120 +
exp(-(@focusz32xprocessz32xkeyz32xpercent-0.8)^2/(2*0.01))*120 +
exp(-(@focusz32xscopez32xkeyz32xpercent-0.4)^2/(2*0.01))*40\u0027, normalizeWeight: true)"}]}">
</div>
```

**Search API call `aq`:**

After viewing a few items with the `Do it yourselfer` profile card, Sitecore assigns the `Do it yourselfer` pattern to the visitor.
Subsequent Coveo-powered search page calls to the Search API show the following `aq`.

![QRE for automatic boosting | Coveo for Sitecore 5](https://docs.coveo.com/en/assets/images/c4sc-v5/qre-for-automatic-boosting-sample.png)