SitecoreAIビルド構成

ホストレンダリングの設定オプション

ビルド設定ファイルでレンダリングホストを定義できます。各定義は 、サイト名をサイト に関する情報にマッピングします。

例えば:

"renderingHosts": { "xmcloudpreview": { "path": "./src/rendering", "nodeVersion": "16.3.19", "packageManager": "npm", "jssDeploymentSecret": "super-secret-value", "enabled": true, "type": "sxa", "buildCommand": "build", "runCommand": "next

!注編集ホストのビルドプロセスとランタイムは制限された環境で動作します。読み取り、追加、編集、削除などのファイル操作は指定された作業ディレクトリ内で行う必要があります。

以下の表は、サイト情報の設定に使用するプロパティを説明します。

名称

種類

概要

path

string

xmcloud.build.jsonファイルからアプリのソースコードへの相対的な経路です。通常はルートフォルダからの相対パスです。

XM Cloudは現在SitecoreAIとなっています
一部のコード例、画像、UIラベルは、エンジニアリング資産の更新中もXM Cloudを使用している場合があります。

nodeVersion

string

ホストレンダリング用の特定のNode.jsバージョン。

ホストやスターターが使用するNode.jsのメジャーバージョンとContent SDKが使用するバージョンは一致しなければなりません。

packageManager

string

アプリケーション構築に使うパッケージマネージャーを定義します。

可能な値: npm、 pnpm。デフォルト値は npmです。

プロパティがなければデフォルトが適用されます。

jssDeploymentSecret

string

32文字以上のランダム生成文字列。デプロイシークレットは、アプリケーションがSitecoreインスタンスにアイテムをデプロイすることを許可する共有シークレットです。scjssconfig.jsonファイルにdeploySecretの値を入力します。

enabled

boolean

サイトを有効にする。

デフォルト: false。

type

string

レンダリングホストの種類。

許容値: "jss" または "sxa"。

デフォルト: "jss"

注記
SXAサイトは SXAテンプレート から作成され、アイテムベースの構成が使われます。JSSサイトは JSSテンプレート から作成され、ファイルベースの構成を使用します。

buildCommand

string

package.jsonファイルからコマンドをビルドして実行します。

デフォルト: "build"

runCommand

string

package.jsonファイルからコマンドを実行して実行してください。

デフォルト: "next

!重要startCommandは非推奨され無視されています。代わりにbuildCommandとrunCommandを使いましょう。

カスタム編集ホスト

編集ホストは、Page BuilderやDesign StudioなどのエディターでWYSIWYG編集を可能にします。カスタム編集ホストは、xmcloud.build.jsonファイルのrenderingHostsエントリに対応します。

!警告カスタム編集ホストを追加する際に「デフォルト」という名前は使わないでください。「Default」は予約された編集ホスト名であり、カスタム編集ホストには使用できません。この名前でカスタム編集ホストを設定しようとすると、誤ったサイト解像度や予期しない挙動を引き起こす可能性があります。

XDT変換

XDT変換をサポートするには、フォルダまたはXDTのソースファイルおよび設定宛先ファイルへの完全限定パスを指定する必要があります。

変換は完全に構築された解で起こります。

パスは構築されたコードのウェブルートに対して相対的でなければなりません。例えば、XDTのソースファイルがsrc/platform/xdtsフォルダにあると仮定すると、変換パスを次のように設定できます:

"transforms": { "xdtPath": "/xdts//", "targetPath": "//" }, { "xdtPath": "/xdts//", "targetPath": "/" }, { "xdtPath": "/xdts/web.config.xdt", "targetPath": "/web.config" }

!注各変換のxdtPathプロパティの価値は、プロジェクトファイルの整理方法によって異なります。この例では、プロジェクトがSitecoreが提供する基礎テンプレートに基づいており、変換が /src/platform/xdts/ フォルダにあると仮定します。XDTファイルの定義方法については、web.config変換のドキュメントを参照してください。

展開後の行動

デプロイメントプロセスのデプロイメントの後に実行される「ポストアクション」と呼ばれる様々な操作を設定できます。

ビルド構成には、要件に合わせてカスタマイズできるデフォルトのアクションが含まれています。これらはpostActionsオブジェクトのactionsプロパティを用いて定義され、以下が含まれます:

• CMウォームアップ。
• SCSモジュールの展開。
• スキーマ集団。
• インデックス変更。
• 出版。

!注ポストアクションは設定ファイルに表示される順に順に実行されます。したがって、投稿アクションを設定する際は、アクションの順序を変更しないことを強くお勧めします。

以下の例で示された順序により、SCSモジュールを展開した場合、それらは公開されます。そして、インデックスは再インデックスする前に入力されていること。

投稿アクション構成は以下の構成です:

"postActions": { "actions":{ "warmUpCm": { "urls": }, "scsModules": { "modules": }, "populateSchema": { "indexNames": }, "reindex": { "indexNames": }, "publish": { "path": "", "languages": , "itemIds": , "targets": , "republish": true, "publishSubItems": true } } }