構成

Sitecore Experience Commerce(サイトコアエクスペリエンスコマース)
コマースDevOps
構成
Commerce Engine 設定ファイル

Commerce Engine設定ファイル

Version:

日本語翻訳に関する免責事項

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

CommerceデプロイのCommerce Engine (CE) ロールの各インスタンスには、サービスアプリケーション構成を高レベルで定義する独自のconfig.jsonファイルがあります。

CE config.jsonファイルは、Commerce Engineアプリケーションのルートのwwwrootフォルダにあります (例: C:\inetpub\wwwroot\CommerceShops_Sc/wwwroot)。

メモ

config.jsonファイルに変更を加えた場合は、Commerce Engine config.jsonの操作に関するベストプラクティスに従っていることを確認してください。

このトピックでは、config.jsonファイルの各セクションで使用できるCommerce Engine構成設定の一覧と説明、Sitecore.Commerce.Engine.SDK.zipファイルに含まれるサンプルのCommerce Engineソリューションに基づく例を示します。

アプリケーション設定(AppSettings)
Azure Application Insightsの設定
ログ設定
Serilog設定
キャッシング設定
圧縮設定
Commerceコネクタの設定
ヘルスチェックの設定

手記

デフォルト値としてプレースホルダーを使用するパラメーター ( "PlaceholderForSiteTitle" など) は、環境変数ファイルを使用して設定できます。

アプリ設定

Commerce Engine config.jsonファイルのAppSettingsセクションには、アプリケーションの起動時に使用されるパラメータなど、アプリケーションレベルの設定が含まれています。

次に、"AppSettings" セクションの例を示します。

