SXA CLI を使用したテーマの追加

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

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

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

ヒント

このセクションでは、デフォルト ユーザーで SXA CLI を使用する方法について説明します。カスタム ユーザーが SXA CLI を使用できるようにする場合は、「カスタム ユーザーでの SXA CLI の使用」を参照してください。

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.jsnpm config set @sxa:registry=https://sitecore.myget.org/F/sc-npm-packages/npm/ をインストールします。

    注記

    このコマンドは、コマンド プロンプトでのみ機能します。PowerShell を使用しないでください。コマンド プロンプトで機能しない場合は、手動で正しい値を .npmrc ファイルに追加できます。

  • ノード パッケージ マネージャー (NPM) をグローバルにインストールします。npm と install コマンドを使用して、SXA CLI をグローバル パッケージ npm i -g @sxa/CLI としてインストールします。これは利用可能な最新の CLI を使用します。

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

  1. テーマの定型文を Sitecore myget サイトからダウンロードします。

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

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

  4. sxa init を実行します。

  5. アップロード用の URL を追加します。ローカル戦略専用またはグローバル戦略専用の 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. Creative Exchange を使用している場合は、このステップをスキップします。

    ThemeRoot/gulp/serverConfig.json を開き、以下を入力します。

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

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

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

  8. npm i を実行します。

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

    Sitecore/コンテンツ/&lt;テナント&gt;/&lt;サイト&gt;/設定に移動して、[サイト設定] セクションの [互換テーマ] フィールドで、新しいテーマを [選択済み] フィールドに追加します。これで、このテーマをサイトの現在のテーマとして選択できます。

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

コマンド

エイリアス

説明

sxa init

sxa i

Creative Exchange Live Mode との互換性のために必要なすべてのファイルをダウンロードします。このプロセスは、不足しているファイルをダウンロードするもので、既存のファイルを置き換えるものではありません。

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/メディア ライブラリ/テーマ読み取り書き込み作成名前を変更削除 の権限が付与されていることを確認します。

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

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

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