FixedHandling

Article
11/12/2009

Use this component to add a fixed handling charge to an order.

The FixedHandling component is supplied for backward compatibility with Site Server 3.0 Commerce Edition only. For more information, see Currency Enhancements.

Intended use: Order Processing pipeline, Handling stage.

Configuration Values

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

Box	Description
Apply when	Determines when to apply the handling charge specified in the Cost box. The values are: Always Default. Specifies that the handling charge is always set to the value of the Cost box. Equal to method Specifies that the handling cost should be applied when the value of the `shipping`_`method` key in the Order dictionary is the same as the string specified for the Method box. Has any value Specifies that the handling cost 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 value in the Apply when box is set to Equal to method.
Cost	This box specifies the handling charge.

Values Read

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

Key	Dictionary	Description
`shipping_method`	Order	This key is read when the value in the Apply when box is set to Equal to method or Has any value.

Values Written

The FixedHandling component writes the following value to the Order dictionary:

Key	Description
`_handling_total`	The handling total for the entire order.

Remarks

The FixedHandling component sets the value of the _handling_total key on the order form to the fixed amount specified in the Cost box.

Programmatic Use

To use the FixedHandling component outside a pipeline, you must configure it by assigning values to keys in the Configuration dictionary. The keys correspond to the indicated fields in the Component Properties dialog box.

The FixedHandlingCy component does not require configuration values when used outside of a pipeline.

For more information about using pipeline components outside of pipelines, see MicroPipe in C++ for components written in C++, or Micropipe in Visual Basic for components written in Visual Basic.