Service method pipelines

Version: 10.3

Each service method launches a pipeline with the same name. As part of the initial pipeline being executed, one or more additional or shared pipelines can be called and executed. For example, SaveCart or SynchronizeProductArtifacts.

In Sitecore, the default pipeline arguments contain Request and Result properties, which have Properties of type dictionary, and can contain arbitrary data to be used by pipeline processors.

Commerce Connect uses the Request.Properties dictionary to store data that you need to synchronize. There are processors that read and write the custom data.

Values that are stored in Request.Properties  are internal temporary data used to carry information between the processors in the pipeline. For example, the CreateOrResumePipeline includes the FindCartInEAState processor that stores the ID of the cart. This ID is then used in the RunLoadCart processor to specify the ID of the cart to be loaded.

Data read and stored in the Request.Properties dictionary is visible between processors within the pipeline.

The following table contains a description of the cart data related to the pipelines stored in the pipeline arguments Request.Properties:

Pipeline

Property name

Data description

CreateOrResumeCart

CartId

Holds the ID of the cart found in the writer processor and consumed by the reader processor in order to load the cart from the external system.

Writer processor:

FindCartInEaState

Reader processor:

RunLoadCart

ResumeCart

CartSourceStateId

Holds the ID of the cart state that the MoveVisitorToInitialState processor moves visitors from.

Writer processor:

CheckCanBeResumed

Reader processor:

MoveVisitorToInitialState

CartDestinationStateId

Holds the ID of the cart state that the MoveVisitorToInitialState processor moves visitors to.

Writer processor:

CheckCanBeResumed

Reader processor:

MoveVisitorToInitialState

The following table contains the data of the product related pipelines:

Pipeline

Property name

Custom data description

GetSitecoreProductList

SitecoreProductIds

Holds a list of the product IDs of Sitecore.

Writer processor

GetSitecoreProductList

Reader processor

EvaluateProductListUnionToSynchronize

SynchronizeClassifications

SitecoreClassificationGroups

Holds the classification groups in Sitecore to be synchronized.

Writer processor:

ReadSitecoreClassifications

Reader processor

ResolveClassificationsChanges

ClassificationGroups

Holds the classification groups in the external commerce system to be synchronized.

Writer processor:

ReadExternalCommerceSystemClassifications

Reader processors:

  • ResolveClassificationsChanges

  • SaveProductClassificationsToSitecore

SynchronizeClassificationsSpecifications

ProductClassificationGroups

Holds the product classification groups to be synchronized.

Writer processor:

ReadExternalCommerceSystemClassificationsSpecifications

Reader processor:

SaveClassificationsSpecificationsToSitecore

SynchronizeDivisions

SitecoreDivisions

Holds product divisions in Sitecore to be synchronized.

Writer processor:

ReadSitecoreDivisions

Reader Processor:

ResolveDivisionsChanges

Divisions

Holds the product divisions in the external commerce system to be synchronized.

Writer processors:

ResolveManufacturersChanges

ReadExternalCommerceSystemManufacturers

Reader processor:

ResolveDivisionsChanges

SynchronizeManufacturers

SitecoreManufacturers

Holds the Sitecore manufacturer to be synchronized.

Writer processor:

ReadSitecoreManufacturers

Reader processor:

ResolveManufacturersChanges

Manufacturers

Holds a list of the manufacturers in the external commerce system to be synchronized.

Writer processor:

ReadExternalCommerceSystemManufacturers

Reader processors:

  • ResolveManufacturersChanges

  • SaveManufacturersToSitecore

SynchronizeProductEntity

ProductFromSitecore

Holds the products in Sitecore to be synchronized with the external commerce system.

Writer processor:

ReadProductFromSitecore

Reader processor:

ResolveProductChanges

Product

Holds a product from the external commerce system with Sitecore.

Writer processor:

  • ReadExternalCommerceSystemProduct

  • ResolveProductChanges

Reader processor:

ResolveProductChanges

SynchronizeTypes

SitecoreProductTypes

Holds the product types in Sitecore to be synchronized with the external commerce systems.

Writer processor:

ReadSitecoreTypes

Reader processor:

ResolveTypesChanges

ProductTypes

Holds the product types in the external commerce systems to be synchronized with Sitecore.

Writer processor:

ReadExternalCommerceSystemTypes

Reader processors:

  • ResolveTypesChanges

  • SaveTypesToSitecore

SynchronizeGlobalSpecifications

Specifications

Holds the product specifications to be synchronized.

Writer processor:

ReadExternalCommerceSystemGlobalSpecifications

Reader processor:

SaveGlobalSpecificationsToSitecore

SynchronizeProductDivisions

DivisionIds

Holds the division IDs to be synchronized.

Write processor:

ReadExternalCommerceSystemProductDivisions

Reader processor:

SaveProductDivisionsToSitecore

SynchronizeProductManufacturers

ManufacturerIds

Holds the manufacturer IDs to be synchronized.

Writer processor:

ReadExternalCommerceSystemProductManufacturers

Reader processor:

SaveProductManufacturersToSitecore

SynchronizeProductResources

ProductResources

Holds the product resources to be synchronized.

Writer processor:

ReadExternalCommerceSystemProductResourceBase

Reader processor:

SaveProductResourcesToSitecore

SynchronizeProducts

ExternalCommerceSystemProductIds

Holds the product IDs in the external commerce systems to be synchronized.

Writer processor:

GetExternalCommerceSystemProductList (pipeline: GetExternalCommerceSystemProductList)

Reader processor:

EvaluateProductListUnionToSynchronize

SynchronizeProductTypes

ProductTypeIds

Holds the product type IDs to be synchronized.

Writer processor:

ReadExternalCommerceSystemProductTypes

Reader processor:

SaveProductTypesToSitecore

SynchronizeResources

Resources

Holds the product resources to be synchronized.

Writer processor:

ReadExternalCommerceSystemResources

Reader processor:

SaveResourcesToSitecore

SynchronizeProductRelations

RelatedProducts

Holds the related products to be synchronized.

Writer processor:

ReadExternalCommerceSystemProductRelationsBase

Reader processor:

SaveProductRelationsToSitecore

SynchronizeTypeSpecifications

SpecificationCollection

Holds the specification collection to be synchronized.

Writer processor:

ReadSitecoreTypeSpecifications

Reader processor:

SaveTypeSpecificationsToExternalCommerceSystem

Do you have some feedback for us?

If you have suggestions for improving this article,