Page Comparison

...

Written by: Jachym Krasek, Jiri Skorvanek

...

This article summarizes possible solutions for different use cases of passing on values within Quote’s different calculation logics. Some of the use cases can be found here on confluence in articles, comments or in teams chat. We tried to implement all the use cases for our internal PoC’s and we encountered several obstacles while doing so.

We tried to describe possible solutions, some obstacles or wrong ways how to do it. Please feel free to comment the solutions, add wider explanations, or if you know better way how to do some of the use cases or feel strong about some use case that we should not try to implement it at all, please share the knowledge in comments.

...

.

Calculation Logic Architecture Prerequisities

How different logics are executed from the Quote perspective:

...

Syntax Check

This dry run is used to discover inputs in the line itemitems. Most of other api API calls are mocked. Be aware that syntax check dry run is executed only once in case of adding a new line item.

Other

...

Logics Executable from

...

Quote

There are two other logics , which can be executed from header logics:

• Configurator Logic

  • This logic is executed after clicking on the Open Button of Configuratora configurator:

    

    After clicking on save button of Pop up Configurator, new Configurator the Save button in the configurator pop-up, a new configurator value is saved to the Quote object. (The quote object is what you get by calling quoteProcessor.getQuoteView()). But you cannot work with the values until the Quote is recalculated. Why? All This is because the logic knows only the old quote Quote object since all other calculation logics finished before Configurator the configurator logic was executed. You must press recalculate click the Recalculate button or set automatic recalculation , please read the article (for details see how to recalculate a quote automatically).

• Template Logic

  • This logic is executed after clicking to download the Download PDF button.

  • from From the template logic the whole quote object is accessible through api.getCurrentItem().

Summary of

...

Passing Values between Different Types of Logics

Use

...

Case 1: Quote Header Logic Configurator → Quote Header Logic

Step 1: Create the Configurator button in the header logic.

if (quoteProcessor.isPrePhase()) {
    quoteProcessor.addOrUpdateInput(
            "ROOT",
            [
                    "name" : "Configurator",
                    "label": "Configurator",
                    "url"  : "ConfiguratorLogic",
                    "type" : "CONFIGURATOR"
            ]
    )
}

Step 2: Define a generic logic (name it e.g. “ConfiguratorLogic”ConfiguratorLogic). It contains an input matrix in our casethis example.

def ce = api.createConfiguratorEntry()
def p = ce.createParameter(InputType.INPUTMATRIX, "QuoteFeatures")

def cols = ["Name", "Description"]
def types = ["Text", "Text"]

p.addParameterConfigEntry("columns", cols)
p.addParameterConfigEntry("columnType", types)

return ce

Step 3: In the header logic, access all the values from the configurator using the following code snippet:

if(quoteProcessor.isPrePhase()) {
    def quote = quoteProcessor.getQuoteView()
    def quoteFeatures = quote?.inputs?.find { it.name == "Configurator" }?.value
}

Where Configurator is a name of the configurator element (created in step Step 1). What you will get is a the following HashMap:

