Modify Search Center Settings with JavaScript Client Object Model

Although there is currently no API in the JavaScript CSOM which lets you change the search center url directly, SharePoint stores the search settings in the Property Bag of the root SPWeb object in a site collection. You can set these property bag values and your search settings should get modified.

"SRCH_ENH_FTR_URL" – Search Center URL

"SRCH_SITE_DROPDOWN_MODE" – Search Scope Drop down option

"SRCH_TRAGET_RESULTS_PAGE” – Target Search Results page

Using JavaScript Client Object Model, you can set the values like this:

	var ctx = new SP.ClientContext.get_current();
	var web = ctx.get_site().get_rootWeb();
	var props = web.get_allProperties();
	//Search Center Url
	props.set_item("SRCH_ENH_FTR_URL","/sites/search/pages");
	//Search Scope Drop down option
	props.set_item("SRCH_SITE_DROPDOWN_MODE","HideScopeDD_DefaultContextual");
	//Target Search Results page
	props.set_item("SRCH_TRAGET_RESULTS_PAGE","/sites/Search/Pages/results.aspx");
	web.update();
	ctx.load(web);
	ctx.executeQueryAsync(function () {
	alert("Search Settings Modified");
	},
	function() {
	alert("failed");
	});

view raw sp15_searchsettings.js hosted with ❤ by GitHub

For the Search Scope Drop Down Options, here is a full set of values you can set:

Do Not Show Scopes Dropdown, and default to contextual scope: "HideScopeDD_DefaultContextual"
Do Not Show Scopes Dropdown, and default to target results page: "HideScopeDD"
Show scopes Dropdown: "ShowDD"
Show, and default to ‘s’ URL parameter: "ShowDD_DefaultURL"
Show and default to contextual scope: "ShowDD_DefaultContextual"
Show, do not include contextual scopes: "ShowDD_NoContextual"
Show, do not include contextual scopes, and default to ‘s’ URL parameter: "ShowDD_NoContextual_DefaultURL"

SharePoint 2013: Modify Navigation Settings with JavaScript and JSOM

One of the new additions in the JavaScript Client Object Model in SharePoint 2013 is the Publishing Navigation API. Some of the other additions are the UserProfile API and the Taxonomy API which I have already posted about.

In this post, let us look at how to use the Navigation API to change the navigation settings in a SharePoint 2013 site.

The main reason I want to do these posts is that currently there is still no API Reference available on MSDN for them. So this might be helpful to people looking to achieve the same functionality.

Here are the things which you can change from this Navigation API: 

1) You can change the Navigation settings of Publishing Sites as well as Non-Publishing sites.

2) You can set the Navigation Provider of the Current Navigation (Quick Launch) as well as the Global Navigation (Top Navigation Bar)

3) You can set the Navigation Provider out of any of these three:

     a. Inherit from Parent Site

     b. Managed Navigation (Taxonomy) The navigation items will be represented using a Managed Metadata term set.
     c. Structural Navigation: Display the navigation items below the current site.

4) Since all this code is pure JavaScript, you can add it in a variety of places like Apps, WebParts, Pages, Page Layouts, Web Templates etc.

So without much further ado, here is the code to manipulate the Navigation Settings:

First, lets make sure that we have loaded all the required SharePoint JavaScript files on the page. I like to use the jQuery.getScript() for this. The scripts we will need are sp.runtime.js,  sp.js and sp.publishing.js.
Here is a simple way by which I load all the necessary files:

	$(document).ready(function(){
	var scriptBase = _spPageContextInfo.webAbsoluteUrl + "/_layouts/15/";
	$.getScript(scriptBase + "sp.runtime.js",function(){
	$.getScript(scriptBase + "sp.js",function(){
	$.getScript(scriptBase + "sp.publishing.js", modifyNavigation);
	});
	});
	});

view raw sp15_nav_scripts.js hosted with ❤ by GitHub

Now, the actual code:

1) Set the (Current/Global) Navigation to either "Inherit from Parent" or "Structural Navigation":

	(function($){
	$(document).ready(function(){
	var scriptBase = _spPageContextInfo.webAbsoluteUrl + "/_layouts/15/";
	$.getScript(scriptBase + "sp.runtime.js",function(){
	$.getScript(scriptBase + "sp.js",function(){
	$.getScript(scriptBase + "sp.publishing.js", modifyNavigation);
	});
	});
	});
	function modifyNavigation(){
	//Current Context
	var context = SP.ClientContext.get_current();
	//Current Web
	var currentWeb = context.get_web();
	//Navigation Provider Settings for Current Web.
	var webNavSettings = new SP.Publishing.Navigation.WebNavigationSettings(context, currentWeb);
	//Current Navigation (Quick Launch)
	var navigation = webNavSettings.get_currentNavigation();
	//Global Navigation (Top Navigation Bar)
	//var navigation = webNavSettings.get_globalNavigation();
	/*
	unknown: 0,
	portalProvider: 1 (Structural Navigation),
	taxonomyProvider: 2 (You will need the Term Store Id and Term Set Id too),
	inheritFromParentWeb: 3 */
	navigation.set_source(1);
	webNavSettings.update();
	context.executeQueryAsync(function(){
	alert("Navigation Modification Successful");
	},function(sender,args){
	alert(args.get_message());
	});
	}
	})(jQuery);

view raw sp15_nav.js hosted with ❤ by GitHub

