IDM Knowledge Share – Team Collaboration in Office 365

I will be conducting a workshop on “Team Collaboration in Office 365”, as a part of IDM Knowledge Share.

Date: 29^th of October 2017

Time: 10 am to 12 noon

Venue: IDM Nations Campus, Kotahena

Event Post Url: https://www.facebook.com/idmnc/posts/1586187304737107

Updated On: 29^th of October 2017
Slide deck used for the event

Team Collaboration in Microsoft Office 365 from Suhail Jamaldeen

Some clicks during the event

Convert SharePoint Online based SharePoint Hosted Add-in to SharePoint 2013 On premises based one

Introduction

We used SharePoint Online based template in Visual Studio 2015 in order to develop SharePoint hosted add-in.

Problem

Our client’s requirement is to deploy it in the SharePoint 2013 On premise. So we had to convert the solution.

Solution

Step 01:

• Right click on AppManifest.xml and click on View Code.
• Then change the SharePointMinVersion to 15.0.0.0

Step 02:

• Double click on on Package.package under Package folder.
• There you will find SharePoint Product Version. Change it to 15.0.

 

Conclusion

Now you can publish the solution and deploy to SharePoint 2013 On premise.

 

Basic operations in Host Web from Add-in Web using PnP JavaScript Core Library

Introduction

My my previous blogposts I discussed on

1. Use sp-pnp-js with SharePoint hosted Add-in
2. Communicate with Host Web from Add-in Web through PnP JavaScript Core Library

This post will be a continue of the above two posts. In this post we will be addressing the basic operations on SharePoint list items.

Permission

In order to do operations on the list on host web we need to give permission to the List. In our case we have to set the permission “Scope” to “List” and “Permission” as “Manage”. Please refer the image below.

Click on AppManifest.xml –> Permission

Set “Scope” to “List” and “Permission” to “Manage”

The addinWeb will be the Add-in web url and the hostWeb will be the Host Web url. You may download the solution from the link given at the bottom and refer for more.

Add new Item to List

  
    $pnp.sp.crossDomainWeb(addinWeb, hostWeb).lists.getByTitle("List1").items.add({
        Title: "Title"
    }).then(function (result) {
        alert("Item Added");
        //"result" will return couple of properties of newly created item. We can make use of them here
        console.log(result.data);
        console.log(result.data.Id);
    }).catch(function (err) {
        alert(err);
    });

Update existing Item

  
    //Get the item By Id and call the update
    $pnp.sp.crossDomainWeb(addinWeb, hostWeb).lists.getByTitle("List1").items.getById(2).update({
        Title: "Title Update"
    }).then(function (result) {
        alert("Item Updated");
        $("#message").html("Item Updated");
        //"result" will return couple of properties of updated item.
        console.log(result.data);
        console.log(result.data.Id);
    }).catch(function (err) {
        alert(err);
    });

Delete a exiting Item

  
 //Get the item By Id and call delete
    $pnp.sp.crossDomainWeb(addinWeb, hostWeb).lists.getByTitle("List1").items.getById(2).delete().then(function (result) {
        alert("Item Deleted");
        $("#message").html("Item Updated");
    }).catch(function (err) {
        alert(err);
    });

Using the above code snippet you can do the basic operations.

Conclusion

Hit F5 and you will prompt to Trust and select the List you want  give the permission to.

Select the List name from the dropdown and Click on “Trust”.

You can download the code from the below.

https://drive.google.com/file/d/0ByEnOE8DAdvhSUhHWEJuTzBTUm8/view?usp=sharing

Reference

https://github.com/SharePoint/PnP-JS-Core/wiki/Working-With:-Items

How to disable client side people picker using JQuery in SharePoint 2013 | SharePoint Online

Problem

I had created SharePoint people picker using the example from msdn in my aspx page. I had to disable people picker through JQuery in order to full fill my client’s requirement.

Solution

According to above mentioned msdn post people picker is initiated on.

  <div id="peoplePickerDiv"></div>

So the id of the div is peoplePickerDiv. So with that I will show the solution.

Step 1:

Create an object of people picker.

  var peoplePicker = this.SPClientPeoplePicker.SPClientPeoplePickerDict.peoplePickerDiv_TopSpan;

Step 02:

Set Enable state to fasle.

peoplePicker.SetEnabledState(false);

This will disable the people picker. But you can remove the people objects with X sign. So in Step three we have to remove X.

Step 03:

Remove the X image.

$('#peoplePickerDiv_TopSpan_ResolvedList').find('.sp-peoplepicker-delImage').hide();

