1. 構成

Sitecore Commerce Engine Connectの設定

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

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

Sitecore.Commerce.Engine.Connect.configファイルには、Commerce Engine (CE) Connectの動作に影響を与える構成設定が含まれています。CE Connectは、C# クラスによって定義されたコネクタで、Sitecore Commerce EngineとSitecore Commerce Connect (ストアフロント開発者向けにAPIを公開するコアSitecore XP Commerceフレームワーク) の統合を可能にします。

Sitecore.Commerce.Engine.Connect.configファイルは、Sitecoreサービス インスタンス (スタンドアロン、ContentDelivery、またはContentManagementロールとして実行) の \inetpub\wwwroot\<Sitecore>\App_Config\Include\Y.Commerce.Engineに保存されます。

このトピックでは、Sitecore.Commerce.Engine.Connect.configファイルの各セクションに含まれるCE Connect構成設定をリストし、説明します。

メモ

一覧表示されている既定値は、サンプルCommerceソリューションをインストールして配置するときに使用される値を表します。

Commerce Engineの設定

Sitecore.Commerce.Engine.Connect.configファイルの <commerceEngineConfiguration> セクションには、次の構成設定があります。

CE Connectコネクタの一般的な設定

設定

既定値

形容

shopsServiceUrl

https://localhost:5000/api/

Shopsサービスを実行しているCommerce EngineインスタンスのURL。

commerceOpsServiceUrl

https://localhost:5000/commerceops/

Commerce Opsサービスを実行しているCommerce EngineインスタンスのURL。

commerceMinionsServiceUrl

https://sxastorefront-identityserver

Commerce Minionsサービスを実行しているCommerce EngineインスタンスのURL。

commerceEngineConnectClientId

CommerceEngineConnect

Commerce Engine Connectクライアントの名前。

clientSecretHash

<SecretHashValue>

Identity Serverへの認証とセキュリティ トークンを取得するためにクライアントIDと共に使用されるハッシュ。その後、Connectはトークンを使用してCEへの認証を行います。

commerceRequestTimeout

210

Commerce EngineへのHttpWebRequest呼び出しを行うときにHttpWebRequest.Timeoutプロパティを設定するために使用される値 (秒単位)。

手記

commerceRequestTimeoutの値は秒単位で設定され、HttpWebRequest.Timeoutプロパティの値はミリ秒単位で設定されます。

enforceSsl

true

SSLを使用した安全な接続を強制します。

defaultEnvironment

HabitatAuthoring

HTTPリクエストヘッダー"Environment"でターゲット環境が指定されていない場合に、HTTPリクエスト(InvokeHttpClientGetやInvokeHttpClientPostなど)でデフォルトで使用するコマース環境。

defaultMinionsEnvironment

HabitatMinions

デフォルトのミニオン環境の名前を指定します。

DefaultLanguage

en

HTTP要求ヘッダーで言語が指定されていない場合に使用されるデフォルトの言語。

defaultShopName

CommerceEngineDefaultStorefront

HTTPヘッダー "ShopName" で値が指定されていない場合にデフォルトで使用されるストアフロント。

defaultShopCurrency

USD

HTTPヘッダー "Currency" で値が指定されていない場合に使用されるデフォルトの通貨です。

カタログマッピング設定

設定

既定値

形容

getCatalogMappingsForIdsBatchSize

20

カタログ・マッピングをロードするときに一度にフェッチするIDの数。

カタログ テンプレート フィールド ジェネレーター設定

設定

既定値

形容

useDeterministicFieldIdsForEntities

true

エンティティ テンプレート フィールドの決定論的フィールド識別子を生成するかどうかを制御します。Commerce Engineでは、この設定をtrueに設定して、フィールドへのパスに基づくアルゴリズムを使用してGUIDが生成され、GUIDが同じままになるようにする必要があります。

useDeterministicFieldIdsForComponents

true

コンポーネント・テンプレートの確定的フィールド識別子を生成するかどうかを制御します。Commerce Engineでは、この設定をtrueに設定して、フィールドへのパスに基づくアルゴリズムを使用してGUIDが生成され、GUIDが同じままになるようにする必要があります。

コマースオーサリング環境設定

