Create document set in SharePoint Online with CSOM

It's very easy to create a document set in SharePoint Online (Office365) with csom. There is not really an API available at this moment, but by converting a folder we can achieve our goal.

If your DocumentSet content type contains other content types, you could end up with a yellow banner saying:

Content types that are available to this Document Set have been added or removed.  Update the Document Set.

If you see this banner, the content types under the new button aren't correct either. You can fix this by setting docset_LastRefresh and vti_contenttypeorder folder properties.

	/// <summary>
	/// Create documentset from folder
	/// </summary>
	/// <param name="ctx">SharePoint clientcontext</param>
	/// <param name="libraryUrl">web relative document library url</param>
	/// <param name="documentSetName">name for the new document set</param>
	/// <param name="documentSetContentTypeId">content type of the new document set.
	/// We assume that this content type is already binded to the document library.</param>
	public ListItem CreateDocumentSet(ClientContext ctx, string libraryUrl, string documentSetName, string documentSetContentTypeId)
	{
	//get document library where we want to add the document set
	var docLib = ctx.Web.GetListByUrl(libraryUrl);
	//fetch stringId's from available contenttypes
	docLib.EnsureProperties(l => l.ContentTypes.Include(c => c.StringId));
	ctx.ExecuteQuery();
	//add folder in library
	var folderInfo = new ListItemCreationInformation
	{
	UnderlyingObjectType = FileSystemObjectType.Folder
	};
	docSet = docLib.AddItem(folderInfo);
	//name field
	docSet["FileLeafRef"] = documentSetName;
	//contentTypeId: eg: 0x0120D520
	docSet["ContentTypeId"] = documentSetContentTypeId;
	//if you don't set file type, the icon will remain the regular folder icon and clicking the folder
	//won't redirect you to document set welcomePage.
	docSet["HTML_x0020_File_x0020_Type"] = "SharePoint.DocumentSet";
	//IMPORTANT: if your document set content type contains other content types,
	//you should update these properties as well. Otherwise a yellow banner will appear and
	//under the 'New' button the content types won't be correct.
	docSet.Folder.Properties["docset_LastRefresh"] = DateTime.UtcNow.ToString("yyyy-MM-ddTHH:mm:ss");
	docSet.Folder.Properties["vti_contenttypeorder"] = string.Join(",", docLib.ContentTypes.ToList().Where(c => c.StringId.StartsWith(BuiltInContentTypeId.Document + "00")).Select(c => c.StringId));
	//send changes to SharePoint.
	docSet.Folder.Update();
	docSet.Update();
	ctx.ExecuteQuery();
	return docSet;
	}

view raw CreateDocumentSet.cs hosted with ❤ by GitHub

cheers!

Change site title for all languages with CSOM

If you want to update the site title of a SharePoint site you probably will use the title property of your web object. ok, but this will only update the site title in the language of the user that runs the code.

e.g. my user account has set English as default display language



If you update web.title property trough the UI or via custom code, change your default display language to another language and load the site again, the web.title property won't be changed in this language.

You can use this piece of code to change the title property for all available languages of a site.

	using (var ctx = new ClientContext(webUrl))
	{
	//get web and load required properties
	var web = ctx.Web;
	ctx.Load(web, w => w.SupportedUILanguageIds, w => w.TitleResource);
	ctx.ExecuteQuery();
	//change site title for all supportedUILanguages.
	var resource = web.TitleResource;
	foreach (var culture in web.SupportedUILanguageIds)
	{
	resource.SetValueForUICulture(new CultureInfo(culture).ToString(), newTitle);
	}
	web.Update();
	ctx.ExecuteQuery();
	}

view raw UpdateWebTitle.cs hosted with ❤ by GitHub

Upload file in SharePoint online document library (folder) with REST and active authentication.

In this post I'll explain you what I did to upload a local file into a SharePoint Online Office 365 document library. The second step in this example is providing the new document with a proper value for the title meta data field.
This example is a console application written in C#, not using the Microsoft.SharePoint.Client.dll but only making calls to REST endpoints.
A CRM developer asked me to write this piece of code so he could implement this logic into a custom CRM module, that module had to copy a file from CRM online to SharePoint online.

