How to do a KeywordQuery Search using Jquery in SharePoint 2013

Sathish Nadarajan
 
Solution Architect
January 13, 2015
 
Rate this article
 
Views
26325

In this article, let us see how to search the SharePoint content from the JS CSOM using sp.search.js in SharePoint 2013.

In many cases we may require to do a search from the Client Side. (Probably from the Apps). In that case, let us see how to use the various approaches like, Set the Query String, Set the Result Source ID, Set the Sorting Order, Retrieving custom Managed Properties etc.,

The script is self-explanatory. Hence, there nothing much to describe about this.

 function customSearch() 
 { 
 //Create the Context
     var context = SP.ClientContext.get_current(); 
 
 //Create the KeywordQuery Object
     var keywordQuery = new Microsoft.SharePoint.Client.Search.Query.KeywordQuery(context); 
 
 
 //Set the Query here
     keywordQuery.set_queryText("Managed Property :" + "<Value for the Managed Property>" + ""); 
 
 //Add the return columns - custom Managed Properties
     var properties = keywordQuery.get_selectProperties(); 
     properties.add('ContentType'); 
     properties.add('Any Managed Properties'); 
 
 //Set the Result Source ID if any	
     keywordQuery.set_sourceId("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"); 
 
 // Set Row Limit
    keywordQuery.set_rowLimit(500);
 
 
 // Set Trim Duplicates to False
 keywordQuery.set_trimDuplicates(false);
 
 // Sorting (Ascending = 0, Descending = 1)
 keywordQuery.set_enableSorting(true);    
 var sortproperties = keywordQuery.get_sortList();
 sortproperties.add("Managed Property name", 0);
 
 //Create Search Executor Object
     var searchExecutor = new Microsoft.SharePoint.Client.Search.Query.SearchExecutor(context); 
 
 //Execute the Query
     this.results = searchExecutor.executeQuery(keywordQuery); 
 
 //Execute the Context
         context.executeQueryAsync(onQueryListSuccess, onQueryFail); 
 
 } 
 
 function onQueryListSuccess() { 
     for (i == 0; i < results.m_value.ResultTables[0].ResultRows.length; i++) { 
         alert(results.m_value.ResultTables[0].ResultRows[i].ContentType) 
     } 
 
 } 
 
 function onQueryFail()
 {
 	alert('Query failed. Error:' + args.get_message());
 }
 

Make sure that you have the reference of the following JQueries on your page.

1. JQuery.1.7.1.js (later versions can also be used)

2. SP.js

3. Sp.Runtime.JS

4. Sp.Search.JS

Happy Coding.

Sathish Nadarajan.

Author Info

Sathish Nadarajan
 
Solution Architect
 
Rate this article
 
Sathish is a Microsoft MVP for SharePoint (Office Servers and Services) having 15+ years of experience in Microsoft Technologies. He holds a Masters Degree in Computer Aided Design and Business ...read more
 

Leave a comment