SXA スクリプトライブラリ

Current version: 10.1

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

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 `FileStorage`プロバイダー定義アイテムのパストークンを解決し、データフォルダーに一意のパスを作成できるようにします。これにより、さまざまなサイトによってフォルダーのコンテンツが上書きされるのを防げます。	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	`IMultiSiteContext` インターフェイス用の PowerShell ラッパー。現在のサイトのデータフォルダーを解決します。	コマンドレット
	MultisiteContext/Get-SettingsItem	`IMultiSiteContext` インターフェイス用の PowerShell ラッパー。現在のサイトの設定フォルダーを解決します。	コマンドレット
	MultisiteContext/Get-SiteItem	`IMultiSiteContext` インターフェイス用の PowerShell ラッパー。現在のサイトのサイトアイテムを解決します。	コマンドレット
	MultisiteContext/Get-SiteMediaItem	`IMultiSiteContext` インターフェイス用の PowerShell ラッパー。現在のサイト用に仮想メディアライブラリを解決します。	コマンドレット
	MultisiteContext/Get-TenantItem	`IMultiSiteContext` インターフェイス用の PowerShell ラッパー。現在のサイト用にテナントアイテムを解決します。	コマンドレット
	PresentationContext/Get-PageDesignsItem	`IPresentationContext` インターフェイス用の PowerShell ラッパー。現在のサイト用にページデザインフォルダーを解決します。	コマンドレット
	PresentationContext/Get-PartialDesignsItem	`IPresentationContext` インターフェイス用の PowerShell ラッパー。現在のサイト用にパーシャルデザインフォルダーを解決します。	コマンドレット
	Add-BaseTemplate	ベーステンプレートを追加するコマンドレット。	コマンドレット
	Add-FolderStructure	指定されたパス構造のフォルダーが存在しない場合にフォルダーを再作成するコマンドレット。	コマンドレット
	Add-InsertOptionsToItem	`InsertOptions` (マスター) をアイテムに追加するコマンドレット。	コマンドレット
	Add-InsertOptionsToTemplate	`InsertOptions (Masters)` にテンプレートアイテムを追加するコマンドレット。	コマンドレット
	Get-PartialDesign	パーシャルデザインフォルダーの中にある最初のパーシャルデザインを返します。	コマンドレット
	Test-ItemIsPartialDesign	アイテムが `PartialDesignTemplate` を継承するかどうかを確認します。	コマンドレット
	Test-ItemIsSiteDefinition	アイテムが `SiteDefinitionTemplate` を継承するかどうかを確認します。	コマンドレット
	New-Site	新しいサイトを作成するために使用されるすべての機能が含まれています。	コマンドレット
	New-Tenant	新しいテナントを作成するために使用されるすべての機能が含まれています。	コマンドレット
	Site	ユーザーが新しいサイトを作成するための、コンテキストメニューの [挿入] オプションにスクリプトを追加します。次のルールが満たされたときに表示されます。 RequestResponse `Rule 1 where the item template is SiteFolder Rule 2 where the item template is Tenant`	アイテムを挿入する
	Tenant	ユーザーが新しいテナントを作成するための、コンテキストメニューの [挿入] オプションにスクリプトを追加します。次のルールが満たされたときに表示されます。 RequestResponse `Rule 1 where the itemID is equal to Content Rule 2 where the item template is Tenant Folder`	アイテムを挿入する

何かフィードバックはありますか?

この記事を改善するための提案がある場合は、

SXA スクリプト ライブラリ

SXA スクリプトライブラリ