Difference Between Param, ParamItem, Tparam, and TparamItem

Aspect Param / ValParam ParamItem TParam TParamItem
Scope Formula level Item level within a formula. Formula level Item level within a formula.
Value Type Returned Concentration or percentage. Concentration or percentage. Actual mass-based net contribution. Actual mass-based net contribution.
Based On Parameters unit of measure (e.g., MG/100GM or WT%) Parameter's unit of measure (e.g., MG/100GM or WT%) Concentration/percentage × formula total mass Concentration/percentage × formula total mass
Return Data Type String String String String
Respects Manual Overrides? Yes. Returns overridden or equation-assigned value. Yes. Returns the items own attribute value No. Always calculates from rollup logic, ignoring overrides. No. Always calculates from item-level contribution and formula mass.
Requires Item Identifier? No Yes. Item code or line ID. No Yes. Item code or line ID.
Example Input Param("CALCIUM") ParamItem("CALCIUM", "Item1") TParam("CALCIUM") TParamItem("CALCIUM", "Item1")
Unit of Measure Parameters own UOM (e.g., MG/100GM) Parameters own UOM (e.g., MG/100GM) Absolute unit (e.g., MG) — no UOM returned, use ObjProperty Absolute unit (e.g., MG) — based on formula mass UOM.
Supports Quantity Types? No No Yes. TotalMass, TotalVol, TotalMassIngred, etc. No
Use in Alt UOM Equations? No. Use ObjProperty. No. Use ObjProperty. No. Use ObjProperty. No. Use ObjProperty.
Best For Getting the current rolled-up or overridden formula parameter value. Getting a specific ingredients concentration within a formula. Getting the actual total mass of a parameter in the formula Getting the actual mass contribution of one specific ingredient
Typical Use Case Nutrition label rolled-up value, formula-level compliance check Comparing ingredient-level concentrations. Calculating sodium per serving, total mass checks. Breaking down which ingredient contributes most by actual mass.
Equation Total Parameters? Use ValParam to avoid incorrect modified-state values. N/A N/A N/A
Function Syntax What It Returns Example Result Calculation When To Use
Param
Param("SODIUM")
Formulas total concentration. "30" Direct rollup value. Need formula-level concentration.
ParamItem
ParamItem("SODIUM", "ITEM1")
Item 1's concentration. "10" Item 1's contribution. Need specific items concentration.
ParamItem
ParamItem("SODIUM", "ITEM2")
Item 2's concentration. "20" Item 2's contribution. Need specific items concentration.
Tparam
Tparam("SODIUM")
Formulas actual amount. "900" MG 30 MG/100GM × 3000GM / 100 = 900 MG Need total actual amount in formula.
TparamItem
TparamItem("SODIUM", "ITEM1")
Item 1's actual amount. "150" MG 10 MG/100GM × 1500GM / 100 = 150 MG Need actual amount from specific item.
TparamItem
TparamItem("SODIUM", "ITEM2")
Item 2's actual amount. "750" MG 20 MG/100GM × 1500GM / 100 = 750 MG Need actual amount from specific item.