OrderPipeline.OrderExecute Method

OrderPipeline.OrderExecute Method

The OrderExecute method runs the specified set of stages in the pipeline, applying their actions to the specified order form. Before invoking OrderExecute, you must load the pipeline configuration using the LoadPipe method.

OrderExecute returns a Long result containing one of the following values:

The number 1 indicates the pipeline executed successfully.
The number 2 indicates errors raised by pipeline components in the basket or purchase error collections. These are typically customer errors, such as a mis-typed credit card number. An error message is displayed to the customers so that they can submit the information again.
The number 3 indicates failure of the pipeline, such as the inability to access the database. This type of error cannot be corrected by the customer.

Syntax

OrderPipeline.OrderExecute(Mode, OrderForm, PipeContext, Reserved)

Parameters

Mode

Specifies the mode in which to execute the stages in the pipeline. This parameter may be set to one of the following:

1    Runs the product verification stages.
2    Runs all stages except payment and accept.
4    Runs the complete pipeline.

The values for Mode may be defined as constants in Global.asa:

Application("OPPMODE_PRODUCT")  = 1
Application("OPPMODE_PLAN")     = 2
Application("OPPMODE_PURCHASE") = 4

Note The Mode parameter is included only for backward compatibility with sites created in Commerce Server 2.0, and will be discontinued in future releases. In Commerce Server 3.0 and later, the selection of pipeline stages is made by loading an appropriate pipeline configuration file with the LoadPipe method. Commerce Server 3.0 applications should use the value one (1) for this parameter; zero (0) will cause no stages to run.

OrderForm

An initialized OrderForm.

PipeContext

A PipeContext object. The PipeContext object is a Dictionary object that references a group of initialized objects containing information needed by the pipeline.

Reserved

This value is not used and must be set to zero (0).

Remarks

The OrderExecute method should be used instead of the RunProduct, RunPlan, and RunPurchase methods on the Page object, as used in Commerce Server 2.0.