{
  "AppSettings": {
    "SiteTitle": "PlaceholderForSiteTitle",
    "BootStrapFile": "Global",
    "DeploymentId": "PlaceholderForDeploymentId",
    "EnvironmentName": "PlaceholderForEnvironmentName",
    "EncryptionProtectionType": "Redis",
    "EncryptionCertificateHash": "Enter a valid certificate thumbprint for a PXF file. X-509 not supported yet",
    "EncryptionSID": "Enter a valid SID for a domain registered user",
    "EncryptionKeyStorageLocation": "c:\\Encryption-Keys\\",
    "SitecoreIdentityServerUrl": "PlaceholderForSitecoreIdentityServerUrl",
    "AllowedOrigins": "PlaceholderForBizFxUrl|PlaceholderForSxaStorefrontUrl",
    "AntiForgeryEnabled": "PlaceholderForAntiForgeryEnabled",
    "CommerceServicesHostPostfix": "PlaceholderForCommerceServicesHostPostfix",
    "UseHttpsInKestrel": false,
  },

アプリケーション設定の説明

次の表では、AppSettingsセクションで使用できる設定パラメータについて説明します。

パラメーター	形容
"SiteTitle"	IISマネージャーに表示されるWebサイトの名前。デフォルト： "PlaceholderForSiteTitle"
"BootStrapFile"	アプリケーションの起動時にロードされるグローバル環境設定を含むJSONファイルの名前。デフォルトでは、これはGlobal.jsonファイルです。デフォルト： Global
"DeploymentId"	Microsoft Azureデプロイで自動的に割り当てられる番号 (GUID)。デフォルト： "PlaceholderForDeploymentId"
"EnvironmentName"	アプリケーションの起動時に開始するCommerce環境の名前。デフォルト： "PlaceholderForEnvironmentName"
"EncryptionProtectionType"	暗号化キーに使用されるストレージのタイプ。デフォルト: "Redis" キャッシュキーは、分散アプリケーションのRedisキャッシュに保存されます取り得る値は、"DPAPI-SID"、"DPAPI-CERT"、"LOCAL"、"MACHINE"です。
"EncryptionCertificateHash"	"EncryptionProtectionType": "DPAPI-CERT"を使用する場合のPXFファイルの有効な証明書の拇印。
"EncryptionSID"	ドメイン登録ユーザーの有効なSID (使用時の "DPAPI-CERT""EncryptionProtectionType": DPAPI-SID
"EncryptionKeyStorageLocation"	"EncryptionProtectionType": "MACHINE"を使用する場合に暗号化キーを保存する場所へのパス。デフォルト: "c:\\Encryption-Keys\\" ?
"SitecoreIdentityServerUrl"	Sitecore IdentityサーバーのURL。デフォルト： "PlaceholderForSitecoreIdentityServerUrl"
"AllowedOrigins"	クロスオリジン呼び出しを許可する必要があるURLのリスト (Business ToolsのURLやストアフロントのURLなど)。デフォルト： "PlaceholderForBizFxUrl\|PlaceholderForSxaStorefrontUrl"
"AntiForgeryEnabled"	偽造防止を有効にするかどうか(ブール値)。デフォルト： "PlaceholderForAntiForgeryEnabled"
"CommerceServicesHostPostfix"	Postfixは、Commerceサービスのホスト名として追加するルートドメイン名(2レベル)として使用されます。デフォルト： "PlaceholderForCommerceServicesHostPostfix"
"UseHttpsInKestrel"	ASP.NET Coreプロジェクトテンプレートに既定で含まれるKestrel WebサーバーでHttpsを使用するかどうか (ブール値)。デフォルト： "false" 手記この設定は、開発環境で使用されます。

Azure Application Insights

Commerce Engineのconfig.jsonファイルのApplication Insightsセクション ("ApplicationInsights") では、Commerce Engineのパフォーマンス監視とテレメトリのインストルメンテーションキーを構成できます。

  "ApplicationInsights": {
    "InstrumentationKey": "",
  },

Azure Application Insightsパラメーターの説明

次の表では、"ApplicationInsights" セクションのパラメーターについて説明します。

パラメーター	形容
"InstrumentationKey"	Microsoft Azureリソースで実行されているCommerce Engineを監視するために生成されたAzure Application Insightsインストルメンテーションキー。デフォルト： no default

パラメーター

形容

"InstrumentationKey"

Microsoft Azureリソースで実行されているCommerce Engineを監視するために生成されたAzure Application Insightsインストルメンテーションキー。

デフォルト： no default

伐採

Commerce Engine config.jsonのログセクションには、アプリケーションのログレベルを制御したり、診断目的でCommerce Engineのパイプライントレースログを制御できるパラメータが含まれています。

{ 
  "Logging": {
    "IncludeScopes": false,
    "LogLevel": {
      "Default": "Warning",
      "System": "Warning",
      "Microsoft": "Warning"
      },
    "SerilogLoggingEnabled": true,
    "PipelineTraceLoggingEnabled": false
  }

ロギング・パラメーターの説明

次の表では、ログセクションのパラメーターについて説明します。

パラメーター	形容
"IncludeScopes"	スコープを使用する必要があるかどうか。デフォルト： false
次の各カテゴリについてキャプチャする "LogLevel" の重大度:
"Default"	デフォルトのログカテゴリでキャプチャするログレベル: デフォルト： "Warning"
"System"	システムログカテゴリでキャプチャするログレベル。デフォルト： "Warning"
"Microsoft"	Microsoftログカテゴリでキャプチャするログレベルデフォルト： "Warning"
"PipelineTraceLoggingEnabled"	パイプライントレースが有効になっているかどうか。デフォルト： false
"SerilogLoggingEnabled"	Serilogログが有効になっているかどうか。デフォルト： true

セリログ

Serilogセクションには、ログ記録レベルを設定するために使用できるSerilogログ記録フレームワークの設定が含まれています。

  "Serilog": {
    "Using": [
       "Serilog.Sinks.Literate",
       "Serilog.Sinks.File"],
       "Serilog.Sinks.ApplicationInsights"
       ]
    "MinimumLevel":  {
       "Default": "Warning",
       "Override": {
          "Microsoft": "Warning",
          "System": "Warning"
          }
    "WriteTo": [
       {
        "Name":  "ApplicationInsights",
        "Args":  {
            "restrictedToMinimumLevel":  "Warning",
            "telemetryConverter": "Serilog.Sinks.ApplicationInsights.Sinks.ApplicationInsights.TelemetryConverters.TraceTelemetryConverter, Serilog.Sinks.ApplicationInsights"
            }
         },
    "FileSizeLimitBytes": 100000000
  },

Serilogパラメータの説明

Serilog Wikiでは、前のコードサンプルで使用したSerilog構成設定について説明します。

キャッシング

Commerce Engine config.jsonファイルの "Caching" セクションには、Commerce Engineが使用するキャッシュプロバイダーを指定する設定が含まれています。

手記

メモリキャッシュプロバイダーはSitecore XC 10.2で廃止され、今後のリリースで削除される予定です。代わりにRedisキャッシュを使用してください。

"Caching":  {
   "Memory":  {
      "Enabled":  false,
      "CacheStoreName":  "Commerce-Memory-Store"
      },
   "Redis":  {
      "Enabled":  true,
      "CacheStoreName":  "Commerce-Redis-Store",
      "Options":  {
          "Configuration":  "PlaceholderForRedisConfiguration",
          "InstanceName":  "PlaceholderForRedisInstanceName"
          }
      }
 },

キャッシング・パラメーターの説明

次の表では、キャッシュパラメーターについて説明します。

パラメーター	形容
"Memory" キャッシュ・プロバイダ・パラメータ: 手記メモリキャッシュプロバイダーは開発環境にのみ適しており、運用環境には使用しないでください。Redisキャッシュプロバイダーは、運用環境のデプロイに推奨されます。手記メモリキャッシュプロバイダーはSitecore XC 10.2で廃止され、今後のリリースで削除される予定です。代わりにRedisキャッシュを使用してください。
"Enabled"	インメモリキャッシングを使用するかどうかを指定します。デフォルト: "false"。
"CacheStoreName"	メモリキャッシュプロバイダが使用するキャッシュストアの名前。デフォルト： "Commerce-Memory-Store"
"Redis" キャッシュ・プロバイダ・パラメータ:
"Enabled"	インメモリキャッシングを使用するかどうかを指定します。デフォルト： "true"
"CacheStoreName"	Redisキャッシュストアの名前。デフォルト： "Commerce-Redis-Store"
"Configuration"	Redisへの接続に使用する構成。デフォルト： "PlaceholderForRedisConfiguration"
"InstanceName"	Redisインスタンス名。デフォルト： "PlaceholderForRedisInstanceName"

圧縮

"Compression" セクションには、応答の圧縮を制御する構成パラメーターが含まれています。次に、"Compression" セクションの例を示します。

 "Compression": {
   "Enabled": true,
   "ResponseCompressionOptions": {
      "EnableForHttps": true,
      "MimeTypes": [
        "text/plain",
        "text/css",
        "application/javascript",
        "text/html",
        "application/xml",
        "text/xml",
        "application/json",
        "text/json",
        "application/wasm"
      ]
   },
   "GzipCompressionProviderOptions": {
      "Level": "Fastest"
      }
   },

圧縮パラメータの説明

次の表では、圧縮パラメータについて説明します。

パラメーター	形容
"Enabled"	圧縮を有効にするか無効にするかを制御します。デフォルト： true
"ResponseCompressionOptions":
"EnableForHttps"	安全な接続で応答を圧縮します。デフォルト： true
"MimeTypes"	圧縮用のMIMEタイプのセットをリストします: "text/plain"、"text/css"、"application/javascript"、"text/html"、"application/xml"、"text/xml"、"application/json"、"text/json"、"application/wasm"
GzipCompressionProviderOptions:
"Level"	圧縮レベルを設定します。デフォルト： "Fastest"

コマースコネクタ

CommerceConnectorセクションには、Commerce Engine ConnectクライアントのIDを指定する "ClientId" パラメータが含まれています。デフォルトは "PlaceHolderForCommerceEngineConnectClientId"です。

"CommerceConnector": {
  "ClientId": "PlaceHolderForCommerceEngineConnectClientId"
}

ヘルスチェック

ASP.NET Coreに基づくHealthCheckサービスでは、デプロイされたロールの正常性状態を取得できます。

"HealthCheck":  {
    "Enabled":  true,
    "URL":  "/health"
   }

ヘルスチェックパラメータの説明

パラメーター	形容
"Enabled"	HealthCheckサービスを有効にするかどうかを指定します。
"URL"	アプリケーションエンドポイントのURL。

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