CSValueKind
Synopsis
Restriction: string
enum CSValueKind {
Other,
ItemQuantity,
SalesUnitSize,
SalesUnitGrossWeight,
SalesUnitNetWeight,
SalesUnitVolume,
InactiveItemFlag,
SetArticleIdentifier,
CondRecordAmount,
Incoming,
Reference,
Outgoing,
CondBase,
ScaleBase,
CondAmount,
DefaultQtyRel,
QuantityRelation,
CondBaseQtyRelRatio,
CondValue,
SubtotalValue,
SetArticleQty,
GroupCondBase,
AltGroupCondBase,
GroupScaleBase,
GroupAmount,
CondBaseRatio,
GroupValue,
GroupValueResidue,
AggrIncoming,
AggrReference,
AggrOutgoing,
AggrCondBase,
AggrCondValue,
AggrSubtotalValue,
AggrSetArticleQtys
}
Values of this type are used in CSValidationError to identify the value whose computation triggered the error, and in CSInvalidValueError to identify the origin of the offending value.
Other
Placeholder for other internally used value kinds that should not appear in validation errors reported for price calculation sheets
ItemQuantity to SetArticleIdentifier
Values fetched from article items
CondRecordAmount
The amount of a condition record
Incoming
The incoming value of an item calculation line, i.e. the outgoing value of the parent line
Reference
The reference value of an item calculation line according to the reference level or reference range
Outgoing
The outgoing value of an item calculation line; equal to the incoming value in case of subtotal and text lines, and equal to the sum of incoming value and condition value in case of condition lines
CondBase
The condition base used by item conditions with calculation rule Quantity, GrossWeight, NetWeight, or Volume; computed as the product of the article’s quantity and either the sales unit size, sales unit gross/net weight, or sales unit volume; used by item conditions to compute the condition value as the product of condition amount and the quotient of condition base and quantity relation ( CV = CA * (CB / QR) ); accumulated by condition groups to compute the base value of the group
ScaleBase
Like CondBase, but used during computation of GroupScaleBase for item-specific intermediate results
CondAmount
The condition amount
DefaultQtyRel
The default quantity relation of an article item; equal to the article’s sales unit size, sales unit gross/net weight, or sales unit volume; used if the condition has no condition record and no manually specified quantity relation
QuantityRelation
The quantity relation used by item conditions with calculation rule Quantity, GrossWeight, NetWeight, or Volume
CondBaseQtyRelRatio
The quotient of condition base and quantity relation
CondValue
The value of item conditions
SubtotalValue
The value of item subtotals
SetArticleQty
The quantity reported by set-article calculations
GroupCondBase
Base value of condition group, the sum of base values of all active conditions in the group
AltGroupCondBase
Alternative base value of condition groups used for inactive conditions (conditions overridden by a subsequent price or conditions of inactive item calculations (alternative positions)) with calculation rule FixedAmount; temporarily computed as the sum of group condition base and condition base value; used instead of group condition base as to compute condition base ratio (see below)
GroupScaleBase
The scale base of a condition group; Depending on the scale base type, this is either the accumulated item condition base (scale base type Value) or the accumulated item scale base (scale base types Quantity, GrossWeight, NetWeight, or Volume).
GroupAmount
Amount of a condition group; usually obtained from condition record, but may be manually overridden
GroupValue
The value of a condition group; computed from group amount and group base value
CondBaseRatio
The condition base ratio, i.e. the quotient of item condition base and group condition base; used to compute the initial (before rounding difference compensation) item condition value as the product of group value and condition base ratio
GroupValueResidue
The difference of group value and accumulated initial item condition values; may be distributed in some way among item condition values if rounding difference compensation is enabled
AggrIncoming
The incoming value of an aggregate calculation line, i.e. the outgoing value of the parent line
AggrReference
The reference value of an aggregate calculation line according to the reference level or reference range; may be used by aggregate subtotals in calculation of the value reported as the subtotal’s amount
AggrOutgoing
The outgoing value of an aggregate calculation line; equal to the incoming value in case of subtotal and text lines, and equal to the sum of incoming value and condition value in case of condition lines
AggrCondBase
The aggregated condition base, i.e. the sum of item condition bases; used by group and set-article calculations to determine whether the value of the aggregate condition is editable (for the value to be editable, the aggregated condition base must have a finite non-zero value as it is used as divisor when the new aggregate condition value is distributed among item conditions)
AggrCondValue
The value of aggregate conditions
AggrSubtotalValue
The value of aggregate subtotals
AggrSetArticleQtys
Mapping from item calculation ID to set-article quantity for items that are part of a set-article; used by conditions of group and set-article calculations to determine whether their condition value is editable