Conclusion

Now the people picker is disabled.

Client Side Rendering using JSLink – Post 03 – Properties to override

Introduction

Read my first two post in order to get basics idea on Client Side rendering using JSLink.

• Client Side Rendering using JSLink – Post 01 – Starting Over
• Client Side Rendering using JSLink – Post 02 – Customize List Forms

In last two post we discussed basics on JSLink. Now lets look bit deeper. In this post I will illustrate; what are the fields we can override and use in template. I will give you examples for each and every property. Below are the properties that we can use to override in our custom template.

• Header
• Footer
• View
• Body
• Group
• Item
• Fields
• OnPreRender
• OnPostRender

I have created an announcement list instance in order to illustrate the examples. My list instance displays as follows. Please note that I have grouped the list items by Created.

I have linked my JavaScript file for the above list instance. Now lets get into the examples.

Header

Overrides the Header of the list instance. The header area is described by the below image.

Code

1. (function () {
2.     // Initialize the variable that stores the objects.
3.     var overrideCtx = {};
4.     overrideCtx.Templates = {};
5.  
6.     // Change the header
7.     overrideCtx.Templates.Header = "<b>This is a custom header</b>";
8.  
9.     // Register the template overrides.
10.     SPClientTemplates.TemplateManager.RegisterTemplateOverrides(overrideCtx);
11. })();

Results

Footer

We can add a footer in the list instance.

Code

1. (function () {
2.     // Initialize the variable that stores the objects.
3.     var overrideCtx = {};
4.     overrideCtx.Templates = {};
5.  
6.     // Change the footer
7.     overrideCtx.Templates.Footer = "<b>This is a custom footer</b>";
8.  
9.     // Register the template overrides.
10.     SPClientTemplates.TemplateManager.RegisterTemplateOverrides(overrideCtx);
11. })();

Results

Fields

Visit my first blog post and see the example. You can understand how to override the fields. If you want to retrieve the actual value of a field you can retrieve by  “<#= ctx.CurrentItem.FieldName#>” or by ctx.CurrentItem.FieldName.

Code

1. (function () {
2.     // Initialize the variable that stores the objects.
3.     var overrideCtx = {};
4.     overrideCtx.Templates = {};
5.  
6.     overrideCtx.Templates.Fields = {
7.         'Body': { 'View': '<div style="color:red; background-color: green"><#= ctx.CurrentItem.Body #></div>' }
8.     };
9.  
10.     // Register the template overrides.
11.     SPClientTemplates.TemplateManager.RegisterTemplateOverrides(overrideCtx);
12. })();

Results

Group

Overriding Group takes 7 parameters. Using those parameters you can change the look and feel of the group. I will just show you a basic.

Code

1. (function () {
2.     // Initialize the variable that stores the objects.
3.     var overrideCtx = {};
4.     overrideCtx.Templates = {};
5.  
6.     overrideCtx.Templates.Group = customGroup;
7.     // Register the template overrides.
8.     SPClientTemplates.TemplateManager.RegisterTemplateOverrides(overrideCtx);
9. })();
10.  
11. function customGroup(ctx, group, groupId, listItem, listSchema, level, expand) {
12.     var html = '<div style="color:red">' + listItem[group] + ' </div>';
13.     return html;
14. }

Results

Body

Overrides the body.

Code

1. (function () {
2.     // Initialize the variable that stores the objects.
3.     var overrideCtx = {};
4.     overrideCtx.Templates = {};
5.  
6.     overrideCtx.Templates.Body = customBody;
7.     // Register the template overrides.
8.     SPClientTemplates.TemplateManager.RegisterTemplateOverrides(overrideCtx);
9. })();
10.  
11. function customBody(ctx) {
12.  
13.     return String.format("Hello world from {0}", ctx.ListTitle);
14.  
15. }

Results

 

Item

The Item template points to the function that displays each Item in the list.

Code

1. (function () {
2.     // Initialize the variable that stores the objects.
3.     var overrideCtx = {};
4.     overrideCtx.Templates = {};
5.    
6.     overrideCtx.Templates.Header = "<B><#=ctx.ListTitle#></B>" +
7.         "<ul>";
8.  
9.     // This template is assigned to the CustomItem function.
10.     overrideCtx.Templates.Item = customItem;
11.     overrideCtx.Templates.Footer = "</ul>";
12.  
13.  
14.  
15.     // Register the template overrides.
16.     SPClientTemplates.TemplateManager.RegisterTemplateOverrides(overrideCtx);
17. })();
18.  
19. // This function builds the output for the item template.
20. // It uses the context object to access announcement data.
21. function customItem(ctx) {
22.     // Build a listitem entry for every announcement in the list.
23.     var ret = "<li>" + ctx.CurrentItem.Title + "</li>";
24.     return ret;
25. }

