SXA スクリプト ライブラリ
SXA には、最も一般的なタスクに役立つスクリプトが多数含まれています。
SXA には、最も一般的なタスクを自動化するための PowerShell スクリプトが多数含まれています。Sitecore PowerShell 拡張機能 (SPE) モジュールによってコマンド ラインとスクリプト環境が提供されるため、Sitecore 内から PowerShell を使用できます。このため、Windows PowerShell 構文に従ってコマンドを実行し、スクリプトを作成できます。SPE を使用するすべての SXA モジュールには、sitecore\システム\モジュール\PowerShell\Script Library の場所に独自のスクリプト ライブラリがあります。
これらのスクリプトの命名規則は、SXA - モジュール名です。
![]() |
注記
PowerShell スクリプトを使用すると、定期的に行っている日常タスクを自動化できます。独自のスクリプトを作成したり、既存のスクリプト コードを表示したりするには、PowerShell Integrated Scripting Environment (ISE) を使用します。Sitecore のスタート画面からこのツールにアクセスできます。
![]() |
SXA スクリプトの種類は、クリーンアップ スクリプトから、アイテムに挿入オプションを追加するコマンドレットまでさまざまです。
Scaffolding – サイトやテナントの作成プロセスを自動化するためのスキャフォールディング作業に使用されるスクリプト。
コンテキスト メニュー – コンテンツ エディターを使用するエディターに提供されるスクリプト。たとえば、データソースのクリーンアップ スクリプトは次のようになります。
コマンドレット – SPE で使用され、他の開発者が再利用できる軽量のコマンド。
アイテムの挿入 – コンテンツ エディターの挿入セクションを拡張するスクリプト。
次の表は、利用可能な SXA スクリプト モジュール、その機能、説明、およびスクリプトのタイプを示します。
モジュール | 機能 | 説明 | スクリプトのタイプ |
---|---|---|---|
SXA – Compliancy | AddCookieWarning | パーシャル デザインに Cookie 警告のレンダリングを挿入します。 | Scaffolding |
SXA – Creative Exchange | ResolveCreativeExchangePathTokens | Creative Exchange | Scaffolding |
SXA – Forms | フォーム フォルダーを設定する | サイト定義アイテムに WFFM Forms ルート フォルダーを設定します。これにより、すべてのサイトに独自のフォーム ルート フォルダー含めることができます (デフォルトでは、WFFM ではグローバルなフォーム ルート フォルダーは 1 つしかありません)。 | Scaffolding |
SXA – Geospatial | POI アイテムを割り当てる | POI タイプにデフォルトのレンダリング バリアントを割り当てます。これにより、新しい各サイトは、サイト固有の ID の、同じレンダリング バリアントを持つことができます。 | Scaffolding |
SXA – LocalDatasources | データ フォルダーをクリーンアップする | ページ データ フォルダーで使用されていないデータソースを検索して消去します。 | コンテキスト メニュー |
SXA – Multisite | コンテンツ フィールドを追加する | 新しい テナント テンプレートを追加のフィールドで装飾します。[コンテンツ] および [タイトル] フィールドを ページ テンプレートに追加します。 | Scaffolding |
ホーム ベース テンプレート | テナント テンプレート下のホーム テンプレートにベース テンプレートを追加します。ページ テンプレートをベース テンプレートとして追加します。 | Scaffolding | |
ホーム アイテムのタイトル フィールドを設定する | サイトの作成後にホーム アイテムのタイトルを設定します。 | Scaffolding | |
スタート アイテムを設定する | サイト定義アイテムにスタート アイテムを設定します。デフォルトでは、スタート アイテムはすべてのページのルートであるホーム アイテムです。 | Scaffolding | |
SXA – Search | デフォルトの並べ替えファセットを設定する | データソースを並べ替えるためのデフォルト ファセットとしてタイトル ファセットを割り当てます。 | Scaffolding |
SXA – Site Metadata | AddBrowserTitle | ブラウザー タイトルのレンダリングをメタデータのパーシャル デザインに挿入します。 | Scaffolding |
AddCustomMetadata | CustomMetadata のレンダリングをメタデータのパーシャル デザインに挿入します。 | Scaffolding | |
AddFavicon | Favicon のレンダリングをメタデータのパーシャル デザインに挿入します。 | Scaffolding | |
AddOpenGraphMetadata | OpenGraph のレンダリングをメタデータのパーシャル デザインに挿入します。 | Scaffolding | |
AddSeoMetadata | SeoMetadata のレンダリングをメタデータのパーシャル デザインに挿入します。 | Scaffolding | |
AddStickyNotes | StickyNotes のレンダリングをメタデータのパーシャル デザインに挿入します。 | Scaffolding | |
AddTwitterMetadata | TwitterMetadata のレンダリングをメタデータのパーシャル デザインに挿入します。 | Scaffolding | |
AddViewport | Viewport のレンダリングをメタデータのパーシャル デザインに挿入します。 | Scaffolding | |
SXA – Scaffolding | MultisiteContext/Get-DataItem |
現在のサイトのデータ フォルダーを解決します。 | コマンドレット |
MultisiteContext/Get-SettingsItem |
現在のサイトの設定フォルダーを解決します。 | コマンドレット | |
MultisiteContext/Get-SiteItem |
現在のサイトのサイト アイテムを解決します。 | コマンドレット | |
MultisiteContext/Get-SiteMediaItem |
現在のサイト用に仮想メディア ライブラリを解決します。 | コマンドレット | |
MultisiteContext/Get-TenantItem |
現在のサイト用にテナント アイテムを解決します。 | コマンドレット | |
PresentationContext/Get-PageDesignsItem |
現在のサイト用にページ デザイン フォルダーを解決します。 | コマンドレット | |
PresentationContext/Get-PartialDesignsItem |
現在のサイト用にパーシャル デザイン フォルダーを解決します。 | コマンドレット | |
Add-BaseTemplate | ベース テンプレートを追加するコマンドレット。 | コマンドレット | |
Add-FolderStructure | 指定されたパス構造のフォルダーが存在しない場合にフォルダーを再作成するコマンドレット。 | コマンドレット | |
Add-InsertOptionsToItem |
| コマンドレット | |
Add-InsertOptionsToTemplate |
| コマンドレット | |
Get-PartialDesign | パーシャル デザイン フォルダーの中にある最初のパーシャル デザインを返します。 | コマンドレット | |
Test-ItemIsPartialDesign | アイテムが | コマンドレット | |
Test-ItemIsSiteDefinition | アイテムが | コマンドレット | |
New-Site | 新しいサイトを作成するために使用されるすべての機能が含まれています。 | コマンドレット | |
New-Tenant | 新しいテナントを作成するために使用されるすべての機能が含まれています。 | コマンドレット | |
Site | ユーザーが新しいサイトを作成するための、コンテキスト メニューの [挿入] オプションにスクリプトを追加します。次のルールが満たされたときに表示されます。 Rule 1 where the item template is SiteFolder Rule 2 where the item template is Tenant | アイテムを挿入する | |
Tenant | ユーザーが新しいテナントを作成するための、コンテキスト メニューの [挿入] オプションにスクリプトを追加します。次のルールが満たされたときに表示されます。 Rule 1 where the itemID is equal to Content Rule 2 where the item template is Tenant Folder | アイテムを挿入する |