ストアフロント パイプライン

概要

SXA Storefront で使用されるパイプラインの概要。パイプラインは、機能を実装する一連のプロセッサーを定義し、これらは SXA Storefront に固有です。

パイプラインは、機能を実装する一連のプロセッサーを定義します。言い換えると、パイプラインは、操作を実装する一連のステップです。各ステップに独自の操作があり、プロセッサーが順に実行されるため、ステップの順序が重要になります。カスタム プロセッサーを挿入でき、既存のプロセッサーを簡単に置き換えて、デフォルトの機能と動作を変更できます。

ストアフロントは SXA パイプラインおよびConnect パイプラインとやり取りします。次の表で説明されているものは、SXA Storefront に固有のものです。

パイプライン

説明

commerce.getRecommendedProducts

渡された引数に基づいて、推奨商品の評価に使用されます。パイプラインは、推奨事項をレンダリングするときに 2 つの異なるコンテキストで実行されます。

  • マーケティング オートメーション キャンペーンでメール メッセージを送信するとき

  • ライブ ストアフロント サイトで

デフォルトでは、このパイプラインには 4 つのプロセッサーが含まれます。

  • FromOrder - Email Experience Manager (EXM) キャンペーン クエリ文字列 (言い換えると、キャンペーンのカスタム値) の OrderId を使用して、推奨商品プロバイダーから商品リストを取得します。

  • FromQuery - レンダリング データ ソース アイテムの [商品クエリ] フィールドに行き、検索マネージャーを使用してインデックスに対するクエリを実行し、アイテムのリストを取得します。

  • FromLastOrder - コンタクトの前回の注文 ID を取得して、推奨商品プロバイダーに渡します。

  • FromSearchScope - フォールバック スコープ ID を取得し、スコープに対して定義されたクエリを実行して、推奨する商品を決定します。メール キャンペーンの場合、フォールバックはメール データ ソースのクエリです。

パイプライン引数オブジェクト タイプは、GetRecommendedProductArgs です。使用可能なプロパティは、次のとおりです。

  • IsRecommendedProductsReady

  • MaxNumberOfRecommendedProducts

  • ProductsQuery

  • RecommendedProductsIdList

  • RelationshipFieldName

  • Success

newCxaSiteCreated

コンテンツ エディターで新しいサイトを作成するときに使用されます。デフォルトでは、次の 1 つのプロセッサーを含みます。

  • QueueDomainCreatedEvent - セキュリティ ドメインで作成されたイベントを他のすべてのロールに伝播し、ドメインを作成します。

パイプライン引数オブジェクト タイプは、NewCxaSiteCreatedArgs です。使用可能なプロパティは、次のとおりです。

  • DomainName

  • LocallyManaged

デフォルトでは、次の 1 つのプロセッサーを含みます。

  • QueueDomainCreatedEvent - セキュリティ ドメインで作成されたイベント DomainCreatedEvent を他のすべてのロールに伝播し、使用可能なすべてのロールでセキュリティ ドメインが作成されていることを確認するために使用されます。このイベントをリッスンして、すべてのロールに反応するイベント ハンドラー DomainCreatedEventHandler があります。