App Configuration API
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
App Configuration APIは、開発者が以下のために必要な設定を設定することを可能にします:
- Sitecore JavaScriptレンダリングSDKs(JSS)アプリケーションをSitecoreにインポートしてください。
- ASP.NETレンダリングSDKおよびJSS for Next.jsで構築されたアプリケーションとページおよびコンテンツエディターを統合します。
SitecoreインスタンスでJSSアプリケーションの設定パッチを追加するには、\App_Config\Sitecore\JavaScriptServices\Sitecore.JavaScriptServices.ExampleApp.config.exampleファイルの名前を変更して編集できます。
あるいは、公式テンプレートに基づくJSSアプリケーションの場合、アプリケーションのソースコードの/sitecore/configディレクトリに必要な
パッチは
App Configuration APIの例
最小構成には以下の必要な属性が含まれます:
- name
- sitecorePath
- inherits
例えば:
App Configuration API属性
以下の表は利用可能なアプリ構成属性とそのデフォルト値を一覧にしています。
\App_Config\Sitecore\JavaScriptServices\Sitecore.JavaScriptServices.Apps.configファイルのdefaults設定パッチでは、利用可能な属性のデフォルト値を確認できます。
!ヒントApp Configuration APIには、configuration.replaceConfigurationTokensパイプラインによって実装された基本的なトークン置換システムが含まれています。デフォルトでは、パイプラインは $nameトークンのみをサポートしています。
Sitecoreでアプリを設定するには、以下の属性を使用できます:
属性
使用例
名称
必須。アプリケーションのユニークな名前。
サイトコアパス
必須。インポート時のアプリケーションのコンテンツとルートへのパス。最初のインポート時に作成されます。
継承
必須。他の指定されていない設定を継承するアプリを示します。継承は複数のアプリ定義を通じて連鎖的に進みます。
ファイルシステムパス
JavaScript Rendering SDKアプリケーションのファイルシステム展開パス。package.jsonのsitecoreDistPathと一致しなければなりません。デフォルト: /dist/$name
サーバーバンドル
アプリケーションのバンドルされたファイル名 server.js.Default: server.bundle
importUser
インポート時に使うSitecoreユーザーアカウント。ユーザーアカウントを指定することで、セキュリティやワークフローを使ってインポートの操作を制限できます。デフォルト: sitecore\JssImport
importLanguage(importLanguage)
マニフェストに言語値が含まれていない場合、インポート時に使うためのSitecoreのフォールバック言語。デフォルト: en
importDatabase
インポート時に使うためのSitecoreデータベース。デフォルト
importDevice
インポートプロセスでレンダリングが作成されるデバイスレイヤーです。デフォルト:/sitecore/layout/Devices/Default
rootPlaceholders
アプリのレイアウトのルートにあるカンマ区切られたプレースホルダー名のリストです。デフォルト
テンプレートパス
生成されたテンプレートをインポートするパス。パスが存在しない場合は、インポートプロセス中に作成され、祖先フォルダも含まれます。デフォルト:/sitecore/templates/$name
レンダリングパス
生成されたレンダリングをインポートするためのパス。パスが存在しない場合は、インポートプロセス中に作成され、祖先フォルダも含まれます。デフォルト:/sitecore/layout/renderings/$name
layoutパス
アプリのメインレイアウトをインポートするためのパス。パスが存在しない場合は、インポートプロセス中に作成され、祖先フォルダも含まれます。デフォルト:/sitecore/layout/Layouts/JavaScriptServices/$name
プレースホルダーパス
インポートのパスで生成されたプレースホルダー設定。パスが存在しない場合は、インポートプロセス中に作成され、祖先フォルダも含まれます。デフォルト:/sitecore/layout/placeholder settings/$name
appDatasourcesPath
アプリレベルのデータソースアイテムをインポートするためのパス。パスが存在しない場合は、インポートプロセス中に作成され、祖先フォルダも含まれます。デフォルト:/sitecore/content/$name/コンポーネント
routeDatasourcesPath(ルートデータソースパス)
ルートレベルのデータソース項目のために、ルートアイテムの下に子フォルダ名を作成します。デフォルト
mediaLibraryPath
メディアアイテムのインポートの経路。パスが存在しない場合は、インポートプロセス中に作成され、祖先フォルダも含まれます。デフォルト:/sitecore/media library/$name
defaultワークフロー
デフォルトのワークフローは生成されたテンプレートの標準値に適用されました。デフォルト:/sitecore/system/ワークフロー/JSS開発ワークフロー
アプリテンプレート
生成されたルートアプリのテンプレートです。変更された場合、このテンプレートはデフォルトのアプリテンプレートから継承しなければなりません。デフォルト:/sitecore/templates/JavaScriptServices/App
routeBaseTemplate
インポートプロセスがアプリ固有のルートテンプレートを生成する際のベースとして使用すべきテンプレートです。変更した場合、このテンプレートはデフォルトのルートテンプレートから継承しなければなりません。デフォルト:/sitecore/templates/JavaScriptServices/Route
routeTemplateName
生成ルートテンプレートに使う名前。デフォルト:$nameルート
layoutTemplate
アプリのメインレイアウト項目を作成するためのテンプレート。変更する場合は、JSS JavaScriptメインレイアウトから継承しなければなりません。デフォルト:/sitecore/templates/JavaScriptServices/JavaScript メインレイアウト
フォルダテンプレート
汎用フォルダを作成するためのテンプレート(例えばデータソースの項目用)。デフォルト:/sitecore/templates/Common/Folder
プレースホルダー設定フォルダテンプレート
プレースホルダー設定フォルダを作成するためのテンプレートです。デフォルト:/sitecore/templates/System/Layout/Placeholder Settings フォルダ
renderingsFolderTemplate
レンダリングフォルダを作成するためのテンプレート。デフォルト:/sitecore/templates/System/Layout/Renderings/Rendering Folder
layoutFolderTemplate
アプリのメインレイアウト用のフォルダ作成テンプレートです。デフォルト:/sitecore/templates/System/Layout/Layout フォルダー
テンプレートフォルダーテンプレート
テンプレートフォルダを作成するためのテンプレートです。デフォルト:/sitecore/templates/System/Templates/Template フォルダー
mediaLibraryFolderTemplate
メディアライブラリ内のフォルダ作成テンプレート。デフォルト:/sitecore/templates/System/Media/Media フォルダ
protectDeveloperItems(保護開発者アイテム)
テンプレートやレイアウト項目などの開発者アイテムがインポートプロセスで読み取り専用/保護フラグをオンにしなければならないかどうかを示すブール値。デフォルト
optimizeImportIndexing
インポート時にBulkUpdateContextを使わなければならないか、インポート完了時にインデックスを更新するかどうかを示すブール値です。デフォルト
データソース戦略
データソースインポート戦略の名前です。設定は、/javaScriptServices/datasourceStrategiesの設定セクションで設定されたIDatasourceStrategyの名前を参照しなければなりません。デフォルト
analyzeAllowedControls
インポートがインポートルート内のレンダリング使用状況に基づいて、プレースホルダー設定のAllowed Controlフィールドを埋めようと試みる必要があるかどうかを示すブール値です。デフォルト
辞書ドメイン
アプリで使用されているSitecore辞書ドメインの名前またはGUID。設定されていない場合、アプリケーション辞書はコンテキストデータベースのデフォルト辞書にフォールバックします。デフォルト:(なし)
辞書パス
現在のアプリの辞書ドメイン項目のアイテムパスまたはGUIDです。パスが存在しない場合は、インポートプロセス中に作成され、祖先フォルダも含まれます。インポートサービスは辞書ドメインを作成し、この場所で辞書エントリーをインポートします。デフォルト:/sitecore/content/$name/$name辞書
layoutServiceConfiguration
統合モードアプリレンダリング用の名前付きレイアウトサービス構成の名前です。アプリは統合モードで動作していない場合、この設定を明示的に参照しなければなりません。可能な値
、defaultデフォルト、レイアウトサービスのRESTリクエストにはjss設定Sitecore、クエリExperience Edge GraphQLデフォルト設定を使います。すべてのEdgeクエリでは言語の指定が必要です。Edge GraphQLスキーマに対して統合GraphQLクエリを使用する場合、デフォルトの構成ではすべてのクエリに$language値を注入します。jss構成は言語値を提供せず、バージョン18.0.0との後方互換性を保っています。graphQLEndPoint
統合されたGraphQLクエリを可能にします。統合されたGraphQLを使っていない場合は、この属性を削除または省略することができます。
serverSideRenderingEngine
JSSアプリのサーバー側レンダリング時にどのレンダリングエンジンを使うかをSitecoreに指示します。可能な値
。SitecoreAIの場合、有効な値はhttpだけです。serverSideRenderingFunctionName
統合モードでレンダリングする際に呼び出すserverBundleのエクスポートされたJS関数の名前。serverSideRenderingEngineの値をnodejsに設定した場合にのみ関係があります。デフォルト
serverSideRenderingEngineEndpointUrl
リモートレンダリングホストのHTTPエンドポイントを定義します。serverSideRenderingEngineの値をhttpに設定した場合にのみ関係があります。デフォルト:(なし)
serverSideRenderingEngineApplicationUrl
経験エディタに必要なレンダリングHTML内の任意の相対リンクに対して絶対リンクを作成するためのURLを定義します。指定されていない場合(デフォルト)、インポートプロセスはserverSideRenderingEngineEndpointUrlからホスト名を抽出します。serverSideRenderingEngineの値をhttpに設定した場合にのみ関係があります。デフォルト:「」
serverSideRenderingEngineEditOnly
外部レンダリングホストを使用する場合Sitecore非APIルートへのリクエストを処理しなければならないかどうかを制御します。デフォルト
。重要 エクスペリエンスエディター探索モードを使用するには、値をfalseに変更する必要があります。debugセキュリティ
セキュリティデバッグを有効化・無効化するためのブール値。アプリインポート接続の問題がある場合は、サーバー側の共有シークレット処理の詳細を記録するためにtrueに設定してください。接続の問題をデバッグする以外は使わないでください。--debugSecurity CLIフラグと組み合わせてクライアント側のセキュリティ問題を診断してください。デフォルト