---
title: "Win-Back (WB) engine"
slug: "win-back-wb-engine"
description: "The Win-Back (WB) engine generates a spend history for each of your desired customer and product group combinations. This engine highlights spending during the historical peak year and evaluation periods."
updated: 2024-04-08T13:54:50Z
published: 2024-04-08T13:54:50Z
canonical: "docs.zilliant.com/win-back-wb-engine"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zilliant.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Win-Back (WB) engine

The Win-Back (WB) engine generates a spend history for each of your desired customer and product group combinations. This engine highlights spending during the historical peak year and evaluation periods.

## Configuration

To configure this engine, adjust the following components.

### Engine Parameters

To view the parameter settings for this engine, go to the Engine Parameters worksheet. Depending on your user permissions, the worksheet will resemble the following image.

![Engine Parameters worksheet](https://cdn.document360.io/24f960e8-3c1c-4c18-a2c6-83b6ae4aab84/Images/Documentation/Engine%20Parameters.png?sv=2026-02-06&spr=https&st=2026-11-12T13%3A12%3A07Z&se=2026-11-12T14%3A12%3A07Z&sr=c&sp=r&sig=l%2F7IYgQgsk9pDWjnim%2FtWI%2F64FdbzxEJUC8kCvtJsTw%3D)

The WB engine uses the following parameters associated with an Action Type Id of *WB*:

- **Evaluation_Periods**—Specifies the number of historical aggregation periods used to calculate this action type’s Evaluation time period.  

To view an action type’s Evaluation time period, go to the Aggregated Time Periods worksheet. To update an action type’s Evaluation time period, run the **Prep Data and Update Time Periods** worksheet action.
- **Peak_Year_Periods**—Specifies the number of historical aggregation periods used to calculate this action type’s Peak Year time period. The WB engine interprets that the Peak Year starts at the first of the year for the minimum year included in the time period. This ensures the engine only considers full calendar years.  

To view an action type’s Peak Year time period, go to the **Aggregated Time Periods** worksheet. To update an action type’s Peak Year time period, run the **Prep Data and Update Time Periods** worksheet action.

          For example,

          

If the following conditions are met:

- You set **Peak_Year_Periods** to *36*.
- The calculated Peak Year time period is from 4/1/2018 to 3/31/2020.

Then the engine considers the full 2018 calendar year when identifying the peak year.

### Volume Metric

To view the volume metric for this engine, go to the **Sales IQ** > **Engine Config** > **Sales IQ Transactions Aggregated** worksheet. Depending on your user permissions, the worksheet will resemble the following image.

![SIQ Txns Aggregated worksheet](https://cdn.document360.io/24f960e8-3c1c-4c18-a2c6-83b6ae4aab84/Images/Documentation/SIQ%20Txns%20Aggregated%20worksheet.png?sv=2026-02-06&spr=https&st=2026-11-12T13%3A12%3A07Z&se=2026-11-12T14%3A12%3A07Z&sr=c&sp=r&sig=l%2F7IYgQgsk9pDWjnim%2FtWI%2F64FdbzxEJUC8kCvtJsTw%3D)

The **WB Volume Metric** [calculated column](/v1/docs/calculated-columns) defines the volume metric used in the WB engine. The following default calculation uses revenue normalized with any applicable currency conversions. Update this calculation as needed.

```
(CASE WHEN ([Currency Conversion Rate] > 0)
THEN [Currency Conversion Rate]
ELSE 1
END)
* [Revenue]
```

### Product Group

To view how this engine groups products, go to the Sales IQ Products worksheet and navigate to the **WB Product Group** [calculated column](/v1/docs/calculated-columns). Depending on your user permissions, the worksheet will resemble the following image.

![SIQ Products worksheet](https://cdn.document360.io/24f960e8-3c1c-4c18-a2c6-83b6ae4aab84/Images/Documentation/SIQ%20Products%20worksheet.png?sv=2026-02-06&spr=https&st=2026-11-12T13%3A12%3A07Z&se=2026-11-12T14%3A12%3A07Z&sr=c&sp=r&sig=l%2F7IYgQgsk9pDWjnim%2FtWI%2F64FdbzxEJUC8kCvtJsTw%3D)

Edit the calculated column to use any available product attributes that best define the product grouping level for the WB engine. This engine excludes products configured with a *null* value from engine outputs.

          Note

          

This column does not support commas or slashes, as these special characters can cause issues when retrieving analytics for published [actions](/v1/docs/about-campaigns#actions).

## Outputs

![Outputs - WB](https://cdn.document360.io/24f960e8-3c1c-4c18-a2c6-83b6ae4aab84/Images/Documentation/Outputs%20-%20WB.png?sv=2026-02-06&spr=https&st=2026-11-12T13%3A12%3A07Z&se=2026-11-12T14%3A12%3A07Z&sr=c&sp=r&sig=l%2F7IYgQgsk9pDWjnim%2FtWI%2F64FdbzxEJUC8kCvtJsTw%3D)

To view the results of running the WB engine, go to the WB Engine Output worksheet. Depending on your user permissions, the worksheet will resemble the following image.

![WB Engine Output worksheet](https://cdn.document360.io/24f960e8-3c1c-4c18-a2c6-83b6ae4aab84/Images/Documentation/WB%20Engine%20Output%20worksheet.png?sv=2026-02-06&spr=https&st=2026-11-12T13%3A12%3A07Z&se=2026-11-12T14%3A12%3A07Z&sr=c&sp=r&sig=l%2F7IYgQgsk9pDWjnim%2FtWI%2F64FdbzxEJUC8kCvtJsTw%3D)

This engine generates results for every Customer Id + Product Group combination observed during the Peak Year and Evaluation time periods. This worksheet contains the following metric fields:

- **Peak Year**—Calendar year with the maximum volume during the Peak Year time period. The engine measures this volume in the WB Volume Metric.
- **Peak Year Avg Volume**—Average volume for the aggregation period (weekly or monthly) during the Peak Year time period. The engine measures this volume in the WB Volume Metric.
- **Evaluation Avg Volume**—Average volume for the aggregation period (weekly or monthly) during the Evaluation time period. The engine measures this volume in the WB Volume Metric.
- **Percent Change**—Percent change from the Peak Year Avg Volume to the Evaluation Avg Volume. Negative values identify a decline from Peak Year to Evaluation.
- **Action Impact**—Annualized impact of getting volume back to the Peak Year Avg. This is a [calculated column](/v1/docs/calculated-columns) defined as the difference between the Peak Year Avg Volume and the Evaluation Avg Volume, multiplied by the number of aggregation periods per year. Modify this column as needed to create the desired Action Impact metric.
- **Current**—The Evaluation Avg Volume. Modify this calculated column as needed to capture the best measure of the “Current” state for any [actions](/v1/docs/about-campaigns#actions) created.
- **Target**—The Peak Year Avg Volume. Modify this calculated column as needed to capture the best measure of the “Target” state for any actions created.

To navigate, go to **Sales IQ** > **Engine Config** > **Engine Parameters**.

To navigate, go to **Sales IQ** > **Engine Runner** > **Aggregated Time Periods**.

To navigate, go to **Sales IQ** > **Engine Config** > **Sales IQ Products**.

To navigate, go to **Sales IQ** > **Outputs** > **WB Engine Output**.