Results

OnPreRender

OnPreRender event fires before the DOM is loaded. In my example I will show how to set a custom list name.

Code

1. (function () {
2.     // Initialize the variable that stores the objects.
3.     var overrideCtx = {};
4.     overrideCtx.Templates = {};
5.  
6.     //Over ride the header
7.     overrideCtx.Templates.Header = "<#=ctx.ListTitle#>";
8.  
9.     //Set the List title on pre render event
10.     overrideCtx.OnPreRender = function a() {
11.         ctx.ListTitle = "Title from PreRender";
12.     };
13.  
14.     // Register the template overrides.
15.     SPClientTemplates.TemplateManager.RegisterTemplateOverrides(overrideCtx);
16. })();

Results

 

OnPostRender

OnPostRender event fires after DOM is loaded. So you can change the values after DOM load. Here in our example I have changed the background color.

Code

1. (function () {
2.     // Initialize the variable that stores the objects.
3.     var overrideCtx = {};
4.     overrideCtx.Templates = {};
5.     //OnPostRender call postRenderHandler function.
6.     overrideCtx.OnPostRender = postRenderHandler;
7.  
8.     // Register the template overrides.
9.     SPClientTemplates.TemplateManager.RegisterTemplateOverrides(overrideCtx);
10. })();
11. function postRenderHandler(ctx) {
12.     var rows = ctx.ListData.Row;
13.     for (var i = 0; i < rows.length; i++) {
14.         var isApproved = rows[i]["Title"] == "Title 001";
15.         if (isApproved) {
16.             var rowElementId = GenerateIIDForListItem(ctx, rows[i]);
17.             var tr = document.getElementById(rowElementId);
18.             tr.style.backgroundColor = "#ada";
19.         }
20.     }
21. }

Results