When the application is launched the console will ask you for some parameters:

• path of the file to upload
• title for the new document 
• document library name
• folder name (in this example, I expect a folder)
• site collection URL (in this example, sub sites are not taken into account)
• O365 user name
• password

As you see, the application will ask for a user name and password. These credentials are used to authenticate the application with SharePoint. I've used the authentication mechanism build by Wictor Wilén. If you're interested in this authentication mechanism you definitely should read his post.

This console app is just an example on how we can upload a document. The SharePoint document library and the folder must exist, the code won't create them for you. If they don't exist, the code will throw a 404 exception.

If everything goes well, you should see something like this:

Where the magic happens

The download link is available at the end of this article. Download and adapt for your needs.

As explained earlier the application exists of 3 blocks

1. authentication -> get security token by calling STS of Office 365. This security token is sent to SharePoint, if SharePoint accepts it will return 2 cookies. Those cookies we have to include in each (REST) request we do to SharePoint.
2. Reading the local file as a byte array and uploading the file in the correct folder.
3. When the upload is succesfull, we give the Title metadata field a proper value.

Reading and uploading the file with REST (c#)

Following code snippets are only there for explaination reasons, download the full example to get a working application.

When authentication is succesfull and we have the 2 required cookies in our container, I have to obtain the formdigest, this digest is mandatory if your REST call is writing data to SharePoint. We will inlcude this formdigest as property X-RequestDigest in the header of the request. The binaryStringRequestBody property is the second one we add in the header. This property is mandatory because we will upload a document as a byte array.
When preparations are done we can actually do the webrequest by calling HttpHelper.SendODataJsonRequest. After including the cookies, this function will call SendHttpRequest() where the actual request is done. Properties of the request:

• request.Method = "POST"
• request.Accept = "application/json;odata=verbose"
• request.UserAgent = "Mozilla/5.0 (compatible; MSIE 9.0; Windows NT 6.1; WOW64; Trident/5.0)"; //must be there, otherwise http 403 error
• request.AllowAutoRedirect = false; // This is key, otherwise it will redirect to failed login SP page
• request.Headers
• binaryStringRequestBody: true
• X-RequestDigest: [value of formDigist]
• request.ContentType = "application/json;odata=verbose"
• request.ContentLength = requestContent.Length;
• request.GetRequestStream() -> read byte array of file.

	//read file
	Console.Write("Enter file path: ");
	var filePath = Console.ReadLine();
	filePath = String.IsNullOrEmpty(filePath) ? "C:\\Users\\Sander\\Desktop\\test.docx" : filePath;
	var byteArray = File.ReadAllBytes(filePath);
	//prep REST endpoint
	var addFileInFolder =
	String.Format("_api/web/lists/getByTitle(@TargetLibrary)/RootFolder/folders(@TargetFolderName)/files/add(url=@TargetFileName,overwrite='{3}')?" +
	"@TargetLibrary='{0}'&@TargetFolderName='{1}'&@TargetFileName='{2}'",docLibName, folderName, fileName, true);
	//prepare webrequest.
	try
	{
	//SharePoint site collection url
	var spSite = new Uri(siteUrl);
	//authenticate with SPO user.
	var success = SpoAuthUtility.Create(spSite, userName, WebUtility.HtmlEncode(password), false);
	Console.WriteLine("---Authentication passed: {0} ---", success);
	if (success)
	{
	//get X-RequestDigest, required for POST.
	var formDigest = SpoAuthUtility.GetRequestDigest();
	//1. Upload file.
	//prep rest call
	var url = new Uri(String.Format("{0}/{1}", SpoAuthUtility.Current.SiteUrl, addFileInFolder));
	Console.WriteLine("REST Call addFile: {0}\n\n", url);
	//prep headers for addFile POST request
	var headers = new Dictionary<String, String> { { "binaryStringRequestBody", "true" }, { "X-RequestDigest", formDigest } };
	// Send a json odata request to SPO rest services to upload a file to a document library.
	// pass in the helper object that allows us to make authenticated calls to SPO rest services
	var result = HttpHelper.SendODataJsonRequest(
	url,
	"POST", //writing data to SharePoint.
	byteArray,
	(HttpWebRequest) WebRequest.Create(url),
	SpoAuthUtility.Current,
	headers
	);
	var response = Encoding.UTF8.GetString(result, 0, result.Length);
	Console.WriteLine(response);
	Console.WriteLine("\n---File added---");
	}
	catch{}

view raw readAndUpload.cs hosted with ❤ by GitHub

Changing Title metadata field of the fresh document.

Second step is to give the new document a proper title. In fact the process is very similar to the upload of the document. Here a list of the differences:

• body: instead of processing the byte array of the document, now the body of the request will contain a string in which we define the changes to the metadata.
• headers: since we are doing again a POST request, the X-RequestDigest is again required for security reasons. 2 other properties are required as well:
• X-HTTP-Method = MERGE
• IF-MATCH = *

The MERGE method updates only the properties of the entity that you specify.

	var updateMetadata =
	String.Format("_api/web/lists/getByTitle(@TargetLibrary)/RootFolder/folders(@TargetFolderName)/files/getbyurl(url=@TargetFileName)/listitemallfields?" +
	"@TargetLibrary='{0}'&@TargetFolderName='{1}'&@TargetFileName='{2}'", docLibName, folderName, fileName);
	//2. Update title metadata field.
	//prep rest call
	url = new Uri(String.Format("{0}{1}", SpoAuthUtility.Current.SiteUrl, updateMetadata));
	Console.WriteLine("\nREST Call updateMetadata: {0}\n\n", url);
	//prep metadata changes.
	var body = String.Format("{{ '__metadata': {{ 'type': 'SP.ListItem' }}, 'Title': '{0}' }}", docTitle);
	//prep headers for update metadata POST request
	headers = new Dictionary<String, String> { { "X-RequestDigest", formDigest }, { "X-HTTP-Method", "MERGE" }, { "IF-MATCH", "*" } };
	// Send a json odata request to SPO rest services to upload a file to a document library.
	// pass in the helper object that allows us to make authenticated calls to SPO rest services
	result = HttpHelper.SendODataJsonRequestString(
	url,
	"POST", //writing data to SharePoint.
	body,
	(HttpWebRequest)WebRequest.Create(url),
	SpoAuthUtility.Current,
	headers
	);
	response = Encoding.UTF8.GetString(result, 0, result.Length);
	Console.WriteLine(response);

view raw changeTitle.cs hosted with ❤ by GitHub

Here you can download the Visual Studio Project.

**UPDATE: Since System.Web.Extensions is not available in a CRM sandboxed solution, json deserialization is done with System.Runtime.Serialization.Json. Thanks to Kris for helping me out.

Installation App for SharePoint On-prem

During the installation of a provider hosted app on a SharePoint on-prem environment I encountered following error:

The remote event receiver callout failed. Details: The HTTP request is unauthorized with client authentication scheme 'Anonymous'. The authentication header received from the server was 'Negotiate,NTLM'

There was a remote event receiver binded to the AppInstalled event, the callout to this webservice failed.
This error seems indeed correct. The web application, hosted in IIS, was configured for Windows Authentication only.
So, this means that SharePoint calls this web service anonymously? If someone has a better explanation for this, please let me know.

I decided to open the website in IIS, and I changed the authentication for the folder that contained the webservices. Only for this folder I enabled Anonymous and disabled Windows Authentication. This works...

If someone has a better solution for this issue, please leave a comment.

Create Azure Service Bus for debugging SharePoint apps.

If you install Office Developer Tools for Visual Studio 2012, you can debug apps for SharePoint. By using the Microsoft Azure Service Bus, these tools communicate with the same Windows Communications Foundation (WCF) service that remote event handlers (remote event receivers and app event receivers) use. By taking this approach, you avoid network boundary issues between the cloud app and the local web app. This lets you debug remote event receivers in the cloud app. See Developing apps for SharePoint on a remote system.

In fact, what you need is an Azure ACS Service bus. A while ago we could copy the ACS connection directly in the Azure web interface. Now, when you create a new Service Bus via the Azure web interface, only the SAS connectionstring is available.
Solution: create service bus via Azure Powershell:

1. Open Azure Powershell

	Add-AzureAccount
	New-AzureSBNamespace -Name "Your namespace name" - Location "your location"

view raw CreateAzureServiceBus.ps1 hosted with ❤ by GitHub

2. I got this exception:

AuthenticationFailed: A security token exception occured for the received JWT token.

...because I logged on with a Microsoft Account. You can only create a new service bus with an Active Directory account. This means if you have multiple accounts available and you get the connection dialog, you should go for the directory account. If you don't have an Active Directory account, you should go to Azure, there you can create one (and bind it to a subscription).



 After I logged on with the correct account, the creation went well.

Adapt view of a ListViewWebPart with CSOM.

In a previous post, I explained how we can easily provision a SharePoint site with the client side object model. In this post I will explain how you can change the view of the ListViewWebPart with CSOM.
Probably this is something you want to do all the time because when you add a ListViewWebPart to a page, in the backgound SharePoint will generate a new hidden view in the views collection of the corresponding list.
Unfortunately, this new view isn't a copy of the current default view of the list...

As always, to work fast, I'm using the OfficeAMS extension methods. Since my last post, things have changed for OfficeAMS, as they say themselves: they've grown up.

	public SPRemoteEventResult ProcessEvent(SPRemoteEventProperties properties)
	{
	var result = new SPRemoteEventResult();
	using (var clientContext = TokenHelper.CreateRemoteEventReceiverClientContext(properties))
	{
	if (clientContext != null)
	{
	try
	{
	//create document library
	clientContext.Web.AddDocumentLibrary("Internal documents", true);
	//create wiki page
	clientContext.Web.AddWikiPage("Site Pages", "Documents.aspx");
	//set correct page layout to wiki page
	clientContext.Web.AddLayoutToWikiPage("sitepages", WikiPageLayout.TwoColumns, "Documents");
	//get new document library
	var internallDocLib = clientContext.Web.GetListByTitle("Internal documents");
	//add listviewwebparts to page
	var internalDocsWebPartEntity = new WebPartEntity
	{
	WebPartIndex = 2,
	WebPartTitle = "Latest Internal Documents",
	WebPartZone = "Left",
	WebPartXml = string.Format(Globals.ListViewWebPart, internallDocLib.Id, "Latest Internal Documents")
	};
	//params: pageslibrary url, webpartentity, wiki page, table row, table column, addSpace under web part
	clientContext.Web.AddWebPartToWikiPage("sitepages", internalDocsWebPartEntity, "documents.aspx", 1, 1, true);
	//adapt hidden views used by xsltlistviewwebparts
	clientContext.Web.Context.Load(internallDocLib.Views);
	clientContext.Web.Context.ExecuteQuery();
	//use linq query to find the view where the view its property "ServerRelativeUrl" is equal to the page url that contains the web part.
	var internalViewHomePage =
	(from v in internallDocLib.Views
	where v.ServerRelativeUrl == String.Format("{0}/SitePages/{1}", clientContext.Web.ServerRelativeUrl, "documents.aspx")
	select v).SingleOrDefault();
	//remove all viewfields and add desired columns.
	if (internalViewHomePage != null && internalViewHomePage.Hidden)
	{
	internalViewHomePage.ViewFields.RemoveAll();
	internalViewHomePage.ViewFields.Add("DocIcon");
	internalViewHomePage.ViewFields.Add("LinkFilename");
	internalViewHomePage.ViewFields.Add("_UIVersionString");
	internalViewHomePage.ViewFields.Add("Modified");
	internalViewHomePage.ViewFields.Add("Editor");
	internalViewHomePage.Update();
	internalViewHomePage.Context.ExecuteQuery();
	}
	}
	catch
	{
	//write logging information
	}
	}
	}
	}

view raw Add ListViewWebPart to wiki page and adapt view.cs hosted with ❤ by GitHub

SharePoint Online header region background color issue

This week our production tenant (and my development tenant as well) got updated with the new 'higher' header region.



Strange enough, when hovering the flyout menus. The background was black, only the selected item was visible.



To fix this issue, you just have to switch themes: Site Settings - Change the look - select appropriate theme - Click 'try it out' - Click 'Yes, keep it'.

new green theme: issue fixed



...and back to blue: