SXAスクリプトライブラリ
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
SXAは最も一般的な作業を自動化するための複数のPowerShellスクリプトを含んでいます。 Sitecore PowerShell拡張(SPE)モジュール はコマンドラインとスクリプト環境を提供し、Sitecore内から使用PowerShellを可能にします。このようにして、Windows PowerShellの構文に従ってコマンドを実行し、スクリプトを書くことができます。SPEを使用するすべてのSXAモジュールには、以下の独自のスクリプトライブラリがあります: sitecore\System\Modules\PowerShell\Script Library。
これらのスクリプトの命名規則は以下の通りです
- モジュール名:
!注PowerShellスクリプトは、日常的に行う作業の自動化に使えます。自分でスクリプトを書いたり、既存のスクリプトのコードを閲覧したりするには、PowerShell統合スクリプト環境(ISE)をご利用ください。このツールはSitecore Launchpadからアクセスできます:
SXAスクリプトの種類は、クリーンアップスクリプトからアイテムに挿入オプションを追加するcmdltまで多岐にわたります。
-
足場 – 足場建設中に用いられるスクリプトで、サイトや遺跡コレクションの作成プロセスを自動化します。
-
コンテキストメニュー – コンテンツエディターを使用する編集者が利用できるスクリプト。例えば、クリーンアップデータソーススクリプト:

-
Cmdlets – SPEで使われ、他の開発者でも再利用可能な軽量コマンドです。
-
Insert Item – コンテンツエディターのInsertセクションを拡張するスクリプト。
以下の表は利用可能なSXAスクリプトモジュール、その機能、説明、スクリプトの種類を説明します。
- モジュール: 機能
- SXA – コンプライアンス
- SXA – クリエイティブ・エクスチェンジ
- SXA – フォーム
- SXA – 地理空間
- SXA – LocalDatasources: クリーンアップデータフォルダ
- SXA – マルチサイト
- ホームベーステンプレート Collectionテンプレートの下にホームテンプレートにベーステンプレートを追加します。ベーステンプレートとしてページテンプレートを追加します。
- ホームアイテムタイトルフィールドを設定する。
- 開始項目を設定します。デフォルトでは、開始項目はすべてのページのルートとなるホーム項目です。
- SXA – Search: デフォルトのソートファセットを設定する
- SXA – サイトメタデータ
- AddCustomMetadata。
- AddFavicon。
- AddOpenGraphMetadata。
- AddSeoMetadata。
- AddStickyNotes。
- AddTwitterメタデータ。
- AddViewport。
- SXA – スキャフォールディング/Get-DataItem
- 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ラッパー。現在のサイトのPage Designsフォルダを解決します。
- PresentationContext/Get-PartialDesignsItem: IPresentationContext インターフェースのPowerShellラッパー。現在のサイトのPartial Designsフォルダを解決します。
- Add-BaseTemplate。
- Add-FolderStructure。
- Add-InsertOptionsToItem InsertOptions (マスター)を追加するコマンドレットです。
- Add-InsertOptionsToTemplate InsertOptions (Masters) を追加するコマンドレットです。
- Get-PartialDesign Designsフォルダの最初の部分デザインを返します。
- Test-ItemIsPartialDesign PartialDesignTemplateから継承しているかどうかを確認します。
- Test-ItemIsSiteDefinition SiteDefinitionTemplateから継承しているかどうかを確認します。
- 新規サイト。
- 新規テナント。
- サイト、ユーザーが新しいサイトを作成できるようにします。以下のルールを満たすと表示されます:
Rule 1 where the item template is SiteFolder Rule 2 where the item template is Site Collection
- テナント、ユーザーが新しいサイトコレクションを作成できるようにします。以下のルールを満たすと表示されます:
Rule 1 where the itemID is equal to Content Rule 2 where the item template is Site Collection Folder
