pipelines Element

  • Article

For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.

The pipelines element configures the all application pipelines. Each pipeline is configured with its own pipeline element. This element supports several attributes that determine the type of pipeline object that is to run the pipeline. Examples of pipeline types are "OrderPipeline", "PooledPipeline", and "PooledTxPipeline". The pipelines element is required.

Note

If you enable pipeline logging in the Web.config file, you must also manually create a directory named "pipelines\log" to ensure that the runtime successfully runs and logs pipeline executions.

The pipelines element contains the pipeline subelement.

pipeline Element

The pipeline element specifies a pipeline. Each instance of the pipeline element element corresponds to an instance in the PipelineCollection object stored in the application. The pipeline element is required.

The following table lists and describes the attributes of the pipeline element.

Attribute

Data Type

Description

name

String

The name of the pipeline, which is used to access the pipeline in the application.

This attribute is required.

type

String

The role of the pipeline in the application. Valid values of this attribute are "CSFPipeline" and "OrderPipeline".

The default value is "OrderPipeline".

This attribute is optional.

transacted

String

Determines whether or not a transacted pipeline object is used for running the pipeline.

The value of this attribute must represent a Boolean.

This attribute is optional for order pipelines, but for CSF pipelines the value cannot be set to true.

path

String

The path to the .pcf file that defines the pipeline.

The path should be specified in relation to the application — for example, ".\pipelines\basket.pcf".

This attribute is required.

loggingEnabled

String

Determines whether pipeline logging is enabled.

If the value of this attribute is true, a pipeline log is created in the relative path "pipelines\log". If false, logging will not be performed.

The log file name includes the ID of the user making the corresponding request to run the pipeline. The extension "pipelog" is used for the log file name. If the user cannot be identified, the log file name includes the pipeline being run — for example "basket.pcf.pipelog".

The value of this attribute must represent a Boolean. The default value is false.

This attribute is required.

Example

<pipelines>
   <pipeline
      name="basket"
      path="pipelines\basket.pcf"
      transacted="false"
      type="OrderPipeline"
      loggingEnabled="false" />
  <pipeline
     name="checkout"
     path="pipelines\checkout.pcf"
     transacted="true"
     type="OrderPipeline"
     loggingEnabled="false" />
</pipelines>