App Configuration API
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
ヘッドレス サービスの App Configuration API を使って、開発者は次の目的に必要な設定を行うことができます。
-
Sitecore への Sitecore JavaScript レンダリング SDK (JSS) アプリケーションのインポート、または統合モードでの JSS アプリケーションの実行
-
Next.js 向けの ASP.NET レンダリング SDK および JSS で構築されたアプリケーションと高度な Sitecore エディターの統合
JSS アプリケーションの設定パッチを次のファイルに追加できます。
Sitecore インスタンスでは、\App_Config\Sitecore\JavaScriptServices\Sitecore.JavaScriptServices.ExampleApp.config.example
の名前を変更して編集できます。
<javaScriptServices>
設定ノードの <apps>
ノードにパッチを追加する必要があります。
App Configuration API の例
最小設定には次の必須属性が含まれます。
-
name
-
sitecorePath
-
inherits
例:
<configuration xmlns:patch="http://www.sitecore.net/xmlconfig/">
<sitecore>
<javaScriptServices>
<apps>
<app name="exampleApp"
sitecorePath="/sitecore/content/ExampleApp"
inherits="defaults"
/>
</apps>
</javaScriptServices>
</sitecore>
</configuration>
App Configuration API の属性
次の表に、使用可能な App Configuration の属性とその既定値を示します。
defaults
設定パッチの \App_Config\Sitecore\JavaScriptServices\Sitecore.JavaScriptServices.Apps.config
ファイルで、いくつかの利用可能な属性の既定値を確認することができます。
App Configuration API には、configuration.replaceConfigurationTokens
パイプラインで実装される基本的なトークン置換システムが含まれます。既定では、パイプラインは $name
トークンのみをサポートします。
Sitecore でアプリを設定するには、次の属性を使用できます。
属性 |
使用方法 |
---|---|
|
必須。アプリケーションの一意の名前。 |
|
必須。インポート時のアプリケーションのコンテンツとルートへのパス。最初のインポート時に作成されます。 |
|
必須。指定されていない他の設定をどの |
|
JavaScript レンダリング SDK のファイル システム デプロイ パス。 既定: |
|
アプリケーションの 既定: |
|
インポート プロセスで使用する Sitecore ユーザー アカウント。ユーザー アカウントを指定すると、セキュリティとワークフローにより、インポート アクションを制限できます。 既定: |
|
マニフェストに 既定: |
|
インポート中に使用する Sitecore データベース。 既定: |
|
インポート プロセスでレンダリングを作成するデバイス レイヤー。 既定: |
|
アプリ レイアウトのルートにあるプレースホルダー名のコンマ区切りリスト。 既定: |
|
生成されたテンプレートをインポートするパス。パスが存在しない場合は、先祖フォルダーを含め、インポート プロセス中に作成されます。 既定: |
|
生成されたレンダリングをインポートするパス。パスが存在しない場合は、先祖フォルダーを含め、インポート プロセス中に作成されます。 既定: |
|
生成されたアプリのメイン レイアウトをインポートするパス。パスが存在しない場合は、先祖フォルダーを含め、インポート プロセス中に作成されます。 既定: |
|
生成されたプレースホルダー設定をインポートするパス。パスが存在しない場合は、先祖フォルダーを含め、インポート プロセス中に作成されます。 既定: |
|
生成されたアプリ レベルのデータソース アイテムをインポートするパス。パスが存在しない場合は、先祖フォルダーを含め、インポート プロセス中に作成されます。 既定: |
|
ルート レベルのデータソース アイテムのルート アイテムの下に作成する子フォルダー名。 既定: |
|
生成されたメディア アイテムをインポートするパス。パスが存在しない場合は、先祖フォルダーを含め、インポート プロセス中に作成されます。 既定: |
|
生成されたテンプレートの標準値に適用される既定のワークフロー。 既定: |
|
生成されたルート アプリ アイテムのテンプレート。これを変更する場合、テンプレートは既定のアプリ テンプレートから継承する必要があります。 既定: |
|
インポート プロセス中に、アプリ固有のルート テンプレートの生成でベースとして使用するテンプレート。これを変更する場合、テンプレートは既定のルート テンプレートから継承する必要があります。 既定: |
|
生成されたルート テンプレートに使用する名前。 既定: |
|
アプリのメイン レイアウト アイテムの作成に使用するテンプレート。これを変更する場合、JSS の 既定: |
|
汎用フォルダー (データソース アイテム用など) を作成するためのテンプレート。 既定: |
|
プレースホルダー設定フォルダーを作成するためのテンプレート。 既定: |
|
レンダリング フォルダーを作成するためのテンプレート。 既定: |
|
アプリのメイン レイアウト用のフォルダーを作成するためのテンプレート。 既定: |
|
テンプレート フォルダーを作成するためのテンプレート。 既定: |
|
メディア ライブラリにフォルダーを作成するためのテンプレート。 既定: |
|
テンプレートやレイアウト アイテムなどの開発者アイテムの読み取り専用/保護フラグをインポート プロセスでオンにする必要があるかどうかを示すブール値。 既定: |
|
インポートで 既定: |
|
データソース インポート戦略の名前。この設定は、 既定: |
|
インポートされたルート内のレンダリングの使用状況に基づいて、インポート中にプレースホルダー設定の 既定: |
|
アプリで使用される Sitecore ディクショナリ ドメインの名前または GUID 。設定しない場合、アプリケーションのディクショナリは、コンテキスト データベースの既定のディクショナリにフォールバックします。 既定: (なし) |
[en] |
[en] The item path or GUID for the dictionary domain item of the current app. If the path does not exist, it is created during the import process, including any ancestor folders. The import service creates dictionary domains and imports dictionary entries in this location. [en] Default : |
|
統合モード アプリ レンダリングのレイアウト サービス設定の名前。統合モードで実行していない場合、アプリはこの設定を明示的に参照する必要があります。 [en] Possible values: 既定: 注記 [en] Generally, you use the [en] Specifying the language is required for all Edge queries. When using integrated GraphQL queries against the Edge GraphQL schema, the |
[en] |
[en] Enables integrated GraphQL queries. If you are not using integrated GraphQL, you can remove or omit this attribute. |
|
サーバーサイドで JSS アプリをレンダリングする際に使用するレンダリング エンジンを Sitecore に指示します。 使用可能な値は、 既定: |
|
統合モードのレンダリングで呼び出す
既定: |
|
リモート レンダリング ホストの HTTP エンドポイントを定義します。
既定: "" |
|
レンダリングされた HTML のすべての関連リンク用の絶対リンクの作成に使用する URL を定義します。これは、エクスペリエンス エディターで必要です。指定しない場合 (既定)、インポート プロセスは
既定: "" |
|
外部レンダリング ホストを使用する際に、Sitecore が非 API ルートへの要求を処理するかどうかを制御します。 既定: 重要 [en] To use the Experience Editor explore mode, you must change the value to |
|
アプリ インポートの共有シークレットを設定します。 シークレットは 32 文字以上のランダムに生成された文字列で、JSS アプリの 既定: (なし) 注記 Sitecore ファーストの開発ワークフローを使用する際は、 重要 このシークレットをソース管理にコミットしないでください。すべての環境で一意のシークレットを使用してください。このシークレットを所有することで、Sitecore アイテムの作成および変更を管理することができます。 |
|
セキュリティ デバッグを有効/無効にするブール値。共有シークレットのサーバーサイドでの処理に関するアプリのインポート接続の問題がある場合は 既定: |