--- title: "SXAスクリプトライブラリ" slug: "the-sxa-script-library" abstract: "SXAには最も一般的なタスクを支援する複数のスクリプトが含まれています。" --- # SXAスクリプトライブラリ SXAは最も一般的な作業を自動化するための複数のPowerShellスクリプトを含んでいます。 [Sitecore PowerShell拡張(SPE)モジュール](https://marketplace.sitecore.net/Modules/Sitecore_PowerShell_console.aspx) はコマンドラインとスクリプト環境を提供し、Sitecore内から使用PowerShellを可能にします。このようにして、Windows PowerShellの構文に従ってコマンドを実行し、スクリプトを書くことができます。SPEを使用するすべてのSXAモジュールには、以下の独自のスクリプトライブラリがあります: *sitecore\\System\\Modules\\PowerShell\\Script Library*。 これらのスクリプトの命名規則は以下の通りです:SXA - モジュール名: ![D0815973B19F47F4AD1979ACDBDF6FFD.png](https://doc.sitecore.com/api/markdown-image/xp/ja/developers/sxa/104/sitecore-experience-accelerator/images/D0815973B19F47F4AD1979ACDBDF6FFD.png) > !注PowerShellスクリプトは、日常的に行う作業の自動化に使えます。自分でスクリプトを書いたり、既存のスクリプトのコードを閲覧したりするには、PowerShell統合スクリプト環境(ISE)をご利用ください。このツールはSitecore Launchpadからアクセスできます: > > ![C6B1729442844F20A21E486CC0AA4A7B.png](https://doc.sitecore.com/api/markdown-image/xp/ja/developers/sxa/104/sitecore-experience-accelerator/images/C6B1729442844F20A21E486CC0AA4A7B.png) SXAスクリプトの種類は、クリーンアップスクリプトからアイテムに挿入オプションを追加するcmdltまで多岐にわたります。 - 足場 – 足場建設中に用いられるスクリプトで、サイトや遺跡コレクションの作成プロセスを自動化します。 - コンテキストメニュー – コンテンツエディターを使用する編集者が利用できるスクリプト。例えば、クリーンアップデータソーススクリプト: ![49199728150943779499931A70CA2B68.png](https://doc.sitecore.com/api/markdown-image/xp/ja/developers/sxa/104/sitecore-experience-accelerator/images/49199728150943779499931A70CA2B68.png) - Cmdlets – SPEで使われ、他の開発者でも再利用可能な軽量コマンドです。 - Insert Item – コンテンツエディターの**Insert**セクションを拡張するスクリプト。 以下の表は利用可能なSXAスクリプトモジュール、その機能、説明、スクリプトの種類を説明します。 - **モジュール**: **機能** - SXA – コンプライアンス:AddCookieWarning - SXA – クリエイティブ・エクスチェンジ:ResolveCreativeExchangePathTokens - SXA – フォーム:フォームフォルダをセット - SXA – 地理空間:POI項目の割り当て - SXA – LocalDatasources: クリーンアップデータフォルダ - SXA – マルチサイト:コンテンツフィールドの追加 - ホームベーステンプレート:Site Collectionテンプレートの下にホームテンプレートにベーステンプレートを追加します。ベーステンプレートとしてページテンプレートを追加します。 - ホームアイテムタイトルフィールドを設定する:サイト作成後にホームアイテムタイトルを設定します。 - 開始項目を設定します:サイト定義項目の開始項目を設定します。デフォルトでは、開始項目はすべてのページのルートとなるホーム項目です。 - SXA – Search: デフォルトのソートファセットを設定する - SXA – サイトメタデータ:AddBrowserTitle - AddCustomMetadata:メタデータのレンダリングをメタデータ部分的なデザインに挿入します。 - AddFavicon:Faviconレンダリングをメタデータ部分設計に挿入します。 - AddOpenGraphMetadata:OpenGraphレンダリングをメタデータ部分設計に挿入します。 - AddSeoMetadata:Seoメタデータのレンダリングをメタデータ部分設計に挿入します。 - AddStickyNotes:StickyNotesのレンダリングをメタデータの部分的なデザインに挿入します。 - AddTwitterメタデータ:Twitterメタデータのレンダリングをメタデータの部分的な設計に挿入します。 - AddViewport:ビューポートのレンダリングをメタデータの部分設計に挿入します。 - SXA – スキャフォールディング:MultisiteContext/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:Partial 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