pfx-api:calculate

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&param2=value2

Parameters

Parameter

Type

Default

Description

objectType

ObjectType (enum)

--

The Pricefx object type. Supported: DM, CFS, PL, PG

typedId

String

--

The typedId of the entity to calculate (e.g. 5.DM, 123.PL)

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

XML
<route>
    <from uri="direct:calculateCFS"/>
    <to uri="pfx-api:calculate?objectType=CFS&amp;label=MyCFS"/>
</route>

Calculate Datamart derived columns

XML
<route>
    <from uri="direct:calculateDM"/>
    <to uri="pfx-api:calculate?objectType=DM&amp;typedId=5.DM&amp;targetName=MyTarget"/>
</route>

Recalculate an entire Price List

XML
<route>
    <from uri="direct:recalcPL"/>
    <to uri="pfx-api:calculate?objectType=PL&amp;typedId=42.PL&amp;fullListRecalculate=true"/>
</route>

Recalculate only tainted Price Grid items

XML
<route>
    <from uri="direct:recalcTaintedPG"/>
    <to uri="pfx-api:calculate?objectType=PG&amp;typedId=10.PG&amp;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 label parameter instead of typedId.

  • fullListRecalculate vs recalcTainted: These are mutually exclusive strategies. Setting fullListRecalculate=true recalculates every item regardless of state, while recalcTainted=true only 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.DM or 123.PL.