Initiates a pipeline thread.
Class Name |
|
|---|---|
Component |
|
Required Input Parameters
pipelineManager
Refers to the Pipeline Manager that facilitates the processor chain. If you provide no value for this parameter, the ATG platform uses the default Pipeline Manager provided in the PipelineChainInvocationdefaultPipelineManager property.
Optional Input Parameters
chainId
Refers to the pipeline chain to execute. If you provide no value, the ATG platform uses the default chain supplied by the defaultChainId property of the PipelineChainInvocation servlet bean.
paramObject
An object that is passed as an argument in the runProcess method. Leaving this parameter blank invokes the default object, which is a HashMap that is constructed using the extraParametersMap property. The extraParametersMap represents a mapping of new HashMap’s keys to the request parameters that are bound to the new HashMap’s values.
Open Parameters
exception
The exception objects thrown during pipeline execution. You might want to render this parameter in conjunction with the successWithErrors or failure parameters.
failure
Rendered when serious errors are encountered during pipeline execution.
pipelineResult
Refers to the object that acts as an error log by saving any errors encountered by processors in the chain.
success
Rendered when a pipeline executes without any errors.
successWithErrors
Rendered when a pipeline thread executes to completion, but acquires errors in the pipelineResult object during the process.
Usage Notes
PipelineChainInvocation initiates a pipeline thread from a JSP. This servlet bean sends request arguments to a Pipeline Manager; when the pipeline process is complete, it receives a pipelineResult object that that contains a list of error messages.
For more information on Pipelines, see ProcessorChainsandthePipelineManager in the ATG Commerce Programming Guide.
