SXA CLIを使用してテーマを追加する

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

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

SXA CLIは、SXAプロジェクトのタスクを自動化するための便利なコマンドライン ツールです。このトピックでは、SXA CLIを使用してテーマを追加する方法について説明します。これは、アセットをより詳細に制御し、Gitなどのバージョン管理システムを使用する場合に便利です。

SXA CLIを使用してテーマを追加できるようにするには、次の手順を実行します。

  • 十分な権限が必要です。 sitecore\Powershell Extensions Remotingロールが割り当てられているか、ユーザーを /configuration/sitecore/powershell/services/restfulv2/authorization設定ノードに追加する必要があります。

    RequestResponse
    <configuration>
 <sitecore>
  <powershell>
    <services>
      <restfulv2>
        <authorization>
         <add Permission="Allow" IdentityType="User" Identity="sitecore\username" />
          </authorization>
        </restfulv2>
    </powershell>
  </sitecore>
</configuration>

  • Node Package Manager (NPM) をグローバルにインストールする: npmとinstallコマンドを使用して、SXA CLIをグローバル パッケージとしてインストールします (npm i -g @sitecore/sxa-cli)。これには、使用可能な最新のCLIが使用されます。

SXA CLIを使用してテーマを追加するには:

  1. Sitecoreテーマの定型文をダウンロードします。

  2. Website\App_Config\Include\z.Feature.Overridesに移動し、z.SPE.Sync.Enabler.Gulp.config.disabledファイルを有効にします。

  3. ダウンロードしたテーマの定型文フォルダに切り替えます。

  4. sxa initを実行します。

  5. アップロード用のURLを追加します。3つのオプションがあります: serverUrlStrategyを使用してローカル戦略またはグローバル戦略専用にするか、CLIオプションを使用してURLを指定できます。

    • ServerUrlStrategy: 'local': Gulpタスクの設定ファイル (ThemeRoot/gulp/config.js) のserverOptions.serverに登録されているSitecoreインスタンスのパスにファイルを送信します。

    • ServerUrlStrategy: 'global': CLIによって登録された値を取ります。このパスSXA見つからない場合、localに設定されたかのようにフォールバックします。

    • -u, --url - <Instance URL>: インスタンスURLにファイルをアップロードします (例: -url https://sxa-instance.test)。この方法でURLを指定すると、タスクはserverUrlStrategyプロパティを無視し、CLIオプションから値を取得します。CLIオプションの詳細については 、「SXA CLIウォッチ、(再) ビルド、アップロード タスク」を参照してください。

  6. If you use Creative Exchange, skip this step.

    ThemeRoot/gulp/serverConfig.jsonを開き、次のように入力します。

    • serverOptions.projectPath - テーマが配置されているプロジェクトへのパス。

    • serverOptions.themePath - プロジェクトルートからの基本テーマフォルダへのパス。

  7. コマンドラインでテーマのルートフォルダを開きます。

  8. npm iを実行します。

  9. これで、新しいテーマが利用可能になりました。新しいテーマをサイトに割り当てる必要があります。

    に移動し、Sitecore/Content/<tenant>/<site>/SettingsSite Configuration設定のCompatible themesフィールドで、新しいテーマをSelectedフィールドに追加します。これで、サイトの現在のテーマとしてテーマを選択できます。

次の表では、テーマ設定でSXA CLIを使用するための最も重要なコマンドについて説明します。

命令

別名

形容

sxa init

sxa i

Creative Exchangeライブモードとの互換性を保つために必要なすべてのファイルをダウンロードします。このプロセスでは、不足しているファイルがダウンロードされ、既存のファイルは置き換えられません。

sxa new <ThemeName> --url <url>

sxa n

テーマ作成パイプラインを実行し、テーマをローカルとSitecoreの両方に保存します。すべてのアセットをダウンロードします。このコマンドを使用して、サイトの新しいテーマを作成します。

テーマを作成するインスタンスに追加できます。現在登録されているSitecoreインスタンスでテーマを作成する場合は、URLを指定する必要はありません。

sxa config

sxa c

質問のリストに回答することで、テーマ変数を設定します。このコマンドを使用して、テーマの設定を変更します。

sxa register <url>

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の監視、ビルド、アップロードのタスク

カスタム ユーザーでSXA CLIを使用する

デフォルトのsitecore\adminユーザーを使用してSXA CLIからテーマをアップロードしたくない場合は、この目的のために別のユーザーを作成できます。

SXA CLIを使用できるカスタム ユーザーを作成するには、次の手順を実行します。

  1. ユーザーエディタを開き、新しいユーザーを作成します。

  2. ユーザーエディタで、sitecore\PowerShell Extensions Remotingロールをユーザーに割り当てます。

    メモ

    Azure環境では、sitecore\PowerShell Extensions Remotingロールはデフォルトでは存在しません。ロールが見つからない場合は、ロール マネージャーで作成する必要があります。

  3. ユーザーに /sitecore/media library/Themesの権限 ( Read、Write、Create、Rename、Deleteがあることを確認します。

  4. z.SPE.Sync.Enabler.Gulf.configファイルが有効になっていることを確認します。ここにあります:\App_Config\Include\z.Feature.Overrides\。

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

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