SXA CLIを使ってテーマを追加する
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
SXA CLIは、SXAプロジェクトのタスクを自動化するための便利なコマンドラインツールです。このトピックでは、SXA CLIを使ってテーマを追加する方法について説明します。これは、Gitのようなバージョン管理システムを使って資産をよりコントロールしたい場合に便利です。
SXA CLIを使ってテーマを追加するには:
-
十分な権限を持っている必要があります。 sitecore\Powershell Extensions Remotingロールを割り当てるか、ユーザーを /configuration/sitecore/powershell/services/restfulv2/authorization設定ノードに追加する必要があります。
-
Node Package Manager(NPM)をグローバルにインストールする
i -g @sitecore/sxa-cli。これは利用可能な最新のCLIを使用します。
SXA CLIを使ってテーマを追加するには:
-
Sitecoreのテーマボイラープレートをダウンロードしてください。
-
Website\App_Config\Include\z.Feature.Overridesに行ってz.SPE.Sync.Enabler.Gulp.config.disabledファイルを有効にしてください。
-
ダウンロードしたテーマのボイラープレートフォルダに切り替えてください。
-
走ってsxa init。
-
アップロード用のURLを追加してください。選択肢は3つあります。 serverUrlStrategyを使ってローカルまたはグローバル戦略を専用にするか、CLIオプションでURLを指定するかです。
- ServerUrlStrategy: 'local': Gulpタスクの設定ファイルで serverOptions.server に登録されたSitecoreインスタンスのパスにファイルを送ります(ThemeRoot/gulp/config.js)。
- ServerUrlStrategy: 'global': はCLIが登録した値を取ります。もしSXAがこのパスを見つけられなければ、 localに設定されたかのようにフォールバックします。
- -u, --url -
: ファイルをインスタンスURLにアップロードします。例えば -url https://sxa-instance.test。このようにURLを指定すると、タスクは serverUrlStrategy プロパティを無視し、CLIオプションから値を取ってしまいます。CLIオプションの詳細については、「 SXA CLIウォッチ、(再)構築、アップロードタスク」をご覧ください。
-
Creative Exchangeを使う場合は、このステップを省略してください。
ThemeRoot/gulp/serverConfig.json開いて入力してください:
- serverOptions.projectPath - テーマが配置されるプロジェクトへのパス。
- serverOptions.themePath - プロジェクトルートから基本テーマフォルダへのパス。
-
コマンドラインでThemeのルートフォルダを開きます。
-
走ってnpm i。
-
新しいテーマが利用可能になりました。新しいテーマをあなたのサイトに割り当てる必要があります:
Sitecore/Content///Settingsに行き、サイト設定の**「互換性のあるテーマ」**欄で「選択済み」欄に新しいテーマを追加してください。これで、そのテーマをサイトの現在のテーマとして選択できます。
以下の表は、テーマ設定でSXA CLIを使用する際の最も重要なコマンドを説明しています:
指揮
別名
概要
sxa init
sxa i
Creative Exchange Live Modeとの互換性のために必要なすべてのファイルをダウンロードします。このプロセスは欠けているファイルをダウンロードし、既存のファイルを置き換えるものではありません。
sxa new
sxa n
テーマ作成パイプラインを実行し、テーマをローカルとSitecoreの両方に保存します。すべてのアセットをダウンロードします。このコマンドを使って新しいテーマを作成してください。
テーマを作成するべきインスタンスに追加できます。現在登録されているSitecoreインスタンスでテーマを作成したい場合は、URLを指定する必要はありません。
sxa config
sxa c
質問リストに答えてテーマ変数を設定します。このコマンドを使ってテーマ設定を変更します。
sxa register
sxa reg
グローバルにSitecore URLのインスタンスを登録します。
sxa get-url
sxa g
現在登録されているURLを確認します。
sxa build taskName
sxa b
現在のテーマ設定に基づいてテーマアセットを作成します。利用可能なタスクについては、 SXAのウォッチ、ビルド、アップロードタスクにアクセスしてください。
sxa upload taskName
sxa u
テーマ設定に基づいてテーマアセットをアップロードします。利用可能なタスクについては、SXAのウォッチ、ビルド、アップロードタスクにアクセスしてください
sxa watch taskName
sxa w
ウォッチはテーマアセットを変更し、修正ファイルを自動でアップロードします。利用可能なタスクについては、SXAのウォッチ、ビルド、アップロードタスクにアクセスしてください
コマンドで設定 sxa config 可能です。
sxa rebuild taskName
sxa r
テーマアセットの再構築とアップロード。利用可能なタスクについては、
カスタムユーザーでSXA CLIを使います
SXA CLIを通じてテーマをアップロードするためにデフォルトのsitecore/adminユーザーを使いたくない場合は、この目的のために別のユーザーを作成できます。
SXA CLIを使用できるカスタムユーザーを作成するには:
-
ユーザーエディターを開き、新しいユーザーを作成します。
-
ユーザーエディターでsitecore\PowerShell Extensions Remotingロールをユーザーに割り当てます。
!注Azure環境では、sitecore\PowerShell Extensions Remoting役割はデフォルトで存在しません。役割が存在しない場合は、Role Managerで作成しなければなりません。
-
ユーザーが /sitecore/media library/Themesの以下の権限を持っているか確認してください: Read、Write、Create、Rename、Delete。
-
z.SPE.Sync.Enabler.Gulf.configファイルが有効になっていることを確認してください。ファイルはこちらにあります:\App_Config\Include\z.Feature.Overrides\。