設定

既定値

形容

defaultAuthoringDatabase

Master

Commerceエンティティのバージョンを返すために使用するデータベースを指定します。マスター データベースには、公開済みバージョンと未公開バージョンの両方が含まれています。Webデータベースには、公開されたバージョンのコンテンツが含まれています。

インデックス作成設定

設定

既定値

形容

fullIndexWaitTime

1000

ItemFullIndexMinionコマンド (長時間実行されているプロセス) のステータスを確認する前に待機するミリ秒数を表します。

incrementalIndexWaitTime

100

インクリメンタル・インデックス・コマンド (長時間実行プロセス) のステータスを確認するまでに待機するミリ秒数を表します。

fullCacheRefreshThreshold

20

インクリメンタル・インデックス作成後にフル・キャッシュ・リフレッシュをトリガーするインデックスを作成する新規または変更されたアイテムの数。

CE Connectキャッシング構成

Sitecore.Commerce.Engine.Connect.configファイルの <commerceCachingConfiguration> セクションには、次のキャッシュ設定が含まれています。

Redisキャッシュ設定

設定

既定値

形容

enabled

true

CE ConnectキャッシュのRedisキャッシュ プロバイダーを有効または無効にします。

cacheStoreName

Commerce-Connector-Redis

Commerce ConnectorのRedisキャッシュ ストアの名前。

intervalBetweenConnectionAttemptsInSeconds

60

Redisキャッシュ プロバイダーへの接続を試行する間隔の秒数。

redisConnectionPoolSize

1

プール内のRedisへの接続数。

redisCompressionEnabled

true

Redisプロバイダーがキャッシュ データを圧縮するかどうかを制御します。

configuration

localhost,

defaultDatabase=1,

allowAdmin=true,

syncTimeout=3600000

Redis構成オプション。

instanceName

Redis(レディス)

Redisインスタンスの名前。

メモリキャッシュ設定

設定

既定値

形容

enabled

false

インメモリ キャッシュを使用するかどうかを制御します。

cacheStoreName

Commerce-Connector-Memory

インメモリ キャッシュ ストアの名前。

cacheName

CommerceConnect

Commerce Connectキャッシュの名前。

expiration

21600000

項目がキャッシュされる秒数。

コマンド

次の表に、Sitecoreコンテンツ エディターのCommerceリボンからトリガーされるコマンドを示します。

コマンド名

形容

"commerce:generatecatalogdatatemplates"

カタログ・データ・テンプレートを生成します。コマンドはUpdate Data Templatesボタンで切り替えられます。

"commerce:deletecatalogdatatemplates"

カタログ・データ・テンプレートを削除します。 Delete Data Templatesボタンによってトリガーされるコマンド。

"commerce:refreshcache"

現在のSitecoreデータベース内の次のキャッシュをクリアします ( Refresh Commerce Cacheボタンによってトリガーされるコマンド)。

  • アイテムキャッシュ

  • データキャッシュ

  • StandardValuesCache (標準値キャッシュ)

  • パスキャッシュ

  • ItemPathsキャッシュ

  • TemplateEngineがリセットされます。

パイプライン

CE Connectコネクタは、Sitecoreパイプライン フレームワークによって提供される拡張性ポイントを活用して、Commerceコネクタ機能を実装します。名前に接頭辞commerceを使用するパイプラインは、CE Commerce機能のために完全に実装されます。その他のSitecoreパイプラインは、カスタムCommerceプロセッサで拡張されます。

パイプライン/プロセッサ

形容

commerce.viewaction.getentityview /

Sitecore.Commerce.Engine.Connect.Pipelines.ViewAction.GetEntityView

Commerce EngineからEntityViewを取得するために使用されるCE Connectパイプライン プロセッサ。

commerce.viewaction.doaction /

Sitecore.Commerce.Engine.Connect.Pipelines.ViewAction.DoAction

Commerce EngineからDoActionを取得するために使用されるCE Connectパイプライン プロセッサ。

getContentEditorFields /

Sitecore.Commerce.Engine.Connect.SitecoreDataProvider.Pipelines.ContentEditor.CommerceContentEditorFieldsProcessor

