SXAスクリプトライブラリ

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 – コンビリアンシー

AddCookieWarning

クッキー警告レンダリングを部分的なデザインに挿入します。

足場

SXA – クリエイティブ・エクスチェンジ

ResolveCreativeExchangePathTokens

Creative Exchange FileStorage プロバイダー定義項目内のパストークンを解決し、Dataフォルダ内で一意なパスを可能にします。これにより、異なるサイトがフォルダ内容を上書きするのを防ぎます。

足場

SXA – フォーム

Set Forms folder

WFFM Formsのルートフォルダをサイト定義項目に設定します。これにより、すべてのサイトが独自のフォームルートフォルダを持つことが可能になります(デフォルトではWFFMではグローバルなFormsルートフォルダは1つだけです)。

足場

SXA – 地理空間

POI項目を割り当てる

POIタイプに対してデフォルトのレンダリングバリアントを割り当てます。これにより、各新しいサイトがサイト固有のIDを持つ同じレンダリングバリアントを持つことができます。

足場

SXA – LocalDatasources

クリーンアップデータフォルダー

Page Dataフォルダ内の未使用データソースを検索し、クリーンアップします。

コンテキストメニュー

SXA – マルチサイト

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

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

足場

ホームベーステンプレート

Tenantテンプレートの下にHome templateにベーステンプレートを追加します。Pageテンプレートをベーステンプレートとして追加します。

足場

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

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

足場

開始項目を設定しましょう

サイト定義項目の開始項目を設定します。デフォルトでは、開始項目はすべてのページのルートとなるホーム項目です。

足場

SXA – Search

デフォルトのソートファセットを設定する

データソースのソートをデフォルトでTitleのファセットとして割り当てます。

足場

SXA – サイトメタデータ

AddBrowserTitle

ブラウザタイトルのレンダリングをメタデータの部分的なデザインに挿入します。

足場

AddCustomMetadata

カスタムメタデータのレンダリングをメタデータ部分設計に挿入します。

足場

アドファビコン

Faviconレンダリングをメタデータ部分設計に挿入します。

足場

AddOpenGraphメタデータ

OpenGraphレンダリングをメタデータ部分設計に挿入します。

足場

AddSeoMetadata

SeoMetadataレンダリングをメタデータ部分設計に挿入します。

足場

AddStickyNotes

付箋のレンダリングをメタデータの部分的なデザインに挿入します。

足場

AddTwitterメタデータ

Twitterメタデータのレンダリングをメタデータ部分的なデザインに挿入します。

足場

AddViewport

ビューポートレンダリングをメタデータ部分設計に挿入します。

足場

SXA – 足場

MultisiteContext/Get-DataItem

IMultiSiteContextインターフェースのPowerShellラッパーです。

現在のサイトのDataフォルダを解決します。

コマンドレット

MultisiteContext/Get-SettingsItem

IMultiSiteContextインターフェースのPowerShellラッパーです。

現在のサイトの設定フォルダを解決します。

コマンドレット

MultisiteContext/Get-SiteItem

IMultiSiteContextインターフェースのPowerShellラッパーです。

現在のサイトでサイト項目を解決します。

コマンドレット

MultisiteContext/Get-SiteMediaItem

IMultiSiteContextインターフェースのPowerShellラッパーです。

現在のサイトのバーチャルメディアライブラリを解決します。

コマンドレット

MultisiteContext/Get-TenantItem

IMultiSiteContextインターフェースのPowerShellラッパーです。

現在のサイトのテナント項目を解決します。

コマンドレット

PresentationContext/Get-PageDesignsItem(PresentationContext/Get-PageDesignsItem)

IPresentationContextインターフェースのPowerShellラッパーです。

現在のサイトのPage Designsフォルダを解決します。

コマンドレット

PresentationContext/Get-PartialDesignsItem(PresentationContext/Get PartialDesignsItem)

IPresentationContextインターフェースのPowerShellラッパーです。

現在のサイトの部分設計フォルダを解決します。

コマンドレット

Add-BaseTemplate

ベーステンプレートを追加するコマンドレットです。

コマンドレット

Add-FolderStructure

存在しないパス構造のフォルダを再作成するコマンドレット。

コマンドレット

Add-InsertOptionsToItem

アイテムに InsertOptions (マスター)を追加するコマンドレットです。

コマンドレット

Add-InsertOptionsToTemplate

テンプレート項目に InsertOptions (Masters) を追加するコマンドレット。

コマンドレット

Get-PartialDesign

Partial Designsフォルダの最初の部分設計を返します。

コマンドレット

Test-ItemIsPartialDesign

アイテムが から継承されているかどうかを確認 PartialDesignTemplate。

コマンドレット

Test-ItemIsSiteDefinition

アイテムが から継承されているかどうかを確認 SiteDefinitionTemplate。

コマンドレット

新サイト

新しいサイトを作成する際に使われるすべての機能が含まれています。

コマンドレット

新入居者

新しいテナントを作成するために使われるすべての関数を含みます。

コマンドレット

遺跡

コンテキストメニューの挿入オプションにスクリプトを追加し、ユーザーが新しいサイトを作成できるようにします。以下のルールを満たすと表示されます:

Rule 1
where the item template is SiteFolder
Rule 2
where the item template is Tenant

項目を挿入

借主

コンテキストメニューの挿入オプションにスクリプトを追加し、ユーザーが新しいテナントを作成できるようにします。以下のルールが満たされると表示されます:

Rule 1
where the itemID is equal to Content
Rule 2
where the item template is Tenant Folder

項目を挿入