pfx-api:calculate
Calculate (recalculate) values for Datamart derived columns, Calculated Field Sets (CFS), Price Lists (PL), and Price Grids (PG).
URI Format
pfx-api:calculate?param1=value1¶m2=value2
Parameters
|
Parameter |
Type |
Default |
Description |
|---|---|---|---|
|
objectType |
ObjectType (enum) |
-- |
The Pricefx object type. Supported: DM, CFS, PL, PG |
|
typedId |
String |
-- |
|
|
targetName |
String |
-- |
Target name for the calculation |
|
incrementalDate |
String |
-- |
Incremental date for the calculation |
|
label |
String |
-- |
Label for the target object. Used with CFS calculations |
|
fullListRecalculate |
Boolean |
false |
Whether to recalculate the entire Price List |
|
recalcTainted |
Boolean |
false |
Whether to only recalculate changed (tainted) items |
XML Route Examples
Calculate a CFS by label
<route>
<from uri="direct:calculateCFS"/>
<to uri="pfx-api:calculate?objectType=CFS&label=MyCFS"/>
</route>
Calculate Datamart derived columns
<route>
<from uri="direct:calculateDM"/>
<to uri="pfx-api:calculate?objectType=DM&typedId=5.DM&targetName=MyTarget"/>
</route>
Recalculate an entire Price List
<route>
<from uri="direct:recalcPL"/>
<to uri="pfx-api:calculate?objectType=PL&typedId=42.PL&fullListRecalculate=true"/>
</route>
Recalculate only tainted Price Grid items
<route>
<from uri="direct:recalcTaintedPG"/>
<to uri="pfx-api:calculate?objectType=PG&typedId=10.PG&recalcTainted=true"/>
</route>
Common Pitfalls
-
Missing objectType: The objectType parameter is required. Supported values are DM, CFS, PL, and PG. Other object types will fail.
-
CFS requires label: When calculating a Calculated Field Set, use the
labelparameter instead oftypedId. -
fullListRecalculate vs recalcTainted: These are mutually exclusive strategies. Setting
fullListRecalculate=truerecalculates every item regardless of state, whilerecalcTainted=trueonly recalculates items that have been modified. Do not set both to true. -
incrementalDate format: The date must be provided as a string in a format recognized by Pricefx (e.g.
2026-01-01). -
typedId format: Must include the numeric ID and object type suffix separated by a dot, e.g.
5.DMor123.PL.