1. 開発者向けのドキュメント

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 />設定を含めることもできます。

パッチは<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_Config\Sitecore\JavaScriptServices\Sitecore.JavaScriptServices.Apps.configファイルのdefaults設定パッチでは、利用可能な属性のデフォルト値を確認できます。

ヒント

App Configuration APIには、configuration.replaceConfigurationTokensパイプラインによって実装された基本的なトークン置換システムが含まれています。デフォルトでは、パイプラインは $nameトークンのみをサポートしています。

Sitecoreでアプリを設定するには、以下の属性を使用できます:

Attribute

使用例

name

必須。アプリケーションのユニークな名前。

sitecorePath

必須。インポート時のアプリケーションのコンテンツとルートへのパス。最初のインポート時に作成されます。

inherits

必須。他の指定されていない設定を継承するappを示します。相続は複数のapp定義を通じて連鎖的に進みます。

filesystemPath

JavaScript Rendering SDKアプリケーションのファイルシステム展開パス。package.jsonのsitecoreDistPathと一致しなければなりません。

デフォルト: /dist/$name

serverBundle

アプリケーションのバンドルファイル名server.js.

デフォルト: server.bundle

importUser

インポート時に使うSitecoreユーザーアカウント。ユーザーアカウントを指定することで、セキュリティやワークフローを使ってインポートの操作を制限できます。

デフォルト: sitecore\JssImport

importLanguage

マニフェストにlanguage値が含まれていない場合にインポート時に使うSitecoreのフォールバック言語です。

デフォルト: en

importDatabase

インポート時に使うためのSitecoreデータベース。

デフォルト: master

importDevice

インポートプロセスでレンダリングが作成されるデバイスレイヤーです。

デフォルト: /sitecore/layout/Devices/Default

rootPlaceholders

アプリのレイアウトのルートにあるカンマ区切られたプレースホルダー名のリストです。

デフォルト: main

templatesPath

生成されたテンプレートをインポートするパス。パスが存在しない場合は、インポートプロセス中に作成され、祖先フォルダも含まれます。

デフォルト: /sitecore/templates/$name

renderingsPath

生成されたレンダリングをインポートするためのパス。パスが存在しない場合は、インポートプロセス中に作成され、祖先フォルダも含まれます。

デフォルト: /sitecore/layout/renderings/$name

layoutPath

アプリのメインレイアウトをインポートするためのパス。パスが存在しない場合は、インポートプロセス中に作成され、祖先フォルダも含まれます。

デフォルト: /sitecore/layout/Layouts/JavaScriptServices/$name

placeholdersPath

インポートのパスで生成されたプレースホルダー設定。パスが存在しない場合は、インポートプロセス中に作成され、祖先フォルダも含まれます。

デフォルト: /sitecore/layout/placeholder settings/$name

appDatasourcesPath

アプリレベルのデータソースアイテムをインポートするためのパス。パスが存在しない場合は、インポートプロセス中に作成され、祖先フォルダも含まれます。

デフォルト: /sitecore/content/$name/Components

routeDatasourcesPath

ルートレベルのデータソース項目のために、ルートアイテムの下に子フォルダ名を作成します。

デフォルト: Page Components

mediaLibraryPath

メディアアイテムのインポートの経路。パスが存在しない場合は、インポートプロセス中に作成され、祖先フォルダも含まれます。

デフォルト: /sitecore/media library/$name

defaultWorkflow

デフォルトのワークフローは生成されたテンプレートの標準値に適用されました。

デフォルト: /sitecore/system/Workflows/JSS Development Workflow

appTemplate

生成されたルートアプリのテンプレートです。変更された場合、このテンプレートmustデフォルトのアプリテンプレートから継承されます。

デフォルト: /sitecore/templates/JavaScriptServices/App

routeBaseTemplate

インポートプロセスがアプリ固有のルートテンプレートを生成する際のベースとして使用すべきテンプレートです。変更された場合、このテンプレートmustデフォルトのルートテンプレートから継承されます。

デフォルト: /sitecore/templates/JavaScriptServices/Route

routeTemplateName

生成ルートテンプレートに使う名前。

デフォルト: $name Route

layoutTemplate

アプリのメインレイアウト項目を作成するためのテンプレート。変更した場合、mustはJSS JavaScript Main Layoutから継承されます。

デフォルト: /sitecore/templates/JavaScriptServices/JavaScript Main Layout

folderTemplate

汎用フォルダを作成するためのテンプレート(例えばデータソースの項目用)。

デフォルト: /sitecore/templates/Common/Folder

placeholderSettingsFolderTemplate

プレースホルダー設定フォルダを作成するためのテンプレートです。

デフォルト: /sitecore/templates/System/Layout/Placeholder Settings Folder

