{"id":1978,"date":"2015-03-31T23:08:55","date_gmt":"2015-03-31T21:08:55","guid":{"rendered":"http:\/\/www.itidea.nl\/?p=1978"},"modified":"2015-03-31T23:08:55","modified_gmt":"2015-03-31T21:08:55","slug":"creating-a-custom-multi-valued-refiner","status":"publish","type":"post","link":"https:\/\/www.itidea.nl\/index.php\/creating-a-custom-multi-valued-refiner\/","title":{"rendered":"Creating a custom multi-valued refiner"},"content":{"rendered":"

In one of my previous posts<\/a> I wrote about extending the content processing pipeline by developing a custom content enrichment service to modify the managed properties of the crawled items before they are added to the search index. This post is a kind of follow up on that.<\/p>\n

Suppose sites can be tagged by one or more terms. Users are able to set and modify these terms.<\/p>\n

On a page with a content search webpart and a refinement panel users can search content and use the refinement panel to find sites (also) tagged with these terms.<\/p>\n

These terms are stored in a propertybag, added to the indexed properties keys and exposed by a managed property.
\nThe propertybag values for three different sites are:<\/p>\n

\"CE2_Propertybag_Values\"<\/a><\/p>\n

To point some values out: The term ‘site02|..’ is used twice (at site 01 and site 02) and the term ‘site04|..’ is used once (at site 03).<\/p>\n

The managed property is added to the refinement panel and configured to use the multi-value refinement item display template.<\/p>\n

\"CE2_Original_ManagedProperty_In_RefinementPanel\"<\/a><\/p>\n

As you can see in the above image the managed property containing the terms isn’t really multivalued, because of the values of the propertybag are stored as a single string. Notice the missing ‘site04|…’ in the refinementpanel, which is present in the propertybag shown in the PowerShell image. Creating the managed property as a multivalued property won’t help you create a real multivalued property.<\/p>\n

A content search webpart in conjunction with this refinement panel will show only one site at the time when eg selecting ‘site02|..’ which is used twice and should result Site 01 and Site 02:<\/p>\n

\"CE2_Original_ContentSearch\"<\/a><\/p>\n

Refining results based on these values will only match sites when they are tagged with the same terms in the same order: the exact same string.<\/p>\n

A possible solution for this is to extend the content processing pipeline by a service. This service picks up the propertybag value and splits the values, in this case the terms, and inserts the separate values into the multivalued managed property.<\/p>\n

The basics of how to set up a custom content enrichment service is explained in the post ‘Issue sorting links and documents based on Title<\/a>‘<\/p>\n

Only the code for the service itself is shown. This is the service which accepts requests from the content processing component.<\/p>\n

\r\nprivate const string\r\nSiteTagProperty = "ITIdeaSiteTag";\r\n\r\nprivate const int UnexpectedType = 1;\r\nprivate const int UnexpectedError = 2;\r\nprivate readonly ProcessedItem processedItemHolder = new ProcessedItem\r\n{\r\n\u00a0\u00a0\u00a0 ItemProperties = new List<AbstractProperty>()\r\n};\r\n\r\npublic ProcessedItem ProcessItem(Item item)\r\n{\r\n\u00a0\u00a0\u00a0 processedItemHolder.ErrorCode = 0;\r\n\u00a0\u00a0\u00a0 processedItemHolder.ItemProperties.Clear();\r\n\u00a0\u00a0\u00a0 try\r\n\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/ Iterate over each property received and locate the property we configured the system to send.\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 foreach (var property in item.ItemProperties)\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 if (property.Name.Equals(SiteTagProperty, StringComparison.Ordinal))\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 var siteTag = property as Property<List<string>>;\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 if (siteTag != null && siteTag.Value != null && siteTag.Value.Count > 0)\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 string[] propValues = siteTag.Value.First().Split(';');\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 List<string> listpropValues = propValues.ToList();\r\n                    Property<List<string>> newSiteTagProp = new Property<List<string>>();\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 newSiteTagProp.Name = SiteTagProperty;\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 newSiteTagProp.Value = listpropValues;\r\n                    processedItemHolder.ItemProperties.Add(newSiteTagProp);\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 }\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 }\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 }\r\n\u00a0\u00a0\u00a0 }\r\n\u00a0\u00a0\u00a0 catch (Exception)\r\n\u00a0\u00a0\u00a0 {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 processedItemHolder.ErrorCode = UnexpectedError;\r\n\u00a0\u00a0\u00a0 }\r\n\u00a0\u00a0\u00a0 return processedItemHolder;\r\n}\r\n<\/pre>\n
The item.ItemProperties contain all the input properties received by the service. These input properties will be configured by PowerShell.
\nThe code checks if the ITIdeaSiteTag property contains multiple terms, splits it and adds it to a list of property values and returns the changed value to the content processing component.<\/p>\n
Configure the Search Service Application to use the Content Enrichment service by using PowerShell, for an example see this post<\/a>. Don’t forget to set a meaningful trigger otherwise every item will be passed this service.<\/p>\n
Run a full crawl.<\/p>\n
The refinement panel now shows a nice set of single values, notice the presence of ‘site04|..’ here:<\/p>\n
\"CE2_Enriched_ManagedProperty_In_RefinementPanel\"<\/a><\/p>\n
When using the refinement panel in conjunction with a content search webpart, two sites will be displayed when selecting e.g. ‘site02|..’ as expected:<\/p>\n
\"CE2_Enriched_ContentSearch\"<\/a><\/p>\n
 <\/p>\n
Summary<\/h3>\n
To make a multivalued propertybag a real multivalued managed property a custom content enrichment service can de developed to accomplish this.
\nAfter creating a multivalued managed property it can be used in e.g. a refinement panel.<\/p>\n
The intention of this post was purely to demonstrate the technique, no changes has been made to make things look pretty \ud83d\ude42<\/p>\n
Note<\/h4>\n
Only one custom content enrichment service can be bound to a Search Service Application.
\nIf you want more properties to be processed by the service you have to configure the InputProperties, OutputProperties and don’t forget the Trigger of the EnterpriseSearchContentEnrichmentConfiguration object to handle them all.<\/p>\n","protected":false},"excerpt":{"rendered":"
In one of my previous posts I wrote about extending the content processing pipeline by developing a custom content enrichment service to modify the managed properties of the crawled items before they are added to the search index. This post … Read More »<\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[35],"tags":[20,44],"class_list":["post-1978","post","type-post","status-publish","format-standard","hentry","category-sharepoint-2013","tag-c","tag-sharepoint-2013"],"_links":{"self":[{"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/posts\/1978","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/comments?post=1978"}],"version-history":[{"count":6,"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/posts\/1978\/revisions"}],"predecessor-version":[{"id":1989,"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/posts\/1978\/revisions\/1989"}],"wp:attachment":[{"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/media?parent=1978"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/categories?post=1978"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.itidea.nl\/index.php\/wp-json\/wp\/v2\/tags?post=1978"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}