Sitecore.Commerce.Plugin.Search.AbstractAsyncIndexFieldHandlerクラス

Version:

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

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

Sitecore.Commerce.Plugin.Search.AbstractAsyncIndexFieldHandlerクラスは、パイプラインを呼び出すことができる非同期のCompose Valueメソッド (ComposeValueAsyncメソッド) を実装する検索フィールドハンドラーを定義します。この基本フィールドハンドラークラスをカスタムフィールドハンドラーで使用できるのは、リアルタイムのフィールド値をインデックス化する必要がある場合の例外的なケースです。

Commerce Engineは、デフォルトではこのインデックスフィールドハンドラを使用しません。標準で提供されているデフォルトのインデックスフィールドハンドラーは、Sitecore.Commerce.Plugin.Search.AbstractIndexFieldHandlerクラスに基づいています。

大事な

パイプラインを非同期に呼び出すインデックスフィールドハンドラーは、特に大規模なカタログやマッピングテーブルを使用するデプロイで、インデックス作成のパフォーマンスに悪影響を与える可能性があります。可能な限り、カスタムフィールドハンドラにAbstractIndexFieldHandlerクラスを使用することをお勧めします。

次に、Sitecore.Commerce.Plugin.Search.AbstractAsyncIndexFieldHandlerの例を示します。

using System.Collections.Concurrent;
using System.Threading.Tasks;
namespace Sitecore.Commerce.Plugin.Search
{
    /// <summary>
    /// Defines the abstract asynchronous index field handler.
    /// </summary>
    public abstract class AbstractAsyncIndexFieldHandler
    {
        /// <summary>
        /// Composes the field value to be used in the index
        /// </summary>
        /// <param name="source">The source for the value</param>
        /// <param name="context">The context</param>
        /// <returns>The value of the field to be use in the index</returns>
        public abstract Task<object> ComposeValueAsync(object source, ConcurrentDictionary<string, object> context);
    }
}

メモ

Sitecore.Commerce.Engine.SDKには、ComposeValueAsyncメソッドを使用してパイプラインを呼び出す方法を示すサンプルParentCategoryDisplayNameHandlerフィールドハンドラーが含まれています。サンプルハンドラークラスは、Customer.SampleSolutionファイルのscr/Plugin.Sample.Habitat/Searchフォルダーにあります。

Sitecore.Commerce.Plugin.Search.AbstractAsyncIndexFieldHandlerクラスでは、次のようになります。

ComposeValueのsource引数は、処理中のエンティティへのアクセスを提供します。

contextディクショナリには、エンティティの階層的な場所、言語、エンティティが属するカタログ、現在の言語などに関する詳細情報が表示されます。次の表に、キーと値の説明を示します。

鍵	価値
CommerceContext	現在の環境に関する情報を提供するコマースコンテキスト。
SitecoreItemSearchScopePolicy	検索スコープ・ポリシーは、ターゲット・インデックスに関する情報を提供します。
LanguageCode	言語コード。
Parent	直接の親エンティティのID。
MappedCatalog	このエンティティが属するカタログに関する高レベルの情報を提供します。
EntityHierarchy	アイテムに関する階層情報。指定されたアイテムへのパス全体へのアクセスを提供します。
IndexingOptions	現在のインデックス作成操作に関する情報。ターゲット・データベース名へのアクセスを提供します。
DeterministicId	データプロバイダーでSitecoreアイテムIDとしても使用されるエンティティの一意のID。

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