Fixing the slider with bar graph refiner for custom date and time managed properties

January 26, 2015

Last Friday there was a discussion on Twitter about a problem with the Slider with bar graph refiner. The problem is that the refiner does not work properly when you use custom date and time managed properties.

When you would use a custom date and time managed property, you get the following output:

Custom date and time managed property

Custom date and time managed property

If you compare this with an OOTB managed property, the date formatting you would expect a rendering like this:

OOTB managed property

OOTB managed property

As you can see, the labels underneath the graph are different.

The problem

The problem is that the code which retrieves the labels for the slider with bar graph refiner only checks the property name to know the data type of the managed property.

Note: there are better ways to check the managed property data type. This post is intended to give more information about the problem and a way to solve the issue.

Here is a code snippet:

The first thing that the code does is checking if the managed property name exists in an array of known managed properties. Of course, if you are using a custom managed property, yours will not be in it. Here is the array of the known date and time managed properties:

If the managed property was not found in the array, the code will check for the OWSDATE suffix at the end of the managed property name. This is in place if it is an auto-created managed property by SharePoint, but if you have a naming convention for your managed properties this will most likely not include the OWSDATE suffix at the end.

So for example, if you have a custom managed property named CustomCreated, the two checks will not retrieve the correct data type because the property does not exists in the array and does not contain an OWSDATE suffix.

The Twitter discussion started with a post to a blog post explaining the problem and how you can solve it by appending the OWSDATE suffix to your custom property: SharePoint Search Results with DateTime field refiner.

Display template solution

Now as I said, if you have your own naming conventions in place, you would not like it that you need to add the suffixes to the property name.

Another solution to solve this issue is to trick the code into thinking that it is rendering a date and time managed property. Here is a code snippet from my updated refiner:

So what this code does is it retrieves the property name and checks if the OWSDATE suffix is in place. If it does not exist, the code appends the OWSDATE suffix and retrieves the labels for the graph. When the labels are retrieved, the property name gets reset to the original name, and the rest of the code gets executed.

Custom managed property rendered correctly

Custom managed property rendered correctly

Using the predefined managed properties

Another solution instead of adding OWSDATE to your managed property name can be to use one of the predefined managed properties: RefinableDate00, RefinableDate01, ...
The code will also check for these kind of properties via a regular expression: "(Refinable)?(String|Date|Int|Double|Decimal|YesNo)[0-9][0-9]".

Download

The display template can be downloaded here: Slide bar graph for custom managed properties.

Updates

03/01/2017

Remy Bosman mentioned a problem on Office 365 with the slider display template. After some investigation, it seems that there were some code changes made to the search.clientcontrols.js script file. The code I used to trick the template into believing it is rendering a known date type managed property, does not work anymore. For more information about the issue, you can check my comment on the Microsoft Tech Community site: Display a RefinableDate as Slider Refiner. As a workaround, I published a new display template for Office 365 which renders the labels correctly. It can be found in the GitHub repo: Filter_SliderBarGraph_Date_O365.html.

Comments