Pipeline Component Reference

This section contains reference material for the following pipeline components that are supplied with Commerce Server.

Pipeline Component Name	Description
AddAttachments	Adds attachments to a direct mail message.
CheckInventory	Checks the inventory status for items in the customer's basket.
ComposeDMLMessage	Creates the body of a direct mail message.
CreateUPMCookie	Collects cookie data to pass to an Active Server Pages (ASP) page creating a personalized direct mail message.
CSFAdvertisingNeedOfDelivery	Makes sure that advertisements are selected often enough to meet business commitments.
CSFEvalTargetGroups	Used to target particular groups for advertising, content selection, and discounts. This component evaluates a list of expressions for each item in a list and adjusts item selection scores.
CSFFilterContent	Applies provided filters to a content list in a Content Selection pipeline (CSP).
CSFFormatTemplate	Merges data from selected items and their associated templates to form formatted strings. These are usually HTML strings ready for display on the page.
CSFHistoryPenalty	Applies penalties to content items based on how recently they have been selected.
CSFIISAppendToLog	Records information about content selection results in the QueryString field of the Internet Information Services (IIS) log file.
CSFInitPipeline	Used at the beginning of a Content Selection pipeline (CSP) to initialize the values needed in the rest of the pipeline.
CSFLoadAdvertisements	Loads advertising data for the Content Selection Framework through the CacheManager object.
CSFLoadDiscounts	Loads discount data for the Content Selection Framework through the CacheManager object.
CSFLoadHistory	Retrieves a history string from a user profile, an item in the ASP session collection, or a cookie.
CSFRecordEvent	Records event delta counts for the selected content items (the winners) in the Performance dictionary.
CSFRecordHistory	Records the identifiers of the winning content items in the history list string.
CSFSaveHistory	Records the history string in one of three locations: the User Profile object, the Active Server Pages (ASP) session collection, or the Hypertext Transfer Protocol (HTTP) cookie.
CSFScoreDiscounts	Adjusts scores of discount items to promote discounts most relevant to the current user.
CSFSelectWinners	Selects items based on their final scores in the Content Selection pipeline.
CSFWriteEvents	Used with the CacheManager object to log Content Selection Framework events.
DefaultHandlingCy	Used as placeholder handling components. They initialize the total handling for the order to zero (0).
DefaultItemPriceCy	Sets the regular price of an item to the list price returned by pipeline components such as QueryCatalogInfo or QueryProdInfoADO.
DefaultOrderSubTotalCy	Calculates the subtotal for the order.
DefaultPayment	Assigns a default value to the payment authorization code. This component is usually replaced by a third-party payment component.
DefaultShippingCy	Placeholder shipping components. They set the shipping cost to zero (0).
DefaultShopperInfo	Moves information from the Shopper dictionary in the Context dictionary of the pipeline to the OrderForm.
DefaultTaxCy	Set the tax fields of the order to zero (0). These components are usually replaced by third-party tax components.
DefaultTotalCy	Calculates the order total from the subtotals.
OrderDiscount (PCR)	Applies discounts to the shopping basket.
OrderLevelDiscountApply	Applies order-level subtotal discounts.
PaymentMethodRouter	Processes payments on an order.
POtoFile	Sends a purchase order or other textual data to a file.
QueryCatalogInfo	Retrieves catalog information for every item in the order form.
RecordPromoCodes	Records the promotion codes that have been applied to the order and adds promotional discounts to the list of discounts for the order form.
RedeemPromoCodes	Validates promotion codes and marks them as redeemed.
RequiredHandlingCy	Verifies that the handling total is present in the order.
RequiredItemAdjustPriceCy	Ensures that the current price for each item in the order is set and that it has not been changed since the last time the basket was viewed.
RequiredItemPriceCy	Verifies that each item in the order form has a regular price assigned to it.
RequiredOrderAdjustPriceCy	Adjusts the total cost of each item in the order after applying any discounts.
RequiredOrderCheck	Verifies that the order form contains at least one item.
RequiredOrderInitCy	Initializes the payment authorization code, order ID, totals, and subtotals in the order form.
RequiredOrderSubtotalCy	Ensures that a subtotal exists on the order form.
RequiredPayment	Verifies that the payment authorization code exists in the order form (is not NULL).
RequiredProdInfo	Deletes items flagged for deletion by a previous Product Info stage component.
RequiredShippingCy	Verifies that the shipping total has been set.
RequiredTaxCy	Verifies that the total tax and tax included appear in the order form.
RequiredTotalCy	Verifies that values on a page have not been tampered with or reset. The components compare values in the order against values in the _Verify_With dictionary.
ReservePromoCodes	Validates and reserves promotion codes.
Scriptor	Executes a script in a Microsoft ActiveX scripting language.
SendPrecomposedMessage	Sends a direct mail message composed in earlier stages in the pipeline.
SendSMTP	Sends an e-mail message to a specified recipient.
ShippingDiscountAdjust	Applies shipping discounts to the order.
ShippingManagerCache	Used with the CacheManager object to load shipping data for the multiple shipments shipping architecture.
ShippingMethodRouter	The ShippingMethodRouter pipeline component looks up and runs the pipeline components that calculate shipping costs for individual shipments, and then calculates the shipping total for the entire order.
Splitter	Divides the order into groups based on a list of item keys. Frequently used to divide the order into multiple shipments.
StepwiseShipping	Calculates shipping costs for shipments in the multiple-shipment shipping architecture. This component is never directly used in a pipeline; it is run by the ShippingMethodRouter pipeline component.
ThrottleDMLPerformance	Controls the speed with which direct mail messages are processed by the pipeline.
UpdateInventory	Checks the inventory status for an array of stock-keeping units (SKUs) and updates the SKU quantities in the Inventory System.
ValidateCCNumber	Checks the expiration date of a credit card and performs a checksum test on the number.
VerifyMessageBody	Checks the body of a direct mail message according to the user flags.
VerifyRecipientData	Checks the data about the recipient of a direct mail message.
XMLTracer	A troubleshooting and debugging tool that outputs the contents of the OrderForm object to a log file during any stage of pipeline execution.

See Also

Other Resources

Commerce Server Core Systems Developer's Reference