1. Pipelines and providers

Customize the site creation pipeline

Version:

The Run New Site Pipeline pipeline is part of the Storefront Components Site Setup component  (/sitecore/System/Settings/Feature/Commerce Experience Accelerator/Storefront Components/Storefront Components Site Setup).

The Run New Site Pipeline component in the Storefront Components Site Setup folder.

By default, the Run New Site Pipeline pipeline contains the newCxaSiteCreated pipeline, which contains a single processor (QueueDomainCreatedEvent). This processor, which is executed when a new site is created, synchronizes and persists the site domain across all Sitecore instances as summarized in the following table:

PipelineProcessorDescription
newCxaSiteCreatedQueueDomainCreatedEventQueues a domain-created remote event that will be handled by the DomainCreatedEventHandler processor to create the new domain of the new site in the Content Delivery (CD) and other Content Management (CM) instances.

You can extend and customize the newCxaSiteCreated pipeline by adding custom processors to it or by replacing the default one.

To extend and customize the pipeline:

  1. On the server, navigate to the \src\Commerce.XA\Framework\Foundation\Common\src\App_Config\Include\Foundation\Commerce folder.

  2. Open the Sitecore.Commerce.XA.Foundation.Common.config file and, in the following section, customize or extend the pipeline as required.

    <newCxaSiteCreated>
        <processor type="Sitecore.Commerce.XA.Foundation.Common.Pipelines.NewCxaSiteCreated.QueueDomainCreatedEvent, Sitecore.Commerce.XA.Foundation.Common"/>
</newCxaSiteCreated>

All processors defined under the newCxaSiteCreated pipeline are executed when a commerce site is created.

Important

The processors are initiated in order. The QueueDomainCreatedEvent processor does not need to be the first processor listed.

If you have suggestions for improving this article, let us know!