Logic Natures and their Binding Variables

The following automatic variables are available in the Groovy logic elements:

Formula Nature

Availability

Allow data update?

Variable

Data Type

Notes

Any


Anywhere

No

api

PublicGroovyAPI


input

Map

Map of input values sent to the logic.

out

Map

Map of values of previously calculated elements.

<element name>.<function name>


Calls a function defined in a different element of the logic.

Deprecated: lib.<element name>.<function name>


Calls a function from a Groovy Library logic named __LIBRARY__.

This call does not allow nesting of library calls.

libs.<library name>.<element name>.<function name>


Calls a function from a Groovy Library logic of a given name.

This call allows nesting of library calls.

rebateAgreementHeader

Rebate record

?

rebateagreement

Map


rebateAgreementEntitlementFilter


No

rebateagreement

calculationBase

Map



contractHeader

Only in ContractBuilder logic

?

cProcessor

ContractBuilder


quoteHeader

Only in Admin > Configuration > QuoteConfigurator > Quote Header Logics

?

quoteProcessor

QuoteBuilder



Only in Admin > Configuration > RebateManager > Rebate Agreement Template Logics

?

ratBuilder

RATBuilder


rebateAgreementHeader

Only in Admin > RebateManager > Rebate Agreement Header Logics

?

raProcessor

RebateAgreementBuilder


rebateAgreement

IRebateRecordManager

?

rebateRecords

IRebateRecordManager


contractTermTypeFilter
contractEntitlementFilter


No

contract

Map


customerInputFilter

productInputFilter

sellerInputFilter

Customer input filter

Product input filter

Seller input filter

No

filterFormulaParam

String

String parameter value that can be passed from the builder, e.g.:

api.inputBuilderFactory() .createProductGroupEntry("...") .setFilterFormulaName("...") .setFilterFormulaParam(param)

customFormHeader


?

customFormProcessor

CustomFormCollectionBuilder


calculationFlow

CalculationFlowActionBuilder

Yes

actionBuilder

CalculationFlowActionBuilder


parameterizedCalculationFlow

CalculationFlowActionBuilder

Yes

actionBuilder

CalculationFlowActionBuilder


triggeredObj

Map<String, Object>

Object that triggered CF

Only used for PriceGrids

triggeredObjTypedId

String

TypedId of the object that triggered CF
Only used for PriceGrids

paDataLoad


Yes




distPACalc


?

dist

DistFormulaContext


model

model_calculation

model_evaluation

Model

?

model

ModelEvaluationFormulaContext

ModelParallelCalculationFormulaInitContext



WorkflowBuilderManager

?

workflow

WorkflowDTO

API for defining approval or watcher steps

submitter

Map


One of

  • calculationgriditem

  • claim

  • compensation

  • compensationrecord

  • contract

  • customform

  • dcr (DataChangeRequest)

  • dealplan

  • model

  • modelrecord

  • pricelist

  • quote

  • pricegridite

  • rebateagreement

  • rebaterecord

Map

Document submitted for an approval

wfStepLogic

Post step

Yes

approvable

Map

Document submitted for an approval

workflowHistory

WorkflowInfo

API for getting the information on approval steps

currentWorkflow

InsertWorkflowStepsDTO

API for adding an additional approval or watcher step