Commerce テナントとサイトのスキャフォールディング

概要

Commerce スキャフォールディング プランの概要。

スキャフォールディングとは、SXA が事前定義されたモジュールを使用してテナントとサイトを作成する方法を指します。スキャフォールディングは、デフォルトのページと構造を使用して、テナントとサイトを簡単に作成する方法です。SXA Storefront は、独自の機能を追加する 4 つのスキャフォールディング プランを使用して、SXA モジュールを拡張します。

スキャフォールディング プランは、サイトのスキャフォールディング中にサイト アイテムの作成を管理する SXA Storefront 機能です。スキャフォールディング プランを含むスキャフォールディング モジュールをインストールすると、スクリプトはプランの一部として定義されたすべてのアイテムを新しいサイトの下の正しい場所にデプロイします。ブランチ テンプレートに似ていますが、ブランチ テンプレートとは異なり、定義アイテム (またはソース アイテム) は、1 つのブランチ テンプレートの下または同じ親の下になくても構いません。さらに、プラン アイテムには、サイト内の他のアイテムへの相対リンクを含めることができます。これらのリンク (パスまたは ID) は、サイトの作成およびスキャフォールディング プランのデプロイ中に置き換えられ、新しく作成されたサイトの下の正しいアイテムに解決されます。

次の表に、デフォルトの SXA Storefront 固有のプランの詳細を示します。

プラン名

場所

説明

Commerce Foundation スキャフォールディング プラン

/sitecore/System/Settings/Foundation/Commerce Experience Accelerator/Commerce Foundation/Commerce Foundation Scaffolding Plan

これはテナント レベルのプランです。テナントに属するスナップショット アイテムが含まれています。Commerce 機能をテナントに追加するには、このプランを選択する必要があります。

Habitat カタログ スキャフォールディング プラン

/sitecore/System/Settings/Feature/Commerce Experience Accelerator/Habitat Catalog/Habitat Catalog Scaffolding Plan

これはサイト レベルの計画であり、Habitat カタログをサイトのデフォルト カタログとして設定するために使用されます。このプランはオプションです。

Storefront コンポーネント スキャフォールディング プラン

/sitecore/System/Settings/Feature/Commerce Experience Accelerator/Storefront Components/Storefront Components Scaffolding Plan

これはサイト レベルのプランです。これには、サイトのスナップショット アイテムが含まれており、データ ソースやレンダリング バリアントなどの Storefront コンポーネントを構築します。Commerce 機能をサイトに追加するには、このプランを選択する必要があります。

Storefront テンプレート スキャフォールディング プラン

/sitecore/System/Settings/Project/Commerce Experience Accelerator/Storefront Template Scaffolding Plan

これはサイト レベルのプランであり、Storefront テンプレートのスナップショット アイテムと設定が含まれています。このプランはオプションです。

スキャフォールディング プランは、次のアイテムで構成されています。

  • 定義アイテム

  • スナップショット アイテム

  • ソース アイテム

  • デプロイ スクリプト

  • デプロイ スキャフォールディング アクション

テナントとサイトを作成するときに、スキャフォールディング プランをカスタマイズして、たとえば、新しいページを追加したり、新しいスクリプトを自動的に実行したりできます。

プランの定義アイテムは、/sitecore/Templates/Foundation/Commerce Experience Accelerator/Scaffolding/Scaffolding Plan template に基づいていて、/sitecore/System/Settings/<Foundation または Feature または Project>/<モジュール>/<スキャフォールディング モジュール名> の下に配置する必要があります。

スナップショット アイテムは、/sitecore/System/Settings/Foundation/Commerce Experience Accelerator/Scaffolding/Snapshot Items/<スキャフォールディング プラン名>/<ブランチ テンプレートの下のソース アイテムの場所> の下で作成された自動生成アイテムです。スナップショット アイテムには、ソース アイテムのメタ データと、サイトの下に配置する必要がある場所の詳細情報が含まれています。また、トークン化された相対リンクであるフィールド値も含まれています。スキャフォールディング モジュールのアクションとしてスキャフォールディング プランをデプロイする場合、プラン内のすべてのアイテムが個別に処理されます。これは、ソース アイテムがサイトの下の正しい場所にコピーされ、関連するフィールドとトークンが正しい値で解決されることを意味します。

スナップショット アイテムには、フィールドのデフォルト値が含まれています。これらのフィールド値は、スキャフォールディングを実行すると解決されます。スナップショット アイテムは、ブランチ テンプレートと同じ階層でグループ化されます。スナップショット アイテムには、JSON シリアル化オブジェクトの形式で、使用可能なすべての言語のすべてのフィールド値が含まれています。これは [スナップショット データ] フィールドで確認できます。たとえば、カタログ ナビゲーション ページの [コンテンツ] タブ (/sitecore/System/Settings/Foundation/Commerce Experience Accelerator/Scaffolding/Snapshot Items/Commerce Foundation Scaffolding Plan/Foundation/Commerce Experience Accelerator/Commerce Foundation/Tenant Templates/Catalog Navigation Page) に、次のように表示されます。

カタログ ナビゲーション ページのスナップショット データ。

ソース アイテムは、スキャフォールディング中に作成されるアイテムの構造を定義するブランチ テンプレートのアイテムです。ソース アイテムは、スキャフォールディング中に新しいサイトにデプロイされる主要なアイテム定義です。

デプロイ スクリプトは Sitecore Powershell Extension (SPE) スクリプトであり、実行されると、スキャフォールディング プランに属するアイテムを処理し、新しく作成されたサイトの下の正しい場所にデプロイします。また、スナップショット アイテムに基づいてトークン化されたフィールド値を解決します。

デプロイ スキャフォールディング アクションは、プラン デプロイ スクリプトを参照するスキャフォールディング モジュールの下の ExecuteScript ステップです。