2) Set the (Current/Global) Navigation dependent upon a Term Set in the Term Store:

	(function($){
	$(document).ready(function(){
	var scriptBase = _spPageContextInfo.webAbsoluteUrl + "/_layouts/15/";
	$.getScript(scriptBase + "sp.runtime.js",function(){
	$.getScript(scriptBase + "sp.js",function(){
	$.getScript(scriptBase + "sp.publishing.js", modifyNavigation);
	});
	});
	});
	function modifyNavigation(){
	//Current Context
	var context = SP.ClientContext.get_current();
	//Current Web
	var currentWeb = context.get_web();
	//Navigation Provider Settings for Current Web.
	var webNavSettings = new SP.Publishing.Navigation.WebNavigationSettings(context, currentWeb);
	//Current Navigation (Quick Launch)
	var navigation = webNavSettings.get_currentNavigation();
	//Global Navigation (Top Navigation Bar)
	//var navigation = webNavSettings.get_globalNavigation();
	//Term Store GUID (without hyphens '-')
	navigation.set_termStoreId("ec8dfb7bcea148a7836f455887ed31db");
	//Term Set GUID (without hyphens '-')
	navigation.set_termSetId("93e0d69f4181408893bbb5b1bd221c03");
	/*
	unknown: 0,
	portalProvider: 1 (Structural Navigation),
	taxonomyProvider: 2 (You will need the Term Store Id and Term Set Id too),
	inheritFromParentWeb: 3 */
	navigation.set_source(2);
	webNavSettings.update();
	context.executeQueryAsync(function(){
	alert("Navigation Modification Successful");
	},function(sender,args){
	alert(args.get_message());
	});
	}
	})(jQuery);

view raw sp15_nav_tax.js hosted with ❤ by GitHub

Hope you find this helpful!

SharePoint 2013: Provision AppPart/ClientWebPart through Elements.xml

In my last post, we saw how we can add an app part to page by directly adding the app part code in our .aspx pages. Here is a link to my last post for those interested: http://vrdmn.blogspot.in/2013/02/sharepoint-2013provision.html

Now lets take a look at how we can provision the app part declaratively through Elements.xml file. First, you will have to make sure that the App is installed on the site on which you are trying to deploy the app part. Otherwise your app part will not be provisioned correctly.

Here is the code to put in your Elements.xml file:

	<?xml version="1.0" encoding="utf-8"?>
	<Elements xmlns="http://schemas.microsoft.com/sharepoint/">
	<Module Name="HomePages" Url="Pages">
	<File Path="HomePages\Home.aspx" Url="Home.aspx" Type="GhostableInLibrary">
	<AllUsersWebPart WebPartZoneID="Left" WebPartOrder="1">
	<![CDATA[
	<webParts>
	<webPart xmlns="http://schemas.microsoft.com/WebPart/v3">
	<metaData>
	<type name="Microsoft.SharePoint.WebPartPages.ClientWebPart, Microsoft.SharePoint, Version=15.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" />
	<importErrorMessage>Cannot import this Web Part.</importErrorMessage>
	</metaData>
	<data>
	<properties>
	<property name="TitleIconImageUrl" type="string" />
	<property name="HelpMode" type="helpmode">Navigate</property>
	<property name="Direction" type="direction">NotSet</property>
	<property name="ExportMode" type="exportmode">All</property>
	<property name="HelpUrl" type="string" />
	<property name="Hidden" type="bool">False</property>
	<property name="Description" type="string">Description of My App Part</property>
	<property name="FeatureId" type="System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">9bed54d4-8a85-422f-9318-1000e4d475ee</property>
	<property name="CatalogIconImageUrl" type="string" />
	<property name="Title" type="string">Web Part Title</property>
	<property name="AllowHide" type="bool">True</property>
	<property name="ProductWebId" type="System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">a83c188b-c3af-4b37-85fa-e160f27b4e4d</property>
	<property name="AllowZoneChange" type="bool">True</property>
	<property name="ChromeType" type="chrometype">Default</property>
	<property name="AllowConnect" type="bool">True</property>
	<property name="Width" type="unit" />
	<property name="Height" type="unit" />
	<property name="WebPartName" type="string">MyWebPart</property>
	<property name="TitleUrl" type="string" />
	<property name="AllowEdit" type="bool">True</property>
	<property name="AllowMinimize" type="bool">True</property>
	<property name="ProductId" type="System.Guid, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">9bed54d4-8a85-422f-9318-1000e4d475ed</property>
	<property name="AllowClose" type="bool">True</property>
	<property name="ChromeState" type="chromestate">Normal</property>
	<property name="myEnumProp" type="string">EnumValue1</property>
	</properties>
	</data>
	</webPart>
	</webParts>
	]]>
	</AllUsersWebPart>
	</File>
	</Module>
	</Elements>

view raw sp15_declarative_appPart.xml hosted with ❤ by GitHub

Keep in mind the following few properties:

ProductId: Its the ProductId of your App. A unique identifier which differentiates your app. Please see my last post on how you can get the ProductId of your App.

FeatureId: The same as ProductId. On first glance, it looks like it should be the GUID of the feature present in your app. But thats not the case as far as I know.

ProductWebId: A new Random GUID

WebPartName: The file name of the WebPart found in your Client WebPart XML file. See previous post for  more details.

Custom Properties: You can even provision custom properties and set their default values from here. In the example, I have the myEnumProp as a custom property in my App Part. Here is a link on how to add custom web part properties to your app part: 

http://msdn.microsoft.com/en-in/library/fp179921.aspx