SXAスクリプト ライブラリ

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

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

SXAには、最も一般的なタスクを自動化するためのPowerShellスクリプトが多数含まれています。 Sitecore PowerShell Extensions (SPE) モジュールは 、コマンド ラインとスクリプト環境を提供し、Sitecore内からPowerShellを使用できるようにします。このようにして、Windows PowerShellの構文に従ってコマンドを実行し、スクリプトを記述できます。SPEを使用するすべてのSXAモジュールには、sitecore\System\Modules\PowerShell\Script Libraryに独自のスクリプト ライブラリがあります。

これらのスクリプトの命名規則は、SXA - モジュール名です。

メモ

PowerShellスクリプトを使用すると、定期的に実行しているタスクを自動化できます。独自のスクリプトを記述したり、既存のスクリプトのコードを表示したりするには、PowerShell Integrated Scripting Environment (ISE) を使用します。このツールは、Sitecore Launchpadでアクセスできます。

SXAスクリプトのタイプは、クリーンアップ スクリプトから、アイテムに挿入オプションを追加するcmdltsまでさまざまです。

  • スキャフォールディング – サイト/テナントの作成プロセスを自動化するためにスキャフォールディング中に使用されるスクリプト。

  • コンテキストメニュー – コンテンツエディターを使用するエディターが使用できるスクリプト。たとえば、クリーンアップ データ ソース スクリプトは次のようになります。

  • コマンドレット – SPEで使用され、他の開発者が再利用できる軽量のコマンド。

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

次の表では、使用可能なSXAスクリプト モジュール、その機能、説明、およびスクリプトのタイプについて説明します。

Module

Function

Description

Type of script

SXA – コンプライアンス

AddCookie警告

Cookie警告レンダリングをパーシャルデザインに挿入します。

足場

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

ResolveCreativeExchangePathトークン

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

足場

SXA – フォーム

フォームフォルダの設定

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

足場

SXA – 地理空間

POIアイテムの割り当て

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

足場

SXA – ローカルデータソース

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

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

コンテキストメニュー

SXA – マルチサイト

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

新しいTenantテンプレートを追加フィールドで装飾します。PageテンプレートにContentフィールドとTitleフィールドを追加します。

足場

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

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

足場

ホームアイテムのタイトルフィールドを設定する

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

足場

スタート項目の設定

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

足場

SXA – 検索

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

Titleファセットを、データ ソースを並べ替えるための既定のファセットとして割り当てます。

足場

SXA – サイト メタデータ

AddBrowserTitle(英語)

ブラウザタイトルレンダリングをメタデータパーシャルデザインに挿入します。

足場

AddCustomMetadata (カスタムメタデータを追加)

CustomMetadataレンダリングをメタデータ パーシャル デザインに挿入します。

足場

アッドファビコン

ファビコンレンダリングをメタデータパーシャルデザインに挿入します。

足場

OpenGraphMetadataを追加

OpenGraphレンダリングをメタデータ パーシャル デザインに挿入します。

足場

AddSeoMetadata(英語)

SeoMetadataレンダリングをメタデータ パーシャル デザインに挿入します。

足場

付箋を追加

StickyNotesレンダリングをメタデータ パーシャル デザインに挿入します。

足場

Twitterメタデータを追加

TwitterMetadataレンダリングをメタデータ パーシャル デザインに挿入します。

足場

ビューポートを追加

ビューポートレンダリングをメタデータパーシャルデザインに挿入します。

足場

SXA – スキャフォールディング

マルチサイトコンテキスト/取得-データアイテム

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

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

コマンドレット

マルチサイトコンテキスト/Get-SettingsItem

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

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

コマンドレット

マルチサイトコンテキスト/取得-サイトアイテム

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

現在のサイトのSiteアイテムを解決します。

コマンドレット

MultisiteContext/Get-SiteMediaItem (英語)

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

現在のサイトの仮想メディア ライブラリを解決します。

コマンドレット

MultisiteContext/Get-テナントアイテム

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

現在のサイトのTenantアイテムを解決します。

コマンドレット

PresentationContext/Get-PageDesignsItem (英語)

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

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

コマンドレット

PresentationContext/Get-PartialDesignsItem

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

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

コマンドレット

ベーステンプレートの追加

基本テンプレートを追加するコマンドレット。

コマンドレット

Add-FolderStructure (フォルダ構造を追加)

特定のパス構造のフォルダーが存在しない場合に再作成するコマンドレット。

コマンドレット

Add-InsertOptionsToItem (挿入オプションをアイテムに追加)

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

コマンドレット

テンプレートへの追加-挿入オプション

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

コマンドレット

Get-PartialDesign

Partial Designsフォルダ内の最初のパーシャルデザインを返します。

コマンドレット

Test-ItemIsPartialDesign

アイテムがPartialDesignTemplateから継承しているかどうかを確認します。

コマンドレット

Test-ItemIsSiteDefinition

アイテムがSiteDefinitionTemplateから継承しているかどうかを確認します。

コマンドレット

新サイト

新しいサイトの作成に使用されるすべての関数が含まれています。

コマンドレット

ニューテナント

新しいテナントの作成に使用されるすべての関数が含まれています。

コマンドレット

敷地

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

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

アイテムの挿入

テナント

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

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

アイテムの挿入

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

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