Technical User Reference (Optimization - Price Waterfall)

Owned by Jana Volencová (Deactivated)
Jan 24, 2024
13 min read

This section details the Model Class and the logics that the Price Waterfall Optimization Accelerator deploys. For each step, its aim, its outputs, and the main reasons to modify the logics are explained. If there is a need to modify the logics, refer to the process in Optimization Price Waterfall Accelerator Customization and to documentation in Problem Modeling (Optimization Engine), Problem Description, and Problem Tables (Optimization Engine).

In this section:

Price_Waterfall ModelClass

Optimization Price Waterfall Model Class organizes a list of logics to create the model architecture. It is transformed into an optimized UI in the Pricefx platform. The general architecture is:

There are two types of logics: calculation, which writes tables in the model, and evaluation, whose purpose is only to display some results. The standard Model Class definition is documented in Model Class (MC).

All the logics of the Optimization Price Waterfall Accelerator follow a standard naming convention: first PW_ prefix, then the number of the step and the first letters of its name, then Calc or Eval, depending on the formula nature, then the name of the tab. In the end, there are two library logics named PW_Library and PW_InternalLibrary.

Libraries

The logics are PW_Library and PW_InternalLibrary.

PW_Library is used in nearly all the other logics deployed by the Accelerator and defines a set of generic OE-related functions to facilitate the model’s tables reading and writing and to deal with parameter definition in the UI. It is accessed via the calls on libs.PW_Library.XXX in the code. It is preferable to keep this code unmodified to facilitate the maintenance and readability of the project.

PW_InternalLibrary contains some functions needed specifically for this Accelerator, such as reading its configuration from the application settings, applying the user filters in each part of the model, preprocessing the data for the charts, and many small helpers for the charts rendering.

If a specific function is needed for the project, it should be added in PW_InternalLibrary. It will be accessed then via libs.PW_InternalLibrary.XXX in the code.

Definition Step

There is no calculation logic run in this step. The tab is Mapping and its related logic is PW_1_Def_Eval_Mapping_Configurator.

Mapping Tab

The logic is PW_1_Def_Eval_Mapping_Configurator.

When users deploy the accelerator, they define the Data Source and the mapping of the entries. But in some cases, they could want to change the source or the mapping for some models. This tab displays the Datamart source and the mapping deployed by the accelerator and allows the user to change it. It is also the place where the model for elasticity is defined.

It declares the mapping of fields to be used in the model.

If the optimization model needs fewer or more fields than the ones which are preset by the accelerator, then it is the place to update the mapping.

You can also remove the Elasticity user input if no elasticity is used in the optimization.

Scope Step

The calculation logic is PW_2_Sco_Calc_Aggregating and there is one tab called Scope.

Calculation: Aggregating

The logic is PW_2_Sco_Calc_Aggregating.

Scope Tab

The logic are PW_2_Sco_Eval_Scope and PW_2_Sco_Eval_Scope_Configurator. An evaluation logic that takes the user inputs and displays also a dashboard needs a corresponding configurator, called in the first element.

Configuration Step

Calculation: Filtering

The logic is PW_3_Conf_Calc_FilterScope.

Boundaries, Business Alignments, and Objectives Tabs

The logics are PW_3_Conf_Eval_Boundaries_Configurator, PW_3_Conf_Eval_BusinessAlignments_Configurator, and PW_3_Conf_Eval_Objectives_Configurator.

Advanced Parameters Tab

The logic is PW_3_Conf_Eval_AdvancedParameters_Configurator.

Results Step

Calculation: RunOptimization and PrepareResults

The logics are PW_4_Res_Calc_RunOptimization and PW_4_Res_Calc_PrepareResults and they are run in this order.

RunOptimization Calculation

PrepareResults Calculation

Impact Tab

The logic is PW_4_Res_Eval_Impact.

Details Tab

The logic is PW_4_Res_Eval_Details.

Glassbox and Influencers Tabs

The logics are PW_4_Res_Eval_Glassbox and PW_4_Res_Eval_Influencers.

Evaluation Tab

The logic is PW_4_Res_Eval_Query.