Bhanu Prakash Bysani's Blog : Sharepoint

Showing posts with label Sharepoint. Show all posts

Thursday, April 21, 2016

JSON Light support in REST SharePoint API

The REST SharePoint API has been an extremely popular way for Office 365 developers to work with SharePoint sites, lists/libraries, and list items/documents. One of the common feedback from developer’s community using the REST SharePoint API was about the payload of the data that was returned. The response from Microsoft was to add support for JSON Light. JSON Light is an open standard that allows developers to provide in the header of the request how much metadata is returned. To check out more about JSON Light, head over to the Microsoft OData JSON spec document. You can also check out all the endpoints for the SharePoint REST API over on MSDN.

Before this, when calling the SharePoint REST API, Office 365 developers had to include in the header request: “accept: application/json; odata=verbose”. This header is now optional, and more OData options have been added. If you don’t require all of the metadata for your business solution, you can significantly reduce the payload of your calls by using one of these other options. Take a look at this set of OData examples based on a common scenario of requesting a set of list items from a list and the associated response size.

Option 1: verbose

“accept: application/json; odata=verbose”

46,647 bytes

Option 2: minimalmetadata

“accept: application/json; odata=minimalmetadata”

11,173 bytes

Option 3: nometadata

“accept: application/json; odata=nometadata”

6,832 bytes

The nometadata option reduces the size of the payload significantly, and for many scenarios this is all that you need when working with list items, for example.

Option 4: Don’t provide it

“accept: application/json”

11,173 bytes

You are no longer required to provide the OData property in the request header, unless you would like to specify one of the values above. This defaults to minimalmetadata option.

Now, with support for JSON Light, you can choose the OData option you need for specific tasks and get an appropriately sized payload.

Reference

Installing and Configuring SharePoint 2013 and SharePoint Farm

bhanu New Features , Sharepoint

In one of the project I got a chance to set-up a SharePoint 2013 farm configuration for development environment (Hyper V) with below configuration.

Windows server 2012 R2
SQL Server 2014

I never worked on configuration part, started typing in google Installing and configuring SharePoint 2013 and farm finally found some articles which will helped me lot to complete the 100% of task. Sad thing is I did not get a chance to document the same.

I found a nice article which contains complete step by step about preparing, installing, configuring the SharePoint 2013 farm with nice explanation. This PDF has not contains the same configuration what I have mentioned above, its SharePoint 2013 configuration with windows server 2008 in VM ware environment.

Please click here to download the same.

Hope this post will be helpful.

Get a one year free Office 365 developer account

bhanu New Features , Sharepoint

Are you interested in Office 365 Developer Program? Do you want to get FREE!!! developer account? Microsoft gave us possibility to be a part of the Office 365 Developer Program for one year FREE subscription.

The Office 365 Developer Program is a vibrant and growing community of developers, veteran and newbie, who are developing solutions on Office 365. I can confirm that Office 365 is still grooving and most of my projects right now are related to this platform.

So if you interested in the program go this LINK and register. If you’d prefer to take some free, online training courses first, you have a chance at http://dev.office.com/training . Its’ very good move from Microsoft :).

So many videos have placed on APP Development, Boot Strap CSS and AngularJS.

I hope this post will be helpful to you.....

SharePoint 2013 REST – Internet Explorer does not support this feed format

bhanu Sharepoint ,

SharePoint 2013 adds the ability for you to remotely interact with SharePoint sites by using REST. Now, you can interact directly with SharePoint objects by using any technology that supports standard REST capabilities.

