Search search pipelines

Search Pipeline

• Configured Commerce uses Elasticsearch version 5.5 (Nest5) for search functionality on customer storefronts.
• The pipelines outlined apply only to Elasticsearch version 5.5 (Nest5).
• If upgrading to or using Elasticsearch version 7.10 (Nest7), refer to the Third-party search pipelines.

CategoryIndexerPipeline

• CreateElasticsearchCategory: This pipe creates a new ElasticsearchCategory object using the fields from the parameter object and assigns it to result.ElasticsearchCategory.
• GetIndexableCategoriesQuery: This pipe creates an Entity Framework Category query using the parameter object's fields and assigns it to result.IndexableCategories.
• MapElasticSearchCategoryCustomProperties: This pipe sets result.Property to a new Nest TextProperty if the parameter.SearchBoost.IsQueryable and parameter.PropertyDefinition.IsCustomProperty are both true.

CategorySearchPipeline

• InitializeSearchProperties: Retrieves the current SiteContext, ElasticsearchIndex, and ElasticsearchQueryBuilder and assigns them to the result object. The cache key is based on "CategorySearchDisallowedCategories + ".
• FormCategoryExcludeFilter: Uses the result.DisallowedCategories list to filter out categories generated during the FormCategoryExcludeList pipe processing.
• FormLanguageFilter: Uses result.SiteContext.LanguageDto to filter search results to a specific LanguageCode. If this pipe isn't processed, it will include results from all languages.
• FormWebsiteFilter: Uses result.SiteContext.WebsiteDto to filter search results to a specific Website. If result.SiteContext.WebsiteDto is null, it will cause a Pipeline exception/error.
• FormTypeFilter: This pipe adds a Query Filter for 'type' equaling 'category' if Parameter.AddTypeFilter is true.
• CombineFilters: This pipe combines all the filters in result.AllFilters into a single SearchQuery with an Operation of 'And' and sets the query to result.CombinedFilter. If no filters are found, result.CombinedFilter will be set to null.
• FormMainSearchQuery: This pipe creates a SearchQuery from result.CategorySearchFields against the parameter.Criteria query value for a MultiMatchQuery & MultiMatchPrefixQuery search type.
• FormFuzzySearchQuery: This pipe creates a SearchQuery from result.CategorySearchFields against the parameter.Criteria query value for a MultiMatchFuzzyQuery search type.
• CombineQueries: Combines all the queries in result.AllQueries into a single SearchQuery with an Operation of 'Or' and sets the query to result.CombinedQuery.
• ApplyQueryAndFilter: Creates a FunctionScoreQuery attaching as a new SearchDescriptor. The Score Function is for the Boost Field with a FunctionBoostMode.Multiply boost function.
• ProcessSearchResponse: If the result.SearchResponse.Aggregations does not contain PerformSearch.ContentAggregationKey, continues to the next pipe. Selects from PerformSearch.ContentAggregationKey Items, any PerformSearch.TopHitsAggregationKey using the parameter.SearchContentMapper.ToContentSearchResultDto to create new ContentSearchResultDto, and assigns the resulting collection to result.ContentSearchResults.
• ProcessSearchResponseForAllAggregations: If the result.SearchResponse.Aggregations does not contain PerformSearch.ContentAggregationKey, continues to the next pipe. Selects from result.SearchResponse.Aggregations all PerformSearch.TopHitsAggregationKey using the parameter.SearchContentMapper.ToContentSearchResultDto to create new ContentSearchResultDto, and assigns the resulting collection to result.ContentSearchResults.
• ProcessSearchResponseFromResult: If result.ContentSearchResults is empty, continues to the next pipe. Selects from result.SearchResponse.Hits all not null using the parameter.SearchContentMapper.ToContentSearchResultDto to create new ContentSearchResultDto, and assigns the resulting collection to result.ContentSearchResults.

FormProductIdFilter

• Makes a FieldQuery for each product in parameter.ProductSearchParameter.ProductIds against the ISearchProductObject.ProductId field, combines them into a BooleanQuery using the Operation.Or, assigns it to result.ProductIdFilter, and adds result.ProductIdFilter to result.AllFilters.
• If parameter.ProductSearchParameter.ProductNames is null or empty, continues to the next pipe.

FormProductNameFilter

• Makes a FieldQuery for each product in parameter.ProductSearchParameter.ProductNames against the ISearchProductObject.Name field, combines them into a BooleanQuery using the Operation.Or, assigns it to result.ProductNameFilter, and adds result.ProductNameFilter to result.AllFilters.
• If parameter.ProductSearchParameter.ProductErpNumbers is null or empty, continues to the next pipe.

FormProductErpNumberFilter

• Makes a FieldQuery for each product in parameter.ProductSearchParameter.ProductErpNumbers against the ISearchProductObject.ErpNumberSort field, combines them into a BooleanQuery using the Operation.Or, assigns it to result.ProductErpNumberFilter, and adds result.ProductErpNumberFilter to result.AllFilters.

CombineFilters

• Makes a BoolQuery with the Operation.And of all filters in result.AllFilters and assigns it to result.CombinedFilter or null if filters are empty.

GetRestrictionGroupFilter

• Attempts to retrieve the Restriction Group filter from the IPerRequestCacheManager cache based on parameter.SiteContext.BillTo.Id and parameter.SiteContext.ShipTo.Id, and assigns it to result.RestrictionGroupFilter.
• If parameter.ProductLinesEnabled is true and has result.BrandSearchResult.Brands that do not have a blank 'ProductLineName', orders result.BrandSearchResult.Brands using OrderByDescending by 'Score'.
• If the prior checks pass, fall back to sorting by Score for the parameter.MaximumNumber. Then set brand results to result.BrandSearchResult.Brands.
• If parameter.Criteria is null, result.BrandSearchResult?.Brands is null, or result.BrandSearchResult.Brands all ProductLineNames are empty, continue on to the next pipe.

ProcessProductLines

• Creates a queryWords variable by splitting parameter.Criteria by ' ' (Space).
• Nulls the ProductLineId, ProductLineName and ProductLineUrlSegement fields on result.BrandSearchResult.Brands for the brand results that don't match any queryWords to 'ProductLineName'.
• Also, nulls the fields if parameter.ProductLinesEnabled is not true.
• Using result.BrandSearchResult.Brands group by 'Id' and 'ProductLineId', selects the first group and taking parameter.MaximumNumber, then assigns it to result.BrandSearchResult.Brands. This removes duplicates.

RunProductFacetSearch

• InitializeSearchProperties: Uses Dependency Injection to attach ProductSearchFacetProcessor, and SearchGeneralSettings, then assign them to the result object. Sets the IndexType, SearchClient, and SearchQueryBuilder from the parameter to the result.
• FormProductFilter: This pipe uses the FormProductFilter pipeline to get the product filter and assign it to result.FormProductFilterResult.
• FormBrandStartsWithFilter: If parameter.ProductFacetSearchParameter.BrandStartsWith is blank, continue on to the next pipe.

This quiz explores the search pipelines configured for Elasticsearch version 5.5, specifically focusing on the CategoryIndexerPipeline and CategorySearchPipeline. Test your knowledge on the functionalities and properties involved in creating and customizing Elasticsearch categories and search queries.