In order to be able to implement Matrix Price List, the following needs to be prepared in the partition:
When the business user creates a new Price List definition, the following needs to be specified in the Set Parameters steps:
For the next code demonstration, we will expect the following Company Parameter
Process of Execution
When the user starts the calculation, the Calculation Engine leverages both logics in certain order.
Review the diagram to understand the flow of execution of the two different logics used in the Matrix Price List process.
Matrix Logic
Is a standalone logic, which provides values for the Secondary Key column of the Price List for one particular SKU.
It’s executed by the system each time, when the system adds new SKU into the Price List.
The system places the SKU, for which it needs the list of secondary key values, into the Context, and then it executes the Matrix logic.
So the Matrix logic can simply read the SKU from the Context or use API functions, which use the information implicitly.
The logic element, which returns the list of values, must have DisplayMode set to either “Price Lists” or “Everywhere”.
The element to be used for the Price List, will be set up by the business user while creating the Price List.
To create a new Matrix logic:
-
In IntelliJ, on the Project tool window, right-click on the project name and select :
-
This will generate an updated formulaNature value:
-
Next, we would need to identify the value that will be used for the secondary key of the matrix. For example, if based on the Region and Business Unit there was a volume breakpoint defined in a company parameter table:
def region = input.Region //❶
def businessUnit = api.product("BusinessUnit") //❷
if (region != null && businessUnit != null) {
def volumeBreaks = api.findLookupTableValues("VolumeBreaks", "VolumeBreak",
Filter.equal("Region", region),
Filter.equal("BusinessUnit", businessUnit)
)?.key3
return volumeBreaks //❸
} else {
api.throwException("Region was not specified or product's Business Unit not found.")
} |
❶ Input value was entered by the business user during preparation of the Price List (the value is passed to the Matrix Logic via context).
❷ We can use the value of SKU, because it’s provided in the context.
❸ Return the list of values for the secondary key.
Price List Logic Leveraging the SecondaryKey Value
The use of the api.getSecondaryKey method is the same as using api.currentItem("key2") (just remember, that api.currentItem() works only, when the item already exists) and it retrieves the secondary key field (in this case "key2") of a "matrix record" -
it is a standard Price List line item logic and used to calculate the results based on the combination of the SKU and SecondaryKey.
The value of the SecondaryKey is only available for execution in the Price List / LPG and not when testing the logic in Studio.
So for testing purposes, we will create one additional input (which will only be available in Studio):
if (!api.isDebugMode()) {
return api.getSecondaryKey() // ❶
} else {
if (api.isInputGenerationExecution()) {
api.option( // ❷
"VolumeBreak",
api.findLookupTableValues("VolumeBreaks", "VolumeBreak")?.key3?.unique()
)
} else {
return input.VolumeBreak
}
} |
❶ Reading the value of SecondaryKey column of the line item, only works in "real" execution.
❷ So, during testing phase, we build additional input, so that you can select the value of Volume Break manually.
Additional Setting while Creating a New Matrix Price List
When the business user creates new Matrix Price List, they need to select both the Matrix logic and Matrix Element. Below, we show how at Price List creation time the Price List type of MATRIX is selected:
As we continue to define the PL parameters, we can define the matrix logic and the logic element. In the following example, the setting specific for matrix will be:
Let’s describe here the most important parameter values defined on this panel:
Built-in Input Parameters
-
Dynamic item mode: Add & remove.
The requirement was to have the list of products in sync with the products available in the Product Master.
-
Default pricing logic: PG_MatrixPriceGrid.
This is your line item logic.
-
Matrix logic: PG_MatrixPriceGrid_Matrix.
This is your matrix logic, which will supply the values for secondary keys.
-
Matrix logic element: Volume Breaks
This is the element, which actually returns the list of values.
-
Result Price: List Price
Outputs, which are mapped to the Price List Line Items
After calculation, the final “Matrix” Price List could look like this:
