ClassName

atg.service.pipeline.servlet.PipelineChainInvocation

Component

/atg/dynamo/droplet/PipelineChainInvocation

The PipelineChainInvocation bean lets you initiate a pipeline thread from a page. This bean sends request arguments to a Pipeline Manager and, when the pipeline process is complete, this bean 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.

Input Parameters

pipelineManager
This parameter 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.

chainId
This parameter refers to the pipeline chain to be executed. If you provide no value, the ATG platform uses the default chain supplied by the defaultChainId property of the PipelineChainInvocation servlet bean.

paramObject
This parameter allows you specify 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
Specifies the exception objects thrown during pipeline execution. You might want to render this parameter in conjunction with the successWithErrors or failure parameters.

failure
This parameter is rendered when serious errors are encountered during pipeline execution.

pipelineResult
This parameter refers to the object that acts as an error log by saving any errors encountered by processors in the chain.

success
This parameter is rendered when a pipeline executes without any errors.

successWithErrors
This parameter is rendered when a pipeline thread executes to completion, but acquires errors in the pipelineResult object during the process.

 
loading table of contents...