---
title: "サイトおよびテナントの足場にモジュールを追加してください"
slug: "add-modules-to-site-and-tenant-scaffolding"
abstract: "足場型のアイテムを追加してSXAを拡張しましょう。"
---
# サイトおよびテナントの足場にモジュールを追加してください
スキャフォールディングは [、サイトやテナント](https://doc.sitecore.com/xp/ja/developers/sxa/93/sitecore-experience-accelerator/create-a-tenant-and-a-site.html "Create a tenant and a site")にモジュールを追加することを可能にします。SXAモジュールはFeatureまたはFoundationフォルダに保存されます:
- */sitecore/System/Settings/Foundation/Experience Accelerator/*
- */sitecore/System/Settings/Feature/Experience Accelerator/*
新しいモジュールを定義するには、モジュールにSite Setup、Tenant Setup、またはGrid Setupの項目を追加し、Scaffoldingフォルダ(*sitecore/Templates/Foundation/Experience Accelerator/Scaffolding/*)からアクションタイプを追加する必要があります。
## モジュールスキャフォールディングの定義を追加する
モジュールのスキャフォールディングの定義を追加するには:
1. */sitecore/System/Settings/Foundation/*か*/sitecore/System/Settings/Feature/*に移動してフォルダを追加してください。
2. 新しいフォルダを右クリックして、「 **テンプレートから挿入**」をクリックします。
3. テンプレート **から挿入** するダイアログボックスで*sitecore/Templates/Foundation/Experience Accelerator/Scaffolding/Roots*に移動し、追加したいモジュールの種類に応じて「 **グリッド設定」「サイト設定」「テナント設定**」をクリックし、「 **挿入**」をクリックします。
4. **「データ**」セクションでは、設置したいモジュールの種類に応じて、以下の項目を入力してください:
**セットアップ**
**フィールド**
**説明**
サイト設定
名称
サイト作成ウィザードで表示したいサイトモジュールの名前です。
依存関係
モジュールの設置順を指定してください。
デフォルトで含める
サイト作成ウィザードでモジュールを有効にすることをデフォルトで選択してください。
インストールされた場合は含めてください
選択したアクションが現在のテナントに適用されたかどうかによって、モジュールは自動的に含まれます。
Selectedフィールドが空の場合は、このモジュールをインストールするかどうかを新サイト作成ウィザードで決定できます。
はシステムモジュールです
モジュールを自動的にインストールする選択をしてください。この場合、モジュールはダイアログボックスに表示されません。
テナント設定
名称
テナント作成ウィザードで表示したいテナントモジュールの名前です。
デフォルトで含める
テナント作成ウィザードでモジュールをデフォルトで有効にするオプションを選択してください。
はシステムモジュールです
モジュールを自動的にインストールするオプションを選択してください。この場合、モジュールはテナント作成ウィザードに表示されません。
グリッドのセットアップ
名称
サイト作成ウィザードで表示したいグリッドシステムの名前です。
依存関係
モジュールの設置順を指定してください。
グリッドの定義
グリッド定義項目を指します。例えば、Foundationグリッドシステムの場合:設定/機能/Experience Accelerator/Foundation/Foundation
## 足場の動作を追加
モジュールを定義するために様々なアクションタイプを使うことができます。アイテムの追加、テンプレートの編集、PowerShellスクリプトの実行が可能です。利用可能なアクションはActionsフォルダ(sitecore/Templates/Foundation/Experience Accelerator/Scaffolding/Actions)に格納されています。
足場の動作を追加するには:
- 新しいモジュールに移動し、追加したセットアップアイテムを右クリックします。例えば、サイトセットアップアイテムを右クリックして「 **Add Site Item Entry** 」アクションを挿入します。
以下のアクションが利用可能です:
**アクションタイプ**
**フィールド**
**概要**
テナントアイテムの追加
所在地
新しいアイテムをテナントの下に追加します。
テンプレート
新しいテナント項目を作成するためのテンプレート。
名称
アイテムの名前。
フィールド
新しいアイテムの作成後にフィールドを設定するためのフィールド/値マッピング。
テナントテンプレートを編集
テンプレート
テンプレートを選択してテナントテンプレートにコピーします。テンプレートは定義された設定に従って編集されます。
作戦の種類
アクションタイプを選択します。
ベーステンプレートまたは挿入オプションテンプレート
前のフィールドで選択されたアクションの引数として使用するアイテムを選択します。
テナントスクリプトを実行する
文字
実行するPowerShellスクリプトを選択します。スキャフォールディングスクリプトを使ってサイトやテナント作成の一部を自動化できます。例えば:
csharp
function Invoke-ModuleScriptBody {
CmdletBinding()
param(
# Depending on context could be a Tenant or Site item
Parameter(Mandatory=$true, Position=0 )
Item$Root,
Parameter(Mandatory=$true, Position=1 )
Item$TenantTemplates
)
begin {
Write-Verbose "Cmdlet Invoke-ModuleScriptBody - Begin"
}
process {
Write-Verbose "Cmdlet Invoke-ModuleScriptBody - Process"
# Script body
# Put your custom logic here
}
end {
Write-Verbose "Cmdlet Invoke-ModuleScriptBody - End"
}
}
サイト項目を追加
所在地
サイトの下に新しいアイテムを追加します。
テンプレート
新しいサイトアイテムを作成するためのテンプレート。
名称
新しいサイトアイテムの名前。
フィールド
新しいアイテムの作成後にフィールドを設定するためのフィールド/値マッピング。
サイト項目を編集
テンプレート
追加の挿入オプションを追加してサイト項目を編集できます。
作戦の種類
アクションタイプを選択します。
オプション挿入
アイテムの挿入オプションを定義します。
サイトスクリプトを実行する
文字
実行するPowerShellスクリプトを選択します。スキャフォールディングスクリプトを使ってサイトやテナント作成の一部を自動化できます。例えば:
csharp
function Invoke-ModuleScriptBody {
CmdletBinding()
param(
# Depending on context could be a Tenant or Site item
Parameter(Mandatory=$true, Position=0 )
Item$Root,
Parameter(Mandatory=$true, Position=1 )
Item$TenantTemplates
)
begin {
Write-Verbose "Cmdlet Invoke-ModuleScriptBody - Begin"
}
process {
Write-Verbose "Cmdlet Invoke-ModuleScriptBody - Process"
# Script body
# Put your custom logic here
}
end {
Write-Verbose "Cmdlet Invoke-ModuleScriptBody - End"
}
}
編集テーマ
基本テーマ
編集テーマインスタンスに追加する基本テーマのリスト。
サイトテーマを編集
基本テーマ
編集テーマインスタンスに追加する基本テーマのリスト。
セットアップ後のステップ
文字
実行するPowerShellスクリプトを選択します。サイト作成後は、スキャフォールディングスクリプトを使ってアクションを実行できます。
csharp
function Invoke-Step {
CmdletBinding()
param(
Parameter(Mandatory = $true, Position = 0 )
Sitecore.XA.Foundation.Scaffolding.Models.CreateNewSiteModel$Model
)
begin {
Write-Verbose "Cmdlet Invoke-Validation - Begin"
}
process {
Write-Verbose "Cmdlet Invoke-Validation - Process"
}
end {
Write-Verbose "Cmdlet Invoke-Validation - End"
}
}
入力検証ステップ
文字
実行するPowerShellスクリプトを選択します。サイト作成前にスキャフォールディングスクリプトを使ってモデルを検証できます。検証スクリプトのいずれかで返される結果がfalseであれば、新設サイトのダイアログボックスが再度表示され、以前選択された値の一部を修正できます。
csharp
function Invoke-Validation {
CmdletBinding()
param(
Parameter(Mandatory = $true, Position = 0 )
Sitecore.XA.Foundation.Scaffolding.Models.CreateNewSiteModel$Model
)
begin {
Write-Verbose "Cmdlet Invoke-Validation - Begin"
}
process {
Write-Verbose "Cmdlet Invoke-Validation - Process"
# Return $true or $false as a result of validation
$true
}
end {
Write-Verbose "Cmdlet Invoke-Validation - End"
}
セットアップ後のステップ
文字
実行するPowerShellスクリプトを選択します。テナントが作成されたら、スキャフォールディングスクリプトを使ってアクションを実行できます。
csharp
function Invoke-Step {
CmdletBinding()
param(
Parameter(Mandatory = $true, Position = 0 )
Sitecore.XA.Foundation.Scaffolding.Models.CreateNewTenantModel$Model
)
begin {
Write-Verbose "Cmdlet Invoke-Validation - Begin"
}
process {
Write-Verbose "Cmdlet Invoke-Validation - Process"
}
end {
Write-Verbose "Cmdlet Invoke-Validation - End"
}
}
入力検証ステップ
文字
実行するPowerShellスクリプトを選択します。テナント作成前にスキャフォールディングスクリプトを使ってモデルを検証できます。検証スクリプトで返された結果が偽の場合、新設テナントダイアログボックスが再度表示され、以前に選択された値を修正できます。
csharp
function Invoke-Validation {
CmdletBinding()
param(
Parameter(Mandatory = $true, Position = 0 )
Sitecore.XA.Foundation.Scaffolding.Models.CreateNewTenantModel$Model
)
begin {
Write-Verbose "Cmdlet Invoke-Validation - Begin"
}
process {
Write-Verbose "Cmdlet Invoke-Validation - Process"
# Return $true or $false as a result of validation
$true
}
end {
Write-Verbose "Cmdlet Invoke-Validation - End"
}
}
プリ・デートステップ
文字
実行するPowerShellスクリプトを選択します。スキャフォールディングスクリプトを使って、サイトやテナントの削除プロセスの一部を自動化できます。このアクションはRemove-TenantやRemove-Siteコマンドレットが呼び出されたときに実行されます。カスタムモジュールで作成されたアイテムのクリーンアップにも使えます。なぜなら、デフォルト削除プロセスでは削除されていない(例えば、アイテムが異なるフォルダにある場合など)です。
csharp
function Invoke-Step {
CmdletBinding()
param(
Parameter(Mandatory = $true, Position = 0 )
Item$Root
)
begin {
Write-Verbose "Cmdlet Invoke-Validation - Begin"
}
process {
Write-Verbose "Cmdlet Invoke-Validation - Process"
}
end {
Write-Verbose "Cmdlet Invoke-Validation - End"
}
}
削除後ステップ
文字
実行するPowerShellスクリプトを選択します。スキャフォールディングスクリプトを使って、サイトやテナントの削除プロセスの一部を自動化できます。このアクションは、誰かが Remove-Tenant またはコマンドレットを呼び出したときに実行 Remove-Site します。これにより、標準的な削除時に削除されないカスタムモジュールで作成されたアイテムをクリーンアップできます(例えば、テナント/サイトルートアイテム、テナント/サイトメディアライブラリ、テナントテンプレートなど、よく知られたフォルダの外にアイテムを保存した場合など)
csharp
function Invoke-Step {
CmdletBinding()
param(
Parameter(Mandatory = $true, Position = 0 )
Item$Root
)
begin {
Write-Verbose "Cmdlet Invoke-PostDeleteStep - Begin"
}
process {
Write-Verbose "Cmdlet Invoke-PostDeleteStep - Process"
}
end {
Write-Verbose "Cmdlet Invoke-PostDeleteStep - End"
}
}
Pre Delete検証ステップ
実行するPowerShellスクリプトを選択します。スキャフォールディングスクリプトを使って、サイトやテナントの削除プロセスの一部を自動化できます。
テナントやサイトを削除する前に、スキャフォールディングスクリプトを使って状態を検証できます。検証スクリプトのいずれかで返された結果が誤りの場合、削除操作はキャンセルされます。
csharp
function Invoke-Validation {
CmdletBinding()
param(
Parameter(Mandatory = $true, Position = 0 )
Item$Root
)
begin {
Write-Verbose "Cmdlet Invoke-Validation - Begin"
}
process {
Write-Verbose "Cmdlet Invoke-Validation - Process"
# Return $true or $false as a result of validation
$true
}
end {
Write-Verbose "Cmdlet Invoke-Validation - End"
}
}