Office 365 & SharePoint Search / Development / Branding

Highlight on-premises search results in your hybrid configuration

on Feb 02, 2016 by Elio Struyf with no comments

Last week I finally found some time to get my demo tenant up and running with hybrid search configuration. The new hybrid search experience eliminates the need of the result block. All results are aggregated together right now. So that means if you do a search query, you could get SharePoint Online results and on-premises results.

Important: There are some disadvantages about using hybrid search. Mikael Svenson wrote an article about it which talks about them and made a checklist to see if hybrid search is good to implement in your environment: Why Hybrid Crawl in SharePoint is a cold hot potato.

Default hybrid search behaviour

Default hybrid search behaviour

Note: first result is from SharePoint Online, the other two is from my on-premises environment.

This is a great step forward, but what if you can only access your on-premises content via the corporate network or VPN?

That would expect from your users that they have to check the path of the content to where it leads. This is not ideal, so a better solution would be to highlight the on-premises or external (yes, on-premises content is seen as external content for Office 365) content in your search center like this:

Hybrid search with on-premises/external content highlighting

Hybrid search with on-premises/external content highlighting

Notification text on VPN icon

Notification text on VPN icon

In the above screenshots you can see that I added a small image to highlight that the content can only be accessed on the corporate VPN. This small change can spare your users from frustration that they cannot open the document.

Highlight external content

If you want to implement this in your environment, you will have to add two display templates (and the image) to your SharePoint Online Search Center and create a new result type for the external content.

Display templates

The display templates for this can be found on the SPCSR Github repository: Highlight external content in your Hybrid Search

Important: these files have to be uploaded to the master page gallery in a folder called "hybrid-search". You could also place them somewhere else, but this requires some changes to the templates.

In the repository, you will find three files:

  1. Item_CommonItem_Body_External.html
  2. Item_External.html
  3. vpn-small.png

The Item_CommonItem_Body_External.html display template has been modified to show the VPN image next to the file extension icon.

Important: if you placed the files in another folder than was specified above, you have to update the VPN image reference. By default, it is set to: ~sitecollection/_catalogs/masterpage/hybrid-search/vpn-small.png

The Item_External.html display template ensures that the external body template gets loaded and used for the external content.

Note: these display templates have to be published before you can proceed to the next step.

Result type configuration

Once the display templates are added to your SharePoint Online search center, it is time to create a new result type. What we want is to target all the external content to make use of the new templates. The nice thing is that there is a new managed property available with hybrid search called IsExternalContent. This managed property has the value true if it is content coming from your on-premises environment.

Here are the steps in order to create a new result type for your external content:

  • Go to Site Settings > Search Result Types;
  • Click on New Result Type;
  • Configure the result type like in the following screenshot:
Result type configuration

Result type configuration

Information: Condition has to be set with Managed Property IsExternalContent equals any of true. The action has to be set with the External Item display template.

  • Click save to store this result type.

Once this result type is configured and you search for content, you should see that the external content gets highlighted with a VPN image.

Note:
It does not necessarily have to be a VPN icon; it can be whatever you want it to be. If you want for example to change the background of the external search results, this would also be possible and can be done by some modifications to the templates.

Article comments