アプリ構成API

Version: 22.x
日本語翻訳に関する免責事項

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

ヘッドレス サービス アプリ構成APIを使用すると、開発者は次の必要な設定を構成できます。

SitecoreインスタンスにJSSアプリケーションの設定パッチを追加するには、\App_Config\Sitecore\JavaScriptServices\Sitecore.JavaScriptServices.ExampleApp.config.exampleファイルの名前を変更して編集します。

または、公式テンプレートに基づくJSSアプリケーションの場合は、アプリケーションのソースコードの/sitecore/configディレクトリに必要な<app />構成を含めることができます。

パッチは、<javaScriptServices> 構成ノードの <apps> ノードに追加する必要があります。

App Configuration APIの例

最小構成には、次の必須属性が含まれます。

  • name

  • sitecorePath

  • inherits

例えば：

RequestResponse
<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属性とそのデフォルト値を示します。

\App_Config\Sitecore\JavaScriptServices\Sitecore.JavaScriptServices.Apps.configファイルのdefaults構成パッチでは、使用可能な属性の一部についてデフォルト値を検査できます。

先端

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

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

属性

使い

name

必須。アプリケーションの一意の名前。

sitecorePath

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

inherits

必須。指定されていない他の設定を継承するappを示します。継承は、複数のapp定義を通じてカスケードされます。

filesystemPath

JavaScriptレンダリングSDKアプリケーションのファイル システム デプロイ パス。package.jsonのsitecoreDistPathと一致する必要があります。

デフォルト： /dist/$name

serverBundle

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

デフォルト： server.bundle

importUser

インポート プロセス中に使用するSitecoreユーザー アカウント。ユーザーアカウントを指定すると、セキュリティとワークフローを使用してインポートのアクションを制限できます。

デフォルト： sitecore\JssImport

importLanguage

インポート中に使用するSitecoreフォールバック言語ifマニフェストにlanguage値が含まれていない。

デフォルト： 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 configセクションで設定されたIDatasourceStrategyの名前を参照する必要があります。

デフォルト： preferRouteLevel

analyzeAllowedControls

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

デフォルト： true

dictionaryDomain

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

デフォルト: (なし)

dictionaryPath

現在のアプリの辞書ドメイン項目の項目パスまたはGUID。パスが存在しない場合は、インポートプロセス中に、祖先フォルダも含めて作成されます。インポート・サービスは、ディクショナリ・ドメインを作成し、このロケーションにディクショナリ・エントリをインポートします。

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

layoutServiceConfiguration

統合モードのアプリレンダリング用の名前付きレイアウトサービス設定の名前。統合モードで実行されていない場合、アプリはこの構成を明示的に参照する必要があります。

取り得る値: jss, default

デフォルト： jss

メモ

通常、Sitecore Layout Service RESTリクエストにはjss設定を使用し、Experience Edge for XM GraphQクエリにはdefault設定を使用します。

言語の指定は、すべてのEdgeクエリで必要です。Edge GraphQLスキーマに対して統合GraphQLクエリを使用する場合、default構成により、すべてのクエリに $language値が挿入されます。 jss構成では言語の値は提供されないため、バージョン18.0.0との下位互換性が維持されます。

graphQLEndpoint

統合されたGraphQLクエリを有効にします。統合GraphQLを使用していない場合は、この属性を削除または省略できます。

serverSideRenderingEngine

Sitecoreに、JSSアプリのサーバー側でレンダリングするときに使用する レンダリング エンジン を指示します。

可能な値: nodejsおよびhttp。

デフォルト： nodejs

serverSideRenderingFunctionName

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

serverSideRenderingEngineの値をnodejsに設定した場合のみ関連します。

デフォルト： renderView

serverSideRenderingEngineEndpointUrl

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

serverSideRenderingEngineの値をhttpに設定した場合のみ関連します。

デフォルト: ""

serverSideRenderingEngineApplicationUrl

レンダリングされたHTML内の相対リンクの絶対リンクを作成するためのURLを定義します。これは、エクスペリエンス エディターに必要です。指定しない場合 (デフォルト)、インポート プロセスはserverSideRenderingEngineEndpointUrlからホスト名を抽出します。

serverSideRenderingEngineの値をhttpに設定した場合のみ関連します。

デフォルト: ""

serverSideRenderingEngineEditOnly

外部レンダリング ホストを使用する場合、Sitecoreが非APIルートへのリクエストを処理する必要があるかどうかを制御します。

デフォルト: true。

大事な

エクスペリエンス エディターの探索モードを使用するには、値をfalseに変更する必要があります。

deploymentSecret

アプリのインポート共有シークレットを構成します。

シークレットはランダムに生成された32+文字である必要があり、JSSアプリのscjssconfig.jsonのシークレットと一致する必要があります。

デフォルト: (なし)

手記

Sitecore優先開発ワークフローを使用する場合、deploymentSecretを設定する必要はありません。

大事な

このシークレットをソース管理にコミットしないでください。すべての環境で一意のシークレットを使用します。このシークレットを所有すると、Sitecoreアイテムを管理的に作成および変更できるようになります。

debugSecurity

セキュリティ デバッグを有効/無効にするブール値。共有シークレットのサーバー側処理に関する詳細をログに記録するために、アプリのインポート接続に問題がある場合はtrueに設定します。 Do not use unless debugging a connection issue.これをCLIフラグと一緒に使用して --debugSecurityクライアント側のセキュリティ問題を診断します。

デフォルト： false

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

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