LinearHandling

Use this component to set the handling total on an order by multiplying a field on the order form by a fixed rate.

Note

• The LinearHandling component is for backward compatibility only and does not support the new, extended Currency datatype.

Intended use: Order Processing pipeline, Handling stage.

Configuration Values

You can determine how the LinearHandling component applies the handling rate and the rate itself by setting component properties. Use the following boxes on the Linear Handling tab of the Component Properties dialog box to determine this information.

Box	Description
Apply when	Determines when to apply the handling charge. The values are: Always Default. The handling charge is always applied to the order. Equal to method Specifies that the handling cost should be applied when the value of shipping_method key in the Order dictionary is the same as the string specified as the value for the Method box. Has any value Specifies that the handling charge is applied when the shipping_method key of the order has any non-null value.
Method	The shipping method to match against the value of the shipping_method key in the Order dictionary. Used when the value in the Apply when box is set to Equal to method.
Basis Item Key	The property of the item to use in computing the handling charge. Defaults to the sum.quantity key.
Rate	The handling rate, which is an integer value.

Values Read

The LinearHandling component reads the following value from the indicated dictionary.

Key	Dictionary	Description
item.sum_quantity	Order	Dynamic. Default shown. The property of the item to use in computing the handling charge. The key name is determined by the value in the BasisItemKey configuration box.

Values Written

The LinearHandling component writes the following value to the Order dictionary.

Key	Description
_handling_total	The handling total for the entire order.

Remarks

The LinearHandling component computes the handling charge by multiplying the value specified in the Rate box by the sum of the property specified for the Basis Item Key box. For example, you might base the linear handling charge on the quantity of the items, and the value in the Basis Item Key box might be sum.quantity key. If the order contains two items, one item with a quantity of four and the other item with a quantity of two, then the basis sum is six. The component calculates the handling charge by multiplying the value in the Rate box by six.

For more general information about basis item keys, see Specifying the Basis Item Key.

See Also

Specifying the Basis Item Key

All rights reserved.