SXAスクリプトライブラリ

SXAは最も一般的な作業を自動化するための複数のPowerShellスクリプトを含んでいます。 Sitecore PowerShell拡張(SPE)モジュール はコマンドラインとスクリプト環境を提供し、Sitecore内から使用PowerShellを可能にします。このようにして、Windows PowerShellの構文に従ってコマンドを実行し、スクリプトを書くことができます。SPEを使用するすべてのSXAモジュールには、以下の独自のスクリプトライブラリがあります: sitecore/System/Modules/PowerShell/Script Library/JSS SXA。

!注PowerShellスクリプトは、日常的に行う作業の自動化に使えます。自分でスクリプトを書いたり、既存のスクリプトのコードを閲覧したりするには、PowerShell統合スクリプト環境(ISE)をご利用ください。このツールはSitecore Launchpadからアクセスできます:

SXAスクリプトの種類は、クリーンアップスクリプトからアイテムに挿入オプションを追加するcmdltまで多岐にわたります。

• 足場 – 足場建設中に用いられるスクリプトで、サイトや遺跡コレクションの作成プロセスを自動化します。

• コンテキストメニュー – コンテンツエディターを使用する編集者が利用できるスクリプト。例えば、クリーンアップデータソーススクリプト:

  

• Cmdlets – SPEで使われ、他の開発者でも再利用可能な軽量コマンドです。

• Insert Item – コンテンツエディターのInsertセクションを拡張するスクリプト。

以下の表は利用可能なSXAスクリプトモジュール、その機能、説明、スクリプトの種類を説明します。

モジュール

機能

概要

文字の種類

基本サイト

ホームレンダリングの追加

サイトの基本的なコンテンツ構造を構築します。

足場

マルチサイト

コンテンツフィールドを追加

新しいサイトコレクションテンプレートに追加フィールドを装飾します。ページテンプレートに コンテンツ および タイトル フィールドを追加します。

足場

マルチサイト

ホームアイテムタイトルフィールドを設定しましょう

サイト作成後にホームアイテムのタイトルを設定します。

足場

足場

Add-JSSTenant

新しいヘッドレスサイトコレクションを作成するために使われるすべての機能が含まれています。

コマンドレット

足場

Get-AllJSSSite

すべてのヘッドレスサイトを手に入れます。

コマンドレット

足場

Get-AllJSSTenant

すべてのヘッドレスサイトコレクションを取得します。

コマンドレット

足場

Get-JSSSiteDefinition

ヘッドレスサイトモジュールを手に入れます。

コマンドレット

足場

Get-JSSTenantDefinition

ヘッドレスサイト収集モジュールを手に入れます。

コマンドレット

足場

ヘッドレスサイトモジュールのインストール

ヘッドレスサイトモジュールをインストールします。

コマンドレット

足場

ヘッドレスサイト収集モジュールのインストール

ヘッドレスサイト収集モジュールをインストールします。

コマンドレット

足場

ヘッドレスサイト

コンテキストメニューの挿入オプションにスクリプトを追加し、ユーザーが新しいヘッドレスサイトを作成できるようにします。

項目を挿入

足場

ヘッドレスサイトコレクション

コンテキストメニューの挿入オプションにスクリプトを追加し、ユーザーが新しいヘッドレスサイトコレクションを作成できるようにします。

項目を挿入

足場

ニュー・JSSテナント

新しいヘッドレスサイトコレクションを作成するための関数を含みます。

コマンドレット

足場

New-JSSSite

新しいヘッドレスサイトを作成するために使われる関数が含まれています。

コマンドレット