Lately I had some requirements, where I get in conflict with the search criteria settings of the sites within a tenant.<\/p>\n\n\n\n
One task was to create a fulltext search for every SINGLE<\/strong> site within the tenant.<\/p>\n\n\n\n I thought that this should be an easy task in SXA:<\/p>\n\n\n\n It worked within minutes!<\/strong><\/p>\n\n\n\n Another task was to grab all news items on a news overview page from ALL<\/strong> sites within the tenant. There was a seperate search scope to query these news items as well.<\/p>\n\n\n\n What to do now? Changing the “Associated Content”<\/strong> field to the “tenant”<\/strong> item works fine. I got all the news items from all sites, but my fulltext search also displayed pages from other sites \u2013 which it was not supposed to.<\/p>\n\n\n\n There are a few options to fix this, but first I set up the “Associated Content”<\/strong> field to the “tenant”<\/strong> item. And that’s really where this topic begins, because no out-of-the-box solution fits my needs (please feel free to correct me if I’m wrong!)<\/em>.<\/p>\n\n\n\n I had to make a decision here on how to proceed. I considered 3 options:<\/p>\n\n\n\n More options are really appreciated \u2013 if there are any \u2013 because we are in a multisite environment and the search scopes live within a shared site.<\/p>\n\n\n\n After a bit more research and careful investigating, I decided to go with the custom search query token.<\/p>\n\n\n\n Oh, I promised you an easy solution, but already wrote so much. Sometimes I just want to share the background or the challenge of a task as well! Bear with me, we’ll get to the juicy part now!<\/p>\n\n\n\n Call it for example “My.Foundation.Search”<\/strong><\/p>\n\n\n\n The processor is located in the “Sitecore.XA.Foundation.Search.Pipelines.ResolveSearchQueryTokens”<\/strong>-Namespace, it looks like:<\/p>\n\n\n\n It was not easy to find the right processor, because the token is called “UnderCurrentPage”<\/strong>, but the class is called “CurrentLocation”<\/strong>.<\/p>\n\n\n\n But as you can see this is very similar to my requirement. There is a context item, but I need the “Home Item”<\/strong> of this context item, so I have to do some adjustments.<\/p>\n\n\n\n Paste the code of the original processor and name it “CurrentHomeItem”<\/strong>, adjust your namespace for example “My.Foundation.Search.Pipelines.ResolveSearchQueryTokens”<\/strong><\/p>\n\n\n\n First of all, change the TokenKey value. In my case I took “UnderCurrentHomeItem”<\/strong><\/p>\n\n\n\n So what kind of magic should happen now? DotPeek magic for sure!<\/strong> Inject the interface into your class:<\/p>\n\n\n\n\n
Three roads lead to Rome<\/h2>\n\n\n\n
\n
How to create a Custom Search Query Token with Sitecore SXA<\/h2>\n\n\n\n
1. Create a new Visual Studio Project<\/h4>\n\n\n\n
2. Copy the “CurrentLocation”-Processor<\/h4>\n\n\n\n
using Sitecore.ContentSearch.Utilities;\nusing Sitecore.XA.Foundation.Search.Attributes;\n\nnamespace Sitecore.XA.Foundation.Search.Pipelines.ResolveSearchQueryTokens\n{\n public class CurrentLocation : ResolveBasicSearchQueryTokens\n {\n [SxaTokenKey]\n protected override string TokenKey\n {\n get\n {\n return \"UnderCurrentPage\";\n }\n }\n\n protected override void ProcessModel(\n SearchStringModel model,\n ResolveSearchQueryTokensEventArgs args)\n {\n model.Type = \"location\";\n model.Value = args.ContextItem.ID.ToString();\n }\n }\n}\n<\/code><\/pre>\n\n\n\n3. Create a class within your project<\/h4>\n\n\n\n
4. Change the TokenKey<\/h4>\n\n\n\n
5. Do the “magic”<\/h4>\n\n\n\n
Also difficult to find if you are not used to working in a multisite environment. If you did, you must have already seen the “IMultisiteContext”<\/strong> interface, it’s a true gem!<\/p>\n\n\n\nprivate readonly IMultisiteContext _multiSiteContext;\n\npublic CurrentHomeItem(IMultisiteContext multiSiteContext)\n{\n _multiSiteContext = multiSiteContext ?? throw new ArgumentNullException(nameof(multiSiteContext));\n}\n<\/code><\/pre>\n\n\n\n
![\"QueryBuilder\"\/](\"https:\/\/mmmake.com\/wp-content\/uploads\/2020\/06\/QueryBuilder.jpg?la=de-de\")
<\/figure>\n\n\n\n![\"Search](\"https:\/\/mmmake.com\/wp-content\/uploads\/2020\/06\/SearchResultScope.jpg\")
<\/figure>\n\n\n\n![\"Dirk](\"https:\/\/mmmake.com\/wp-content\/uploads\/2020\/06\/dirk-autor.png?h=100&w=100\")
![\"Dirk](\"https:\/\/mmmake.com\/wp-content\/uploads\/2020\/06\/linkedin-logo-75x30-1.jpg\"){kind=logo}
<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"