renderingsFolderTemplate

レンダリングフォルダを作成するためのテンプレート。

デフォルト: /sitecore/templates/System/Layout/Renderings/Rendering Folder

layoutFolderTemplate

アプリのメインレイアウト用のフォルダ作成テンプレートです。

デフォルト: /sitecore/templates/System/Layout/Layout Folder

templateFolderTemplate

テンプレートフォルダを作成するためのテンプレートです。

デフォルト: /sitecore/templates/System/Templates/Template Folder

mediaLibraryFolderTemplate

メディアライブラリ内のフォルダ作成テンプレート。

デフォルト: /sitecore/templates/System/Media/Media folder

protectDeveloperItems

テンプレートやレイアウト項目などの開発者アイテムがインポートプロセスで読み取り専用/保護フラグをオンにしなければならないかどうかを示すブール値。

デフォルト: true

optimizeImportIndexing

インポートがBulkUpdateContextを使う必要があるかどうかを示すブール値で、インポート完了時にインデックスを更新します。

デフォルト: true

datasourceStrategy

データソースインポート戦略の名前です。設定は/javaScriptServices/datasourceStrategies設定セクションで設定されたIDatasourceStrategyの名前を参照しなければなりません。

デフォルト: preferRouteLevel

analyzeAllowedControls

インポートがインポートされたルート内のレンダリング使用状況に基づいて、プレースホルダー設定でAllowed Controlsフィールドを埋めようと試みるかどうかを示すブール値です。

デフォルト: true

dictionaryDomain

アプリで使用されているSitecore辞書ドメインの名前またはGUID。設定されていない場合、アプリケーション辞書はコンテキストデータベースのデフォルト辞書にフォールバックします。

デフォルト:(なし)

dictionaryPath

現在のアプリの辞書ドメイン項目のアイテムパスまたはGUIDです。パスが存在しない場合は、インポートプロセス中に作成され、祖先フォルダも含まれます。インポートサービスは辞書ドメインを作成し、この場所で辞書エントリーをインポートします。

デフォルト: /sitecore/content/$name/$name Dictionary

layoutServiceConfiguration

統合モードアプリレンダリング用の名前付きレイアウトサービス構成の名前です。アプリは統合モードで動作していない場合、この設定を明示的に参照しなければなりません。

可能な値: jss, default

デフォルト: jss

注記

一般的に、レイアウトサービスのRESTリクエストにはjss構成Sitecore、Experience Edge GraphQLクエリにはdefault構成を使用します。

すべてのEdgeクエリで言語の指定が必要です。Edge GraphQLスキーマに対して統合GraphQLクエリを使用する場合、default構成によりすべてのクエリに $language値が注入されることが保証されます。 jss構成は言語値を提供せず、バージョン18.0.0との後方互換性を保っています。

graphQLEndpoint

統合されたGraphQLクエリを可能にします。統合されたGraphQLを使っていない場合は、この属性を削除または省略することができます。

serverSideRenderingEngine

JSSアプリのサーバー側レンダリング時にどの レンダリングエンジン を使うかをSitecoreに指示します。

可能な値: nodejsとhttp。

SitecoreAIの場合、有効な値はhttpのみです。

serverSideRenderingFunctionName

統合モードでレンダリングする際に呼び出すためにserverBundleにエクスポートされたJS関数の名前。

serverSideRenderingEngineの値をnodejsに設定した場合にのみ関係があります。

デフォルト: renderView

serverSideRenderingEngineEndpointUrl

リモートレンダリングホストのHTTPエンドポイントを定義します。

serverSideRenderingEngineの値をhttpに設定した場合にのみ関係があります。

デフォルト:(なし)

serverSideRenderingEngineApplicationUrl

Experience Editorに必要なレンダリングHTML内の任意の相対リンクに対して絶対的なリンクを作成するためのURLを定義します。指定がない場合(デフォルト)、インポートプロセスはserverSideRenderingEngineEndpointUrlからホスト名を抽出します。

serverSideRenderingEngineの値をhttpに設定した場合にのみ関係があります。

デフォルト:「」

serverSideRenderingEngineEditOnly

外部レンダリングホストを使用する場合Sitecore非APIルートへのリクエストを処理しなければならないかどうかを制御します。

デフォルト: true。

大事な

Experience Editor探索モードを使用するには、値をfalseに変更する必要があります。

debugSecurity

セキュリティデバッグを有効化・無効化するためのブール値。アプリインポート接続の問題がある場合はtrueに設定し、共有シークレットのサーバー側処理の詳細を記録してください。 Do not use it unless debugging a connection issue。CLIフラグ --debugSecurity組み合わせてクライアント側のセキュリティ問題を診断してください。

デフォルト: false

この記事を改善するための提案がある場合は、 お知らせください!