TableShippingADO

TableShippingADO

The TableShippingADO component, which appears in the Shipping stage of an order processing pipeline, sets the value of _shipping_total on the order form by using values retrieved from the database.

Key. (Read-only) The name of a property on the order form used to specify shipping method. The value of this property is compared to the string specified in the Method field to determine whether to apply the shipping charge to the order.
Apply when. Specifies when to apply the shipping charge.
- Equal to Method. Specifies that the shipping charge should be applied if the value of the field specified for Key is the same as the string specified in the Method field.
- Has Any Value. Specifies that the shipping charge should be applied when the value of the field specified for Key has any value on the order form. If you select this option, the Method field should be left blank.
- Always. Specifies that the shipping charge is always applied to the order.
Method. If Equal to Method is selected, specifies a string that the component compares with the value of shipping_method on the order form to determine whether to apply the shipping charge to the order. The shipping charge will be applied only if there is an exact match.
Connection string. Specifies the connection string used for connecting to the database. The connection string must include either the full connection string (the data source name (DSN), database login ID, and database password) or the name of a named connection stored in the connection map. If this field is blank, the default connection string is used.
Query. Specifies either the full SQL text of the query that is executed by this component or the name of a query whose full SQL text is defined in the site's global.asa file.
Parameter List. A space-delimited list of parameters for the query identified in the Query setting.
Column. Specifies the name of the column in the database that contains the shipping charge.

Remarks

The combination of the Key, Apply when, and Method fields determine whether the shipping charge should be applied to the order.

The TableShippingADO component first checks the Apply when value. If it is set to Always, the shipping charge is always applied to the order. If Apply when is set to Has any value, the shipping charge is applied to the order whenever the order form contains any value for shipping_method. If Apply when is set to Equal to Method, the component does a comparison between the value of shipping_method on the order form and the text string in the Method field on this property page. If there is a match, the shipping charge is applied.

If the component determines that the shipping charge should be applied, it then executes the query specified in Query, which retrieves the shipping charge from the database column specified in Column. The component then computes the shipping charge.

The Parameter List is used to specify parameters to the query, which usually include a basis for the table lookup. The basis can be total cost of the order, or a merchant-defined value such as weight.

For parameters, you can use any of the following values.

Basis Item Key prefix	Description
`order.fieldname`	The value of the specified field, where fieldname is a property on the order form.
`sum.fieldname`	The sum of value of the specified field for each item, where fieldname is a property in the item list.
`sumq.fieldname`	The sum of value of the specified field for each item, where fieldname is a property in the item list, times the quantity of that item.
`count`	The number of line items in the order form. (Does not depend on quantity of each item.)

The following table illustrates some useful values for Basis Item Key:

Example Basis Item Key	Result
`order._oadjust_subtotal`	Subtotal on the order form.
`sum.quantity`	Sum of all quantities (total number of items ordered).
`sum._oadjust_adjustedprice`	Sum of adjusted prices.
`sumq._iadjust_currentprice`	Sum of current price times quantity for all items in the order.
`sumq._product_weight`	Total weight of order. (Assumes that the `weight` column exists in the product table, and that the query used by QueryProdInfoADO includes this field.)

For example, if sumq._product_weight is specified, and if the order has two items, one item weighing 2 pounds with a quantity of 3 and the other item weighing 4 pounds with a quantity of 1, then the basis value is 10 pounds.

TableShippingADO

Remarks

Related Topics