`

Conclusion

So the basics are covered and if you are familiar with JavaScript and CSOM you can do more on Client side rendering with JSLink.  In future posts I will show some examples how you can use client side rendering.

Client Side Rendering using JSLink – Post 02 – Customize List Forms

Introduction

In my last post I described how to startup with Client Side Rendering using JSLink with basic example. In this post I will describe “What are the places you can deploy JavaScript files in order to use in SharePoint development” and “How can we use rendering; in order to customize list forms”.

What are the places you can deploy JavaScript files in order to use in SharePoint development?

In my last post I had used layouts folder which is inside the 15 hive. But there are more options where we can deploy JavaScript files in order to use them in JSLink property. So these option can be useful for the developers who want to develop SharePoint hosted apps and who don’t have the access to local file system. JSLink property accepts below SharePoint tokens.

~site – The URL of the current website. (Recommended to use in SharePoint hosted apps development)

~sitecollection – The URL of the parent site collection of the current website.

~layouts – The URL of the Layouts virtual folder for the current website. You don’t have to worry about 14 hive or 15 hive.

~sitecollectionlayouts – The URL of Layouts folder in the current site collection (/sites/spsite/_layouts/15)

~sitelayouts – The URL of Layouts folder in the current site (/spsite/spweb/_layouts/15)

If you want to use multiple JavaScript file on a single JSLink property you can use “|” symbol.

Eg. ~layouts/folder001/test.js | ~layouts/folder002/test.js

How can we use rendering in order to customize list forms?

In the first post I described how to customize the default view form. In this post I will describe how to customize New form, Edit form and the Display form by changing the scope in JavaScript. I will show how to customize the New form and you can use the same for other forms as well.

Solution

1. (function () {
2.  
3.     //   Initialize the variables for overrides objects
4.     var overrideCtx = {};
5.     overrideCtx.Templates = {};
6.     overrideCtx.BaseViewID = "NewForm";
7.     overrideCtx.ListTemplateType = "10000";
8.  
9.     /*
10.    * Using the Fields override leaves the rest of the rendering intact, but
11.    * allows control over one or more specific fields in the existing view
12.    */
13.     overrideCtx.Templates.Fields = {
14.         'Title': { 'NewForm': 'Custom' }
15.     };
16.  
17.     /*  
18.      * Register the template overrides.
19.      */
20.     SPClientTemplates.TemplateManager.RegisterTemplateOverrides(overrideCtx);
21.  
22. })();

In the above code

BaseViewID: The form type. This can be NewForm, EditForm, DisplayForm.

ListTemplateType: This is List Template type. You can see your list template type in Elements.xml file belonging to the list definition in Visual Studio.

The above JavaScript code shows how to modify the title value in the form.

Now you can save the JavaScript file in any locations as said under first heading.

We have one more thing to do. Reference the JavaScript file with the list for new form. 

Method 01 – Declaratively

I will show how to define JSLink in SPList Schema.xml file.

1. Open the schema of List definition in your visual studio solution
2. There at the bottom you can find the types of form.

3. Add a new property as JSLink and  give the location as mentioned below.

Now deploy the solution.

Method 02 – Programmatically in C#

Now I will show how to add JSLink property to NewForm programmatically through C#.

1. SPWeb spWeb = SPContext.Current.Web;
2.             SPList spList = spWeb.Lists.TryGetList("List Name");
3.             SPForm newForm = spList.Forms[PAGETYPE.PAGE_NEWFORM];
4.             SPFile page = spWeb.GetFile(newForm.Url);
5.             using (SPLimitedWebPartManager wpManager = page.GetLimitedWebPartManager(PersonalizationScope.Shared))
6.             {
7.                 // Enable Update
8.                 wpManager.Web.AllowUnsafeUpdates = true;
9.  
10.                 //Check out the file
11.                 SPFile file = wpManager.Web.GetFile(newForm.Url);
12.                 if (file.CheckOutType == SPFile.SPCheckOutType.None)
13.                     file.CheckOut();
14.  
15.  
16.                 foreach (WebPart webpart in wpManager.WebParts)
17.                 {
18.                     if (webpart is ListFormWebPart)
19.                     {
20.                         var listFormWebPart = (ListFormWebPart)webpart.WebBrowsableObject;
21.                         listFormWebPart.TemplateName = "ListForm";
22.                         listFormWebPart.JSLink = "/_layouts/15/CSR002/test.js";
23.                         wpManager.SaveChanges(listFormWebPart);
24.                     }
25.                 }
26.  
27.                 // Update  file
28.                 file.Update();
29.                 file.CheckIn("Added JSLink");
30.                 wpManager.Web.AllowUnsafeUpdates = false;
31.             }

Actually what we are doing is – we are setting the value to JSLink property in web part on NewForm.aspx page.

The code below will NOT WORK.

1. SPWeb spWeb = SPContext.Current.Web;
2.             SPList spList = spWeb.Lists.TryGetList("CustomList002");
3.             SPForm newForm = spList.Forms[PAGETYPE.PAGE_NEWFORM];
4.             if (null != newForm)
5.             {
6.                 newForm.JSLink = "/_layouts/15/CSR002/test.js";
7.             }
8.             spWeb.AllowUnsafeUpdates = true;
9.             spList.Update();
10.             spWeb.AllowUnsafeUpdates = false;

Method 03 – Browser user interface

Go to the NewForm.aspx page where we try to add new item by clicking add new item button. Please refer my first post where I have described how to set JSLink property.

Conclusion

Once we deploy and give reference to our JavaScript file we can see that our Title value is changed to the customized value.

Keep in touch. I will cover more advanced topics on this.

Add, Update and Delete SPListItem in SPList using JavaScript Object Model

Introduction

One person commented that - he needs to know How to Add, Update and Delete SPListItem in a SPList using JavaScript Object Model in a previous blog post. So I thought of writing a post for him; and which may useful for other new SharePoint newbies too.

Solution

Add

1. function Add() {
2.     var clientContext = new SP.ClientContext();
3.     var oWeb = clientContext.get_web();
4.     var oList = oWeb.get_lists().getByTitle('List1');//Get SPList by Title
5.     var itemCreateInfo = new SP.ListItemCreationInformation();
6.  
7.     var oListItem = oList.addItem(itemCreateInfo);
8.     oListItem.set_item('Title', 'Value'); //Title is the field and Value is the value for field
9.     oListItem.update();
10.  
11.     clientContext.load(oListItem);
12.     clientContext.executeQueryAsync(Function.createDelegate(this, onQuerySucceeded), Function.createDelegate(this, onQueryFailed));
13.  
14.     //Function when the execution of the query successed
15.     function onQuerySucceeded(sender, args) {
16.         alert('Data ADDED successfully');
17.     };
18.     //Function to run when the execution falis
19.     function onQueryFailed(sender, args) {
20.         alert('Cannot ADD');
21.     };
22.  
23. };

Update

1. function Update() {
2.     var clientContext = new SP.ClientContext();
3.     var oWeb = clientContext.get_web();
4.     var oList = oWeb.get_lists().getByTitle('List1');//Get SPList by Title
5.  
6.     var oListItem = oList.getItemById(1);//Get the list item by id
7.     oListItem.set_item('Title', 'New Value');
8.     oListItem.update();
9.     clientContext.executeQueryAsync(Function.createDelegate(this, onQuerySucceeded), Function.createDelegate(this, onQueryFailed));
10.  
11.     //Function when the execution of the query successed
12.     function onQuerySucceeded(sender, args) {
13.         alert('Data UPDATED successfully');
14.     };
15.     //Function to run when the execution falis
16.     function onQueryFailed(sender, args) {
17.         alert('Cannot UPDATE');
18.     };
19. };

Delete

1. function Delete() {
2.     var clientContext = new SP.ClientContext();
3.     var oWeb = clientContext.get_web();
4.     var oList = oWeb.get_lists().getByTitle('List1');//Get SPList by Title
5.  
6.     var oListItem = oList.getItemById(1);//Get the list item by id
7.    oListItem.deleteObject();
8.     clientContext.executeQueryAsync(Function.createDelegate(this, onQuerySucceeded), Function.createDelegate(this, onQueryFailed));
9.  
10.     //Function when the execution of the query successed
11.     function onQuerySucceeded(sender, args) {
12.         alert('Data DELETED successfully');
13.     };
14.     //Function to run when the execution falis
15.     function onQueryFailed(sender, args) {
16.         alert('Cannot DELETE');
17.     };
18. };

You can download the entire solution from the below url. https://drive.google.com/file/d/0ByEnOE8DAdvhSWFfM0Jja1FHMms/edit?usp=sharing

Get SPList items (by CAML query) using JavaScript in SharePoint Apps

Introduction

Today I will show how to get SPList Items by filtering using CAML query. Also this post includes how to get the data from a custom field.

Solution Background

I use JQuery.Deferred and Promise in order to achieve the success and failure of the asynchronous call. There are plenty of articles on the internet regarding JQuery.Deferred. Please see the Reference section for more on this.

Solution

1.   function query() {
2.  
3.             var camlQuery =
4.                 "<Where>" +
5.                 "<Neq>" +
6.                 "<FieldRef Name='CustomFieldOne' />" +
7.                 "<Value Type='Text'>Suhail Jamaldeen</Value>" +
8.                 "</Neq>" +
9.                 "</Where>";
10.  
11.             //Calling the method getListItemsByCAMLAsync.
12.             //Here the fail and done methods are from the deffered object which is returning.
13.             getListItemsByCAMLAsync('NameOfList', camlQuery, 'Include(DisplayName, Id, CustomFieldOne)')
14.                     .fail(function (e) {
15.                         alert((handeler.parseSPException(e)));
16.                     }).done(function (items) {
17.                         var enu = items.getEnumerator();
18.                         while (enu.moveNext()) {
19.                             var cu = enu.get_current();
20.                             var id = cu.get_id();//Read the Id
21.                             alert(id);
22.                             var prope = cu.get_fieldValues();//You can see the fields which you are retreiving
23.                             var initiator = cu.get_fieldValues().CustomFieldOne;//Readvalue from custom property (Single line)
24.                             alert(initiator);
25.                         }
26.                     });
27.  
28.         };
29.  
30.         //This returns a deferred object.
31.         function getListItemsByCAMLAsync(listName, query, fieldsFilter) {
32.             var def = $.Deferred();
33.             var clientContext = new SP.ClientContext();
34.             var oWeb = clientContext.get_web();
35.             var ol = oWeb.get_lists().getByTitle(listName);
36.             var qry = new SP.CamlQuery();
37.             qry.set_viewXml(query);
38.             var items = ol.getItems(qry);
39.  
40.             clientContext.load(items, fieldsFilter);
41.             clientContext.executeQueryAsync(function () {
42.                 def.resolve(items);
43.             },
44.                 function (a, b) {
45.                     def.reject(b);
46.                 });
47.             return def.promise();
48.         };

Reference

http://sharepoint.stackexchange.com/questions/69878/how-to-use-client-object-model-javascript-to-get-a-custom-user-profile-propert

http://api.jquery.com/category/deferred-object/

http://www.htmlgoodies.com/beyond/javascript/making-promises-with-jquery-deferred.html

Conclusion

Should say Melick (http://melick-rajee.blogspot.com) for the guide on SharePoint Apps.