コンテンツ エディターでCommerceアイテムを表示するときにSitecoreによって呼び出されるCE Connectパイプライン プロセッサ。プロセッサは、このコンテンツ項目に対応するEntityViewから提供されたメタデータに基づいて、Commerceビューからフィールドを非表示にします。たとえば、Business Toolsのユーザー インターフェース (UI) で非表示になっているフィールドは、コンテンツ エディターのUIで同じアイテムを表示するときにも非表示にする必要があります。

renderContentEditor /

Sitecore.Commerce.Engine.Connect.DataProvider.Pipelines.SetCommerceEditorFormatter

Sitecoreコンテンツ エディターのユーザー インターフェースでSitecore XCカタログを表示するためにSitecore XCカタログを表示するためにSitecore.Commerce.Engine.Connect.DataProvider.Pipelines.ContentEditor.CommerceEditorFormatter を使用するようにコンテンツ エディター フォーマッターを設定するために、Sitecoreプラットフォーム パイプラインに追加されたプロセッサ。

getQueryState /

Sitecore.Commerce.Engine.Connect.DataProvider.Pipelines.ContentEditor.CommandStateProcessor

Commerceアイテムに対して有効になっているコマンドを決定するSitecoreプロセッサ。

getContentEditorWarnings /

Sitecore.Commerce.Engine.Connect.Pipelines.ValidateToken

Sitecoreパイプラインを拡張して、CE ConnectがCommerce Engineに送信するセキュリティ トークンが無効である場合、またはSSLが有効になっていない場合に、コンテンツ エディターに警告を表示するプロセッサ。

getItemPersonalizationVisibility /

Sitecore.Commerce.Engine.Connect.Pipelines.PersonalizationVisibilityProcessor

関連するCommerceカタログ品目テンプレートから派生した品目のプロファイル カードを編集できるようにするパイプライン プロセッサ。

イベント

次の表に、CE Connectで生成できるイベントを示します。

イベント/ハンドラ/メソッド

形容

publish:itemProcessing /

Sitecore.Commerce.Engine.Connect.Events.CatalogPublishingExcluderEvent /

CheckProcessing

Sitecoreの公開プロセスでCommerceカタログ アイテムが公開されないようにします。カタログ アイテムは、承認ワークフローの終了として承認されると公開されます。

publish:end、publish:end:remote /

Sitecore.Commerce.Engine.Connect.Events.CommercePublishCacheRefresh /

ClearCache (両種目とも)

CommerceキャッシュがWebへの公開時に更新されるようにします。

saved、item:deleting /

Sitecore.Commerce.Engine.Connect.Events.CommerceItemEventHandler /

OnItemSaved, OnItemDeleting

変更されたアイテムをSitecoreキャッシュから削除します。

indexing:completed:remote /

Sitecore.Commerce.Engine.Connect.Events.IndexingCompletedEventHandler /

OnIndexingCompleted

インデックス作成の完了後にSitecoreキャッシュをクリアします。

フック

次のフックは、Sitecoreの初期化時に実行されます。

鉤

形容

Sitecore.Commerce.Engine.Connect.Events.IndexingCompletedHook

インデックス作成完了イベントをサブスクライブし、そのイベントをSitecore.Commerce.Engine.Connect.EventsIndexingCompletedEventHandlerハンドラに関連付けるために使用されます。

設定

Sitecore設定には、次の設定を適用するようにパッチが適用されます。

設定

形容

Sitecore.Services.SecurityPolicy

Sitecoreの設定は、Sitecore.Services.Infrastructure.Web.Http.Security.ServicesOnPolicyを使用してEntityとItemServicesへの安全なアクセスを許可するように修正されました。

サービス

次のコンフィギュレーターは、Sitecoreサービス コレクションを変更するために使用されます。

コンフィギュレーター

形容

Sitecore.Commerce.Engine.Connect.CachingConfigurator

Sitecoreサービス コレクション (Microsoft.Extensions.DependencyInjection.IServiceCollection) をSitecore.Commerce.Engine.Connect.CachingRepositoryを使用するように変更し、SitecoreをSitecore.Commerce.Engine.Connect.CommerceCacheOptionsSetupを使用するように設定するために使用されます。

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