When I am reading resource(http://servername/_api/site) using REST API using Internet Explorer 10, I was getting error as below mentioned screen shot.

Root cause for the above error, if you have feed reading view on in your browser you will not able to see the XML.

I am using the browser IE 10, in order to view XML in IE 10, do the steps below.

1. Tools > Internet Options.

2. Select the Content Tab

3. Under Feeds and Web Slices, select Settings

4. Uncheck Turn on Feed reading view

Then I was able to see the XML in the browser.

Hope this post will be useful.

Enabling the Developer Site Collection Feature in SharePoint On-premises / Online

bhanu Sharepoint ,

In SharePoint 2013 we have a new site template called Developer Site Template, It is a site template which is used extensively for App development and you can only deploy apps for SharePoint to a Developer Site.

Developers can build, test and publish their apps here. Here you can deploy apps for SharePoint from Visual Studio 2013 to the developer site and you don't need to create an App Catalogue site since the developer site template by default creates an App Catalogue library. The developer template is available under the collaboration site template.

In one of the project, I got a scenario where I need to enable the developer site collection feature for a existing site collection it may be team site or publishing site. There isn't a button in the site collection features to let you enable this.

If you were on premises environment, you'd just run the below command to enable the feature.

Enable-SPFeature e374875e-06b6-11e0-b0fa-57f5dfd72085 –url http://sp.contoso.com

But we can't do the same thing in SharePoint on-line site as the power shell commands doesn't expose the ability to turn features On and Off.

For this I have found a nice tool SharePoint Client Browser. It has an extremely useful feature to open up Power Shell with CSOM already loaded.

Find the step by step process to enable the feature mentioned below.

1. Click on SharePoint Client browser or run with admin privileges you can find Tenants and site collections. You can add by right click on any one of option. I am adding my site collection by giving user details.

2. One the authentication has been done, it will show the site collection like below image.

3. Right click on the site collection, it will show the option as Open Power Shell with CSOM.

Click on that it will open the power shell window as shown below.

It will ask the password again. Once you give the password, it will authenticate and show the sample code snippet also like below.

In the above screen grab, we are able to see the sample code which will display the current site title and URL.

In the above screen grab, I am loading the site and getting the feature id and adding the feature to the site. Find the complete snippet mentioned below.

$ctx.Load($ctx.Site);
$ctx.ExecuteQuery();
$guid = [System.Guid]"e374875e-06b6-11e0-b0fa-57f5dfd72085"
$ctx.Site.Features.Add($guid,$true,[Microsoft.SharePoint.Client.FeatureDefinitionScope]::None)
$ctx.ExecuteQuery();

For more details go through the below mentioned URL's.

http://blogs.msdn.com/b/kaevans/archive/2013/10/05/enabling-the-developer-site-collection-feature-in-sharepoint-online.aspx

https://mysharepointsolution.wordpress.com/2015/01/06/publish-app-to-non-developer-site-collection/

Hope this post will helpful.

VS2013 Web Essentials - Zen Coding is a huge time saver for web developers

bhanu Sharepoint ,

As a developer I'm always on the lookout for new solutions, tools, or techniques that can both boost my productivity. Last week I found a nice feature in visual studio 2013 which is Zen Coding.

As a web developer, I have regularly found myself needing to type a large amount of HTML layout code. Your page starts to grow, and your eyes begin to glaze over as you type DIV after DIV.

Zen Coding is a set of editor extensions, allowing a developer to use shorthand for common tasks. Microsoft has incorporated these extensions into Web Essentials for Visual Studio 2013.

I found a nice article which will give complete idea about this Zen Coding.

http://dannydnet.blogspot.in/2013/12/vs2013-web-essentials-zen-coding-is.html

Adding Content Editor Web Part to Page in SharePoint programmatically

bhanu Sharepoint ,

Content Editor Web Part is one of useful OOB web part in SharePoint.

You can use the Content Editor Web Part to add formatted text, tables, hyperlinks, and images to a Web Part Page.

The Content Editor Web Part is intended for adding HTML content to a Web Part Page, which may include hyperlinks. However, this Web Part is not designed to connect to a Web site. If you need to connect a Web Part to a Web site, consider using the Page Viewer Web Part.
The Content Editor Web Part does not accept the HTML FORM element. If you need to add a Web Part that uses the FORM element, consider using the Page Viewer Web Part or the Form Web Part.

In my recent project i have a requirement to add content editor web part to the page programmatically. We can add content editor web part manually to page, but when we are moving from one environment to another environment its difficult to add to page manually.

In feature activation event i have written the below code snippet which will add the content editor web part to the page.

/// Page Url for the Page
/// Web Part name for the same
/// Web Part height for the same
/// Zone id for the same
/// Zone index for the same
/// SPWeb Object
public static void AddContentEditorWebPartToPage(string pageUrl, string webpartName, string webpartHeight, string zone, int zoneId, SPWeb web)
{
            // TO DO : Check for existence of web part
   SPFile page = default(SPFile);
   bool webpartExistance = false;
   try
   {
     page = web.GetFile(pageUrl);
     if (page.Exists)
     {
       if (page.CheckOutType == SPFile.SPCheckOutType.Online)
       {
          throw new Exception("Page is already checked Out. Please check in or discard checkout before activating features");
       }

       page.CheckOut();
       using (SPLimitedWebPartManager manager = page.GetLimitedWebPartManager(PersonalizationScope.Shared))
       {
            string errorMessage = string.Empty;
            if (!web.IsRootWeb)
            {
               web = web.Site.RootWeb;
            }

            SPLimitedWebPartCollection webparts = manager.WebParts;
            foreach (System.Web.UI.WebControls.WebParts.WebPart webpart in webparts)
            {
                if (webpart.Title == webpartName)
                {
                  // Web Part found!
                  webpartExistance = true;
                  break;
                }                           
            }
            if (!webpartExistance)
            {
              //Creation of ContentEditor Webpart
              ContentEditorWebPart CEWP = new ContentEditorWebPart();
              CEWP.Title = webpartName;
              CEWP.Height = webpartHeight;
              CEWP.ChromeType = System.Web.UI.WebControls.WebParts.PartChromeType.None;
              XmlElement ProjectDetailsTitle = new XmlDocument().CreateElement("content");
              ProjectDetailsTitle.InnerText = @"
                                              
                                              
                                             
                                      ";
                            CEWP.Content = ProjectDetailsTitle;
                            manager.AddWebPart(CEWP, zone, zoneId);
                            manager.SaveChanges(CEWP);
                        }
                    }
                    page.CheckIn("Adding WebParts", SPCheckinType.MajorCheckIn);
                    page.Publish("Publishing Page");
                }
                else
                {
                    throw new Exception("Page Not found for adding web parts");
                }
            }
            catch (Exception ex)
            {                
                throw ex;
            }
            finally
            {
                // This is to ensure next time when feature is activated if there is error in previous activation its taken care
                if (page != null && page.CheckOutType == SPFile.SPCheckOutType.Online)
                {
                    page.UndoCheckOut();
                }
            }

        }

In the above code snippet, i am checking whether the page exists or not, if exists then we are checking whether the page is already checked out or not. If page is checked out throwing an exception. Other wise using limited web part manager we are checking for whether the page have already have the web part with the same name. If the web part exists we are skipping, other wise we are adding content editor web part to the page and finally we are doing the check in and publishing the page.

Hope this post will be useful..

Enforce Drag and Drop documents to apply metadata

bhanu New Features , Sharepoint

A useful new feature in SharePoint 2013 is the ability to drag and drop files in to document libraries using browser. This feature is particularly useful for adding multiple documents to the library, to achieve the same functionality in previous versions of SharePoint we need to open the document library in explorer view but explorer view is not a best practice. So drag and drop feature is very useful. Find the below screen shots for the same.

To have the drag and drop feature to SharePoint 2013, here are the scenario or requirements of web browsers.

Internet Explorer 10
Internet Explorer 9 with Office 2013 Installed
Internet Explorer 8 with Office 2013 Installed
Firefox latest version
Chrome latest version

When we are drag and drop documents in to document library it will not prompt for the metadata which is required. but the document which is uploaded in library will be checked out. In my recent project i have a requirement it should prompt for metadata for single or multiple documents.

I have found a nice article which has full filled my requirement. Please go through the below URL which will give complete idea.

http://sharepoint.findincity.net/view/635399286724222582138466/enforce-drag-and-drop-documents-to-apply-metadata

http://sharepoint.aspcode.net/view/635399286724222582138466/enforce-drag-and-drop-documents-to-apply-metadata

CAML Query Joins and Projections

bhanu Sharepoint ,

In SQL Joins are used to get the data of two or more tables based upon a relationship.Using Joins, we can combine two or more tables and gather data with a single query.

Similarly in SharePoint we have a good feature to get the data from one or more tables using Joins by Caml query. But there is no way to write Joins using Caml designer.

I have found a nice tool to write Joins using Caml query in CodePlex. CamlJs (SharePoint JavaScript Caml Builder) simplifies creation of SharePoint Caml queries using client-side scripts which can be used with either SharePoint Client Object Model or Sp-services.

We can checkout the features of CamlJs documentation and usage by clicking here CamlJs.

we have two flavors of CamlJs.One is CamlJs Console and another one is extension which is available in Chrome web store. Using this extension we can check join condition in browser it self ( please find the below screenshot). But it works only in Google chrome.

Sp-query has two properties to get the data from two or more tables based on a relationship.

Joins : Used to join the lists based on relationship.
Projected Fields : Specifies the fields in joined lists that can be included in the view.

Please find the complete documentation by visiting this blog post. Joins have some limitations

1. Data Table is not supported when we use joins.

2. Multiple Lines of text, Choice type columns are not supported in the Projected fields.

We have discussed how to write Joins on SharePoint List using different tools. Stay tuned for this post how to use this query both in server side and client object model.

How to programmatically set a content type as default content type in a SharePoint 2013 List

bhanu Sharepoint ,

In my recent project i have a requirement to change the order of content type of list programmatically.

I have an announcement list which has default content type announcements,I want to add my custom content type to that list and i need to change the order of content type i.e when we are adding a new item to the list,my custom content type columns should come.

Use the below code snippet to change to set your custom content type as default content type by using server and client object model.

Using Server Object Model :--

Code:

 
private void SetDefaultContentType(SPList list, string ContentTypeName)
{
    try
    {
        IList cTypes = new List();
        SPFolder root = list.RootFolder;
        cTypes = root.ContentTypeOrder;
        SPContentType cType = cTypes.SingleOrDefault(hd => hd.Name == ContentTypeName);
        int j = cTypes.IndexOf(cType);
        cTypes.RemoveAt(j);
        cTypes.Insert(0, cType);
        root.UniqueContentTypeOrder = cTypes;
        root.Update();
    }
    catch (Exception)
    {
       throw;
    }
}

Usage :--

 
using (SPSite site = new SPSite("[Server URL]"))
 {
     using (SPWeb web = site.OpenWeb())
     {
         SPList list = web.Lists["Your List Name"];
         SetDefaultContentType(list, "Your Content Type Name");
  
     }
 }

Using Client Object Model :--

 
public static void SetDefaultContentType(ClientContext clientContext, string ContentTypeName)
        {
            try
            {
                List list = clientContext.Web.Lists.GetByTitle("Announcements");
                if (list != null)
                {
                    ContentTypeCollection listContentTypes = list.ContentTypes;
                    //clientContext.Load(listContentTypes, listCTs => listCTs.Include(ls => ls.Name).Where(ls => ls.Name == ContentTypeName));
                    clientContext.Load(listContentTypes);
                    clientContext.ExecuteQuery();
                    if (listContentTypes.Count != 0)
                    {
                        IList cTypes = new List();
                        foreach (ContentType ct in listContentTypes)
                        {
                            if (ct.Name != "Folder")
                            {
                                if (ct.Name == ContentTypeName)
                                {                                   
                                    cTypes.Insert(0, ct.Id);
                                }

                                else
                                {
                                    cTypes.Add(ct.Id);
                                }
                            }
                        }

                        list.RootFolder.UniqueContentTypeOrder = cTypes;
                        list.RootFolder.Update();
                        list.Update();
                        clientContext.ExecuteQuery();
                    }
                }
            }
            catch (Exception)
            {
                throw;
            }
        }

Code Samples – SharePoint 2013 .Net Client Side Object Model

bhanu New Features , Sharepoint

In SharePoint 2013, all the people are using CSOM only. I found a nice PDF which contains all the basic operations.

SharePoint Developers who have some basic knowledge about SharePoint 2010 or 2013 will find this book helpful for understanding and working with the .Net Client Side Object Model. This book is mainly focused on beginner functionality and code samples to perform basic operations using the .Net Client Side Object Model.

We can download the PDF by clicking here.

Download File For Code Samples

Tools for your SharePoint 2013 development toolbox

bhanu New Features , Sharepoint

In SharePoint 2013, we have so many tools are available to make developer life easily. I have heard some the tool names and some of tool names from colleagues.

Recently i have used SharePoint manager and SharePoint 2013 Search tool which made my life easier. I want to list down all the tools available and how it useful in our daily life. But i did not get a chance to work on that.

Today i found out one post which has all the details about the tools for SharePoint 2013 and documentation also.

Please go through the below link for complete details. I am sure definitely these tools will made our life easier.

http://zimmergren.net/technical/tools-for-your-sharepoint-2013-development-toolbox

I hope this post will be useful..

How to publish provider hosted app in SharePoint online

bhanu New Features , Sharepoint

In SharePoint 2013, Microsoft has introduced apps. we have three types of methodologies to host the apps in SharePoint.

SharePoint hosted app:

This type of App lives inside SharePoint. There is not code running on the server. All code must run in the client. This will have .aspx page but lots of JavaScript code that will implement the logic via client side script and service calls.

Provider-hosted apps comes under cloud hosted app. These apps hosted outside of SharePoint server. Since its hosted outside of SharePoint server you have the freedom to develop an app using any language like PHP, Java or .Net. You can write server side code here which will communicate with SharePoint server. Here it will use OAuth protocol for authentication mechanism.

Provided hosted app enables developer to define its own infrastructure which may be a dedicated server or may be a cloud server provided by providers like Amazon.

As we know provider hosted app we can deploy both in on premises and SharePoint online. Let us discuss how to deploy the app in SharePoint online. in my next post we will discuss how to host the app in on premises.

When we are creating provider hosted app in VS, it will create two projects app and appweb. Before starting creation of provider hosted app we need to have SharePoint Online and Windows azure account.

In my SharePoint online site, I have created one site collection with developer site template.

1. Create a new project in VS with the template App for SharePoint, give the name of the project and click on OK. In this screenshot I am creating a project with the name SampleProviderhostedapp.

2. Click on OK it will prompt for the site name where you want to debug the provider hosted app. I have given my SharePoint online developer site name and selected the provider hosted app in the section how do you want the host the app.

3. 3. Click on next we will get the window which will ask which type of project you want to create. We can create the project in Asp.Net Web forms application or ASP.Net MVC application. I am going with the option ASP.Net Web forms application.

3. 4.Click on Next we will get a window to where we can configure the authentication settings, I am going with the option with windows Azure Control service and click on Finish.

3. Click on finish, a project will be created and it will prompt for the SharePoint Online Credentials to connect with SharePoint Online.

3. Enter the credentials and click on Sign in button, we will find the project will be created with 2 solutions one is App and another one is APPWeb. See the below screen shot.

App Project will contain only app manifest XML which will be useful for configuration the app like default page and version of the app.

Right Click on App web project and click on Publish it will open the window to select the publish target.

3. I want to publish to the APPWeb in windows Azure, so we need to create a site in windows azure account. I have created with the site name as Bhanu test.

3. We need to download the publish profile in windows azure to publish the appweb to Windows azure. For this click on the site BhanuTest (site name) where I want to publish. Once click on the site you will navigate to the below page.

Click on the Download the Publish Profile which is in the Publish your app section. Once click on the link a file will be downloaded.

Now go to the VS in Publish Target window click on Import it will prompt the window, where we can browse the profile which we have downloaded from Windows Azure site.

Click on Ok. It will navigate you to the connection tab.

Click on Validate Connection it will validated the connection, Once validation completes you will get the green symbol beside the validate connection button.

Click on Next It will navigate you to the Settings tab where we can select the configuration. I am selecting the debug in the dropdown.

Click On next and Click on Start Preview it will show the files and click on publish.

After Publishing it will navigate to the success page like below screen shot.

Now go to VS solution explorer you will find out the Publish Profiles folder which will contains the profile which we have downloaded from the Azure Site.

Now go to the Developer site and browse the appregnew.aspx page which will be available in the page layouts.

https://yoursitename/_layouts/15/appregnew.aspx

In this page we can create client id and client secret id. These id we can use in our APPweb and APP solutions. Client Id is bridge between the two solutions.

So browse the page and fill the information and click on create button.

Generate the Client Id, Client Secret Id. Give the Title for the app whatever you want.

App Domain and Redirect URI we need to give the windows azure site name. Redirect URI will allow only the https. Once fill the information click on create button app identifier will be created and you will be navigated to the below page.

Now go to the Web.config file which is in the APPweb solution. Update the Client Id and Client secret id and publish the solution.

Right Click on the APP solution and click on publish you will navigate to the below page.

Click on Deploy your web Project. It will prompt a window like below.

Click on Publish. After that you need to package the app to upload the app in to site for click on the Package the APP which will be available in the publish your app page.

When you click on the Package the app, it will prompt the window like below.

We need to enter the Client Id and update the site URL. Normally it will show the URL without https so we need to update with https and click on Finish.

Now it will open the window which will contain the app file. Now browse your SharePoint Developer site and upload this app in to apps testing.

Click On new app to deploy, It will open the below window.

Click on Upload hyperlink, once click on that it will open another window where we can browse your app file.

Click on browse button and browse your app project, navigate to binà Debug à app.publish à go to version folder à select the app file and click on Ok.

It will show the above window which will be stated as your app has been successfully uploaded. It’s time to deploy your App. Click on Deploy button. It will open the below wind and click on trust it.

Click on trust it button app will be installed. Now you can browse the app by accessing the site contents.

Thursday, April 21, 2016

JSON Light support in REST SharePoint API

Option 1: verbose

Option 2: minimalmetadata

Option 3: nometadata

Option 4: Don’t provide it

Saturday, August 22, 2015

Installing and Configuring SharePoint 2013 and SharePoint Farm

Thursday, May 28, 2015

Get a one year free Office 365 developer account

Friday, May 1, 2015

SharePoint 2013 REST – Internet Explorer does not support this feed format

Enabling the Developer Site Collection Feature in SharePoint On-premises / Online

Tuesday, April 28, 2015

VS2013 Web Essentials - Zen Coding is a huge time saver for web developers

Friday, December 26, 2014

Adding Content Editor Web Part to Page in SharePoint programmatically

Sunday, December 7, 2014

Enforce Drag and Drop documents to apply metadata

Tuesday, December 2, 2014

CAML Query Joins and Projections

Wednesday, November 12, 2014

How to programmatically set a content type as default content type in a SharePoint 2013 List

Tuesday, November 11, 2014

Code Samples – SharePoint 2013 .Net Client Side Object Model

Thursday, November 6, 2014

Tools for your SharePoint 2013 development toolbox

Monday, November 3, 2014

How to publish provider hosted app in SharePoint online

Follow Us

Facebook

Recent

Featured

Contact Form

Subscribe Us

Subscribe to my Newsletter

Blog Archive

Recent Post

Tags

Recent Comments