{QuoteFeatures=[{Name=firstLineName, firstLineDescr, selected=false}]

Use

...

Case 2: Quote Header Logic → Quote Header Logic Configurator

Step 1: Create a header input field.

Suppose I we have the following header logic stringUserEntry field which I we want to pass to the configurator:

if (quoteProcessor.isPrePhase()) {
    quoteProcessor.addOrUpdateInput("ROOT",
            [
                    "name"    : "ValueToBePassed",
                    "label"   : "ValueToBePassed",
                    "type"    : "STRINGUSERENTRY",
                    "required": false
            ]
    )
}

Step 2: Passing Pass the header value to the configurator.

The problem is that Configurator and Header Logic the configurator and header logic do not share a global space. So I we cannot simply use api.global. Instead of using global I that we need to pass this value to configurator “value” the configurator "value" property.

if (quoteProcessor.isPrePhase()) {

    def passedValue = quoteProcessor.getQuoteView().inputs?.find { it.name == "ValueToBePassed" }?.value
    quoteProcessor.addOrUpdateInput(
            "ROOT",
            [
                    "name" : "Configurator",
                    "label": "Configurator",
                    "url"  : "ConfiguratorLogic",
                    "type" : "CONFIGURATOR",
                    "value": passedValue
            ]
    )
}

Step 3: Merging Merge values.

Problem with the solution from step Step 2 is that the logic always overrides the configurator value after recalculation. Configurator The configurator value field is used for storing the configurator object. It looks like this (QuoteFeature is inputMatrix object):

{QuoteFeatures=[{Name=firstLineName, firstLineDescr, selected=false}]

Therefore I we need to read configurator values first and then create a value map where I we put backed up configurator’s values together with values I we need to pass to the configurator. My The goal is this:

{QuoteFeatures=[{Name=firstLineName, firstLineDescr, selected=false}], PassedValue=asdfasfd}

...

if (quoteProcessor.isPrePhase()) {
    def quote = quoteProcessor.getQuoteView()

    def passedValue = quote.inputs?.find { it.name == "ValueToBePassed" }?.value
    def configuratorValueBackup = quote.inputs?.find { it.name == "Configurator" }?.value ?: [:]
    configuratorValueBackup.put("PassedValue", passedValue)

    quoteProcessor.addOrUpdateInput(
            "ROOT",
            [
                    "name" : "Configurator",
                    "label": "Configurator",
                    "url"  : "ConfiguratorLogic",
                    "type" : "CONFIGURATOR",
                    "value": configuratorValueBackup
            ]
    )
}

Step 4: How to read Read the passed value in the configurator logic.

Now This is the final step: . To be able to read a value inside the configuration logic which has been passed from the header logic I we need to use HIDDEN input. The code bellow has better description capabilitiesillustrates this:

def confEntryPassedValue = api.createConfiguratorEntry(InputType.HIDDEN, "PassedValue")
def passedValue = confEntryPassedValue.getFirstInput()?.getValue()

The QuoteFeatures object is automatically mapped to the input matrix, so the passed values are displayed in the input matrix and I we can use PassedValue for whenever any purpose I need (fe.eg. conditional field showingdisplay).

Use

...

Case 3: Quote Header Logic

...

→ Line Item

...

Logic

Solution for this use case is easy: api.global.

In header Header logic:

api.retainGlobal = true   
api.global.variableTest = "value from header2"

Quote Line Logicline logic:

def value = api.global.variableTest

api.logInfo("LineItemLogic value:" + value);

...

Instead of api.retainGlobal = true you can set set flag “apithe option api.retainGlobal defaults to TRUE” in configuration of partition (Admin->Configuration->General Settings) TRUE in Administration > Configuration > General Settings to true.

...

Use

...

Case 4: Quote Line Item Logic → Quote Header Logic

This can be useful e.g. if you want to, for example, calculate a summary on the header level or display a summary chart on Custom Quote Headerin the custom Quote header.

This is very easy, as it is involves just reading the quote structure. This needs to be done in the Quote Post Phase post-phase (= after line item calculation).

In the header logic, you can read the values from line items this way:

if(quoteProcessor.isPostPhase()){
  def lineItems = quoteProcessor.getQuoteView().lineItems  
  lineItems.each{ lineItem ->
    
    def sku= lineItem.sku
    def outputItems = lineItem.outputs
    def value = outputItems.find{ it.resultName == "LineItemValue"}?.result
    api.trace("result", "sku: " +sku + " value: "+ value);    
  }  
}

Use

...

Case 5: Quote Header Logic → Publishing (Preprocessing) Logic

If you are using use publishing templates for quotes, you have to pass data to the preprocessing (publishing) logic. Simply call api.currentItem from the preprocessing logic to get a full quote view.

def quote = api.currentItem().

Note: data Data will be available in the preprocessing logic only after the quote was saved, not before.

Use

...

Case 6: Quote Header Configurator

...

→ Line Item Logic

From the configurator logic you don’t do not have a direct access to the quote object. This means you have to pass values from the header logic to the line item logic.

To accomplish do this behavior , you need to combine the following use cases: Use case 1: Quote Header Logic Configurator → Quote Header Logic. and then Use case 3: Quote Header Logic -> Line Item logic.

Without priceEntityAfterSave set up to true the recalculate Recalculate button has to be pressed clicked after saving values in Configuratorthe configurator.

Use

...

Case 7: Line Item Logic

...

→ Quote Header Configurator Logic

To read values from a line item logic, we can use a logic from Use case 4: Quote Line Item Logic → Quote Header Logic.

Then at PostPhase the post-phase in the header logic we pass those values through the “value” property inside in the configurator. Refer to Use case 2: Quote Header Logic → Quote Header Logic Configurator.

Thanks to postPhase the post-phase we can pass those these values within one recalculation transaction.

This how would look like final Final code:

if (quoteProcessor.isPostPhase()) {
    def quote = quoteProcessor.getQuoteView()

    def lineItems = quote?.lineItems
    def sum = 0
    lineItems.each { lineItem ->
        def outputItems = lineItem.outputs
        def value = outputItems.find { it.resultName == "LineItemValue" }?.result
        sum = sum + value
    }

    def passedSumValue = sum
    def mergedValue = quote.inputs?.find { it.name == "Configurator" }?.value ?: [:]
    mergedValue.put("PassedValue", passedSumValue)

    quoteProcessor.addOrUpdateInput(
            "ROOT",
            [
                    "name" : "Configurator",
                    "label": "Configurator",
                    "url"  : "ConfiguratorLogic",
                    "type" : "CONFIGURATOR",
                    "value": mergedValue
            ]
    )
}

Now when you click on the configurator button, you will have values from line items available in that the configurator.

Use

...

Case 8: Quote Header Logic Configurator → Line Item Logic Configurator

This may can be useful if you want to, for example to , set generic parameters in the quote header configurator and then have a pre-filled configurator on each line item, to edit the values for each line item separately.

It is possible to pass data from Quote Header Logic Configurator to Line Logicthe quote header logic configurator to the line item logic, but it is not possible to pass data from Quote Header Logic Configurator to Configurator defined in Line Item Logic.Why? Let’s the quote header logic configurator to the configurator defined in the line item logic.

To explain this, let’s see the example of how you pass the passing values from Line Item Logic to Line Item Configuratorthe line item logic to the line item configurator.

api.configurator("Configurator A","ConfiguratorFormula")
def confA = api.getParameter("Configurator A")
if(confA != null && confA.getValue() == null) {
     confA.setValue(["ConfiguratorType":"A"])
}

This works fine as you use static (hard-coded) values. Data are not loaded dynamically. If you want to load data dynamically from the quote header configurator, code this is like this the code in the line item logic (non-working demo!).:

//NOTE: this is NON WORKING code - it is here just forto exlanationexplain whatwhy this approach itdoes not workingwork

def conf = api.configurator("test", "ConfiguratorLogic"); //line item configurator
def headerValues = api.input("valueFromHeaderConfigurator") //loadingload values from hidden input created in header logic
valueToSet = headerValues?.QuoteFeatures?.Name?.getAt(0) //get one of the values 

def confA = api.getParameter("test") //gettingget reference for line item configurator
def valueToSet = ["QuoteFeatures":["Name":valueToSet, "selected":"false"]] //data structure for input matrix to set

confA?.setValue(valueToSet) //settingset value to configurator

But this is does not not working, work because:

1. Line

...

1. item configurator “test” is created during syntax check.

2. During syntax check, api.input returns only mock data, not real data.

3. During syntax check (and only during syntax check), api.getParameter(

...

1. "test") returns a context parameter of the

...

1. "test" configurator. During recalculation (when syntax check is not running), api.getParameter(

...

1. "test") returns null.

2. ConfA?.setValue in syntax check:

   1. has a context parameter of the configurator;

   2. does not have a value loaded from api.input.

3. ConfA?.

...

1. setValue when quote is recalculated:

   1. does not have a context parameter of the configurator;

   2. has a value loaded from api.input, but it cannot be set

...

1. 1. as confA is null.

As a result:

• you are able to set You can set a static value via confA.setValue() as a value are which is known at syntax check.

• you are not able to You cannot set dynamically loaded data from the header configurator because in the syntax check api.input does not return the expected value and during recalculation, api.getParameters(“test”"test") does not return the context parameter of the configurator.

In this case, quote recalculation will not help , as during recalculation, there is no syntax check. So let’s talk about see a workaround.

Workaround

...

: Create Line Item Configurator on Quote Header

Create a configurator for line items from the header logic and pass it to the line items via the addOrUpdate function.

Example:

Configurator on the header level, defined in the header logic. From this configurator, we load data to our line item configurator.

...

if(quoteProcessor.isPostPhase()) {  
	for (lineItemMap in quoteProcessor.getQuoteView().lineItems) {
		if (lineItemMap.folder) continue  //skip folders
  
      	def quote = quoteProcessor.getQuoteView()
      
      	def configuratorValues = quote.inputs?.find { it.name == "Configurator" }?.value ?: [:]	
      	def valuesToSet = configuratorValues;
  
		quoteProcessor.addOrUpdateInput(lineItemMap.lineId,
                        ["name"    : "LinteItemConfigurator",
                         "label"   : "LinteItemConfigurator",
                         "type"    : InputType.CONFIGURATOR,
                         "url"     : "ConfiguratorLogic",
                         "readOnly": false,
                         "value"   : valuesToSet]
                )
		}
}

In this case, the line item configurator will always have the same values as the quote header configurator. Any change in the line item configurator will be overwritten on quote recalculation. If you want to keep changes done on the item level, you have to merge it them with the header value , before you set them via addOrUpdateInput.

Use

...

Case 9: Quote Line Item Configurator → Quote Header Configurator

The principles are same as in Use case Case 7: Line Item Logic -> Quote Header Configurator Logic.

Only The only change here is when you are iterating iterate over lineItems line items you need to look inside the configurator value field and collect the needed values.

This needs to be done in the quote header logic.

    def quote = quoteProcessor.getQuoteView()
    def lineItems = quote?.lineItems
    
    lineItems.each { lineItem ->
        def inputItems = lineItem.inputs
        def value = inputItems.find { it.name == "ConfiguratorName" }?.value
        sum = sum + value?.configuratorFieldValue? : 0
    }

Use

...

Case 10: Line Item Logic → Line Item Logic Configurator

It is possible to add default values to the line item configurator from the line item logic using the following code:

api.configurator("Configurator A","ConfiguratorFormula")
def confA = api.getParameter("Configurator A")
if(confA != null && confA.getValue() == null) {
     confA.setValue(["ConfiguratorType":"A"])
}

So when you need pass values only onceas an initialization step, it can be done using the code above. If you would like to pass different values each time on recalculate, you must change the approach.

Problem The problem here is the function api.getParameter("Configurator A"). It returns Configurator the configurator object only in case that when the configurator was not open opened before and has no value in the value property. Same is with f.e. stringuserentry, while The same applies to e.g. stringUserEntry: while it is empty you can get the userEntry object by calling api.getParameter. After you fill it in, no object is returned to you.

Workaround / Solution

To dynamically fill in configurators in the line item calculation logic, you have to update it using the header logic. Basically follow the instructions in Use case Case 4: Quote Line Item Logic → Quote Header Logic and update configurator values while iterating.

Possible

...

Design Troubles

“Add new line item”

...

Architecture Awareness

Some of the use cases above are implemented with the header logic updating line items.

Example:

Header logic configurator has three string inputs. I You need to see those these input values at the line item level to work with them. I You can do this in the quote header prephase pre-phase logic. I You will iterate over lineItems and passing them some HIDDEN fields.

So far so good.

What happen happens when I you add a new item? Only the item logic syntax check and item logic is executed. When the quote header prephase pre-phase did the iteration over all items, this new line was not there yet.

Conclusion:

It means that I you will get those these passed values on a new line item only after clicking on the Recalculate button. This could be UX issue.