Tuesday, February 18, 2014

Filter List items by Data Table - JQuery, REST API, AJAX and Datatables















Make a REST API call to retrieve SharePoint list items.
Returns JSON Objects array
Call DataTable to display in Tabular Format.
Add additional logic to show/hide additional details for a particular row.



Implementation:

(1) Create a list with Four columns and some test data Co11, Col2, Col3, Col4.
(2) Create a new page and add Script Editor WebPart.



<script type="text/javascript" charset="utf8" src="http://ajax.aspnetcdn.com/ajax/jQuery/jquery-1.8.2.min.js"></script>
<link rel="stylesheet" type="text/css" href="http://ajax.aspnetcdn.com/ajax/jquery.dataTables/1.9.4/css/jquery.dataTables.css">
<script type="text/javascript" charset="utf8" src="http://ajax.aspnetcdn.com/ajax/jquery.dataTables/1.9.4/jquery.dataTables.min.js"></script>



//Create User Interface to filter/search through results

Search for List of Technologies here:
<br></br> 
    <input type="text" id="techsearch" >
    <input type="button" value="Search" onclick="LoadTechnologies($('#techsearch').val());" >      
<br></br><br></br>


<div id="dynamictable"></div>



<br></br><br></br>


<style>
tr span.expand {
  width: 20px;
  height: 20px;
  background-image: url('http://www.datatables.net/release-datatables/examples/examples_support/details_open.png');
  display:inline-block;
  vertical-align: middle;
  margin-right: 5px; 
}

tr span.open {
  background-image: url('http://www.datatables.net/release-datatables/examples/examples_support/details_close.png'); 
}

div.expand-wrapper{
  white-space:nowrap; 
}

</style>



<script type="text/javascript">


 


$(document).ready(function(){

            var techsearch = null;  
            var data = null;
            var TechTable = null;
            LoadTechnologies(techsearch);
           
    

    });    //jquery function

    function LoadTechnologies(techsearch) {
               
    
      var data2 =  $.ajax(
       {
 //Build URL with select columns to display and can add additional filter by conditions
         url: _spPageContextInfo.webAbsoluteUrl + "/_api/Web/Lists/GetByTitle('ListName')/items?$select=Title,Vendor,Domain1,SubDomain1,ID,Description", 
         type: "GET",
        dataType: "json",
        headers: { Accept: "application/json;odata=verbose" }
   }
);// end ajax


   
     data2.done(function (data,textStatus, jqXHR)
      {
                                                
    var test2 = jQuery.parseJSON(  jqXHR.responseText.replace("]}}","]").replace("{\"d\":{\"results\":","")  );
                       // alert("First row title is: " + test2[1].Title);

// Cleanup - Remove any children under Dynamic Table (To remove results after first load)
 $("#dynamictable").children().remove();
//Create a Table interface depending on how you want to display returned list results            
                       $('#dynamictable').append('<table id="table1" cellspacing="0" cellpadding="4" width="100%"></table>');
                      
var table = $('#dynamictable').children();   
table.append("<thead><tr><td><b>Name of Technology </b></td> <td><b>Vendor</b></td>   <td><b>Domain</b></td>  <td><b>SubDomain</b></td>  <td></td>  </th></tr></thead><tbody></tbody>");





                       
               
$(function()
                  {
     
                    
                        $.fn.dataTableExt.sErrMode = 'throw' ;

                        //Function formatting to show what additional details to show when you click to Expand
                        function fnFormatDetails(oTable, nTr) {
   
                              var aData = oTable.fnGetData(nTr);
                              var sOut = '<table cellpadding="8" bgcolor="rgb(255,160,0)" border="0" style="padding-left:50px;">';
                                  sOut += '<tr><td>Description: </td><td>' + aData.Description + '</td></tr>';
                           
           
                 return sOut;
                           }


             
                     //Binding to DataTable to show results in a tabular format
                        var TechTable = $('#table1').dataTable({
   
                                  
                                   sDom: '<"top"if>rt<"bottom"lp><"clear">',
                                  oLanguage:      {   sInfoEmpty: " ",
    
                                                       sZeroRecords: " No Technologies registered with the keyword you searched for",             
                                                       sSearch: "Filter Results:"
                                                }, 

                                   bDestroy:true,
                                   bJQueryUI: true,
                                   bProcessing: true,
                                   bFilter: true,
                                   bPaginate: true,   //pagination
                                   aaData: test2,      //test2 is parsed JSON data                                                      
                                   //aaSorting: [[0, 'desc']],
                                   aoColumns: [
                                                { mData: 'Title', bSearchable: true,  bSortable: true,
                                                   sContentPadding: "aaaaaaaaaaaaaa",
                                                   mRender:expandRenderer
                                                 },
                                                 { mData: 'Vendor'},
                                                 { mData: 'Domain1'},
                                                 { mData: 'SubDomain1'},
                                                 { mData: function (source, type, val)
                                                                {//Create Hyperlinks on returned data
                           return "<a href='Site/Subsite/TRTesting.aspx?BusinessUnit=" + source.ID + "' target='_blank'>Register</a>";
                                                                }
                                                 }           
                                               ] //end aoColumns
                                   });   // Techtable


                function expandRenderer(data, type, full)
                          {
                             // console.log(arguments);
                            switch(type) {
                   case 'display':
      return '<div class="expand-wrapper"><span class="expand"></span><span class="data">'+data+'</span></div>';
                 case 'type':
                 case 'filter':
                 case 'sort':
                               return data;
                       }  // end switch
                          }  // end expandRenderer

             
//For Show/Hide additional row details       
                 $('#table1 tbody').on('click', 'td span.expand', function() {
 
                                 var nTr = $(this).parents('tr')[0];
                                  if (TechTable.fnIsOpen(nTr))
                                   {
                                          $(this).removeClass('open');
                                         TechTable.fnClose(nTr);
                                   }
                                   else
                                   {
                                         $(this).addClass('open');
                                        TechTable.fnOpen(nTr, fnFormatDetails(TechTable, nTr), 'details');
                                      }
                               });


                          
 

                     
});  // end function
           
                       
      
                   }); //end data2 done function
  



}

 
</script>


Additional Reference:
http://kalashnikovtechnoblogs.blogspot.in/2015/09/get-data-in-jquery-datatable-from.html

Friday, February 14, 2014

Hiding a Section based on Multi Select List Box selected value and Promoting it to a List



(1) Promoting
Create a Hidden field and calculate its value using the formula below and promote
eval(eval(MultiSelectField[. != ""], 'concat(., ", ")'), "..")













(2) Hiding section based on MSLB value
 when you set up the condition, select "Select a field or group..." from the left dropdown, select the MSLB's field, and before confirming the Select a Field or Group dialog, pick All occurrences of ___ from the dropdown(one more below).




Friday, January 10, 2014

SharePoint 2013 Rest API Filter Document Library by Title, Id, AuthorId, EditorId, GUID

To Show all the requests Created by logged in user in a Document Library



(1) By Author/Logged in user:

//Finding Id by logged in user: (In jQuery Document ready function)

var userId = _spPageContextInfo.userId;
// alert("User Id is: " + userId);

EndPoint:

"http://server/sites/subsite/_api/web/lists/getbytitle('DocLibName')/items?$select=Title,AuthorId, EditorId, Column1, Column2 &$filter= Author/Id eq " + userId

AuthorId = Created By
EditorId = Modified By
For filter use Author/Id 

(2) By Id
http://Server/sites/Site/_api/web/lists/getbytitle(DocLibName)/items('41')/File?$select=Title
  --- 41 is the Id

(3) By Guid
http://Server/sites/Site/_api/Web/Lists(guid'YourLibraryGUID')/Items/?$select=Title,Column1,Column2 &$filter= Author/Id eq 2

 --- Displays items Created by user with Id 2

Thursday, December 26, 2013

SharePoint 2013 Rest API Search through List and filter by multiple columns


(1) In the Webpart page, add a script editor webpart
(2) Paste the code shown below in the Editor.
(3) Search the Columns  ( * Filter by word containging the searched word in Column1 or Column2)
(4) Results shown in DataTable
(5) Search results can be filtered through another searchbox.
(6) Changes to be made are Highlighted in blue



Original Post by: Mark Rackley
http://summit7systems.com/who-needs-a-data-view-web-part-sharepoint-rest-and-datatables-net/


SearchList
Search through a list by Column1 or Column2



<!-- jQuery -->
<script type="text/javascript" charset="utf8" src="http://ajax.aspnetcdn.com/ajax/jQuery/jquery-1.8.2.min.js"></script>
<!-- DataTables CSS -->
<link rel="stylesheet" type="text/css" href="http://ajax.aspnetcdn.com/ajax/jquery.dataTables/1.9.4/css/jquery.dataTables.css">

<!-- DataTables -->
<script type="text/javascript" charset="utf8" src="http://ajax.aspnetcdn.com/ajax/jquery.dataTables/1.9.4/jquery.dataTables.min.js"></script>
       <input type="text" id="techsearch" >
       <input type="button" value="Search" onclick="LoadTechnologies($('#techsearch').val());" >




<table width="100%" cellpadding="0" cellspacing="0" border="0" class="display" id="TechTable">
    <thead>
        <th>Name of the Technology</th>
        <th>Vendor</th>
        <th>Green Listed</th>

    </thead>
</table>


<script type="text/javascript">

     function LoadTechnologies(techsearch)
      {
      
       alert("Searching by: " + techsearch + " through Technology Title and Vendor in List Name");
       var call = $.ajax(
                       {
                         url: _spPageContextInfo.webAbsoluteUrl + "/_api/Web/Lists/GetByTitle('ListName')/items?$select=Title,Vendor,GreenList&$filter=(substringof('" + techsearch + "', Title) or substringof('" + techsearch + "', Vendor))",
                         type: "GET",
                         dataType: "json",
                         headers: { Accept: "application/json;odata=verbose" }
                       }
        );// end ajax

      call.done(function (data,textStatus, jqXHR)
       {
         $('#TechTable').dataTable(
                       {
                        "bDestroy": true,
                        "bProcessing": true,
                        "aaData": data.d.results,
                        "aoColumns": [ { "mData": "Title" }, { "mData": "Vendor" }, { "mData": "GreenList" } ]
                        }); //end dataTable
       }); //end call done function
     
       call.fail(function (jqXHR,textStatus,errorThrown){ alert("Error retrieving Tasks: " + jqXHR.responseText); }); }
</script>

Tuesday, December 10, 2013

SharePoint 2013 new Menu bar - Using Script Editor CSS HTML




(1) Create a new sharepoint 2013 web page
(2) Add a script editor web part
(3) Insert the code below in the Script Editor
(4) Using F12 - IE Developer Toolbar identify the right DIV,UL,LI tags and change corresponding styles below.

Reference: http://www.mrc-productivity.com/techblog/?p=1049
Thanks to Steve.



<div id="wrap">
    <ul class="navbar">
    <li><a href="#">Home</a></li>
    <li><a href="#">Menu Item 2</a>
    <ul>
       <li><a href="#">2a</a></li>
       <li><a href="#">2b</a></li>
    </ul>        
    </li>
    <li><a href="#">Menu Item 3</a>
    <ul>
       <li><a href="#" >3a</a></li>
    </ul>        
    </li>
    <li><a href="#">Menu Item 4</a>
    <ul>
       <li><a href="#">4a</a></li>
       <li><a href="#">4b</a></li>
       <li><a href="#">4c</a></li>
    </ul>        
    </li>
    </ul>
</div>
<style>
#wrap {
 width: 100%; /* Spans the width of the page */
 height: 40px;
 margin: 0; /* Ensures there is no space between sides of the screen and the menu */
 z-index: 99; /* Makes sure that your menu remains on top of other page elements */
 position: relative;
 /*background-color: #366b82;*/
 }
.navbar {
 height: 40px;
        padding: 0;
 margin: 0;
 position: absolute; /* Ensures that the menu doesn’t affect other elements */
 border-right: 1px solid #54879d;
 }
.navbar li  {
   height: auto;
   width: 150px;  /* Each menu item is 150px wide */
   float: left;  /* This lines up the menu items horizontally */
   text-align: center;  /* All text is placed in the center of the box */
   list-style: none;  /* Removes the default styling (bullets) for the list */
   font: normal bold 12px/1.2em Arial, Verdana, Helvetica; 
   padding: 0;
   margin: 0;
   background-color: #FFA000;
                        }

.navbar a {    
  padding: 18px 0;  /* Adds a padding on the top and bottom so the text appears centered vertically */
  border-left: 1px solid #54879d; /* Creates a border in a slightly lighter shade of blue than the background.  Combined with the right border, this creates a nice effect. */
  border-right: 1px solid #1f5065; /* Creates a border in a slightly darker shade of blue than the background.  Combined with the left border, this creates a nice effect. */
  text-decoration: none;  /* Removes the default hyperlink styling. */
  color: white; /* Text color is white */
  display: block;
  }
.navbar li:hover, a:hover {background-color: #0023a0;}  /*54879d; light blue - #667BC6 */

.navbar li ul  {
  display: none;  /* Hides the drop-down menu */
  height: auto;      
  margin: 0; /* Aligns drop-down box underneath the menu item */
  padding: 0; /* Aligns drop-down box underneath the menu item */
  } 

.navbar li:hover ul  {
                        display: block; /* Displays the drop-down box when the menu item is hovered over */
                        }

.navbar li ul li {background-color: #0023a0;}   /*54879d */

.navbar li ul li a  {
  border-left: 1px solid #1f5065;
  border-right: 1px solid #1f5065;
  border-top: 1px solid #74a3b7;
  border-bottom: 1px solid #1f5065;
  }
 
.navbar li ul li a:hover {
  background-color: #667BC6;
  }   /*366b82;   light blue - #667BC6 */
</style>

Tuesday, January 22, 2013

SP 2010 Powershell Script Commands for Deployment Process

Adding SPSolution
Add-SPSolution -LiteralPath "solution path\solutionname.wsp"

Install SPSolution
Install-SPSolution -Identity "solutionname.wsp" –GACDeployment.

Upgrade the Existing Solution
Update-SPSolution -Identity "solutionname.wsp" -LiteralPath "solutionpath\solutionname.wsp" -GACDeployment

UnInstall the SPSolution
Uninstall-SPSolution -Identity "solutioname.wsp"

Remove the SPSolution
Remove-SPSolution -Identity "solutioname.wsp"

Deploy the feature to a particular site collection
Enable-SPFeature -Identity "featurefoldername" -url "sitecurl"

Activate the feature to a particular site collection
Install-SPFeature -path "featurefoldername"

Deactivate the feature from a particular site collection
Uninstall-SPFeature -path "featurefoldername"

Remove the feature from a particular site collection
Disable-SPFeature -Identity "featurefoldername" -url "siteurl"

Note: The below mentioned command is used to get all the features which have not been installed so far but presents in the environment and if the user will run this command without -Whatif then it will install all the features which are present but not installed yet.
Install-SPFeature -AllExistingFeatures -Whatif

Sunday, January 20, 2013

Adding a Button to SharePoint 2010 Ribbon


 

How to Add Button to Ribbon – Create new SharePoint project and  Add a new item of the type "Empty Element" to the project and Update the xml with the file below.
Elements.xml  (SPRibbonUpdateToProd)

<?xml version="1.0" encoding="utf-8"?>
  <CustomAction Id="DocFinalRibbon" Location="CommandUI.Ribbon">
    <CommandUIExtension>
      <CommandUIDefinitions>
        <CommandUIDefinition Location="Ribbon.Documents.Manage.Controls._children">
          <Button
            Id="WF.Ribbon.Documents.Manage.UpdateToProd"
            Sequence="40"
            Command="WF.Ribbon.Documents.Manage.UpdateToProd.cmdUpdateToProd"
            Image16by16="/_layouts/1033/images/formatmap16x16.png" Image16by16Top="-144" Image16by16Left="0"
            Image32by32="/_layouts/1033/images/formatmap32x32.png" Image32by32Top="-128" Image32by32Left="-256"
            LabelText="Publish to Prod"
            ToolTipTitle="Click button to Publish to Prod"
            ToolTipDescription="Once you click this button, your checked items are pushed to Prod "
            TemplateAlias="o1"/>
        </CommandUIDefinition>
      </CommandUIDefinitions>
      <CommandUIHandlers>
        <CommandUIHandler
          Command="WF.Ribbon.Documents.Manage.UpdateToProd.cmdUpdateToProd"
         CommandAction="javascript:MarkStatusProduction('{SelectedItemId}');"
          EnabledScript="javascript:function singleEnable()
          {
            var items = SP.ListOperation.Selection.getSelectedItems();
            var ci = CountDictionary(items);
            return (ci == 1);
          }
          singleEnable();"/>

      </CommandUIHandlers>
    </CommandUIExtension>
  </CustomAction>
  <Control Id="AdditionalPageHead" ControlSrc="~/_controltemplates/MarkStatusProduction.ascx" Sequence="40"/>
</Elements>







Check to make sure only one item is selected & Enable ribbon only on single select

<CommandUIHandlers>
<
CommandUIHandler Command="SingleSelectButtonCommandAction="javascript:alert('There is only one thing selected!');EnabledScript="javascript:function singleEnable()
{
var items = SP.ListOperation.Selection.getSelectedItems();
var ci = CountDictionary(items);
return (ci == 1);
}
singleEnable();
" />
</
CommandUIHandlers>



Update selected list item with Update Status ( Any Column with some value)

New Project Ã  Add new item (user control) and update with this code.
UserControl (MarkStatusProduction.ascx) and move it to Control templates folder (not in subfolder name of project), no need .ascx.cs file update, as we write the update code here.

<%@ Assembly Name="$SharePoint.Project.AssemblyFullName$" %>
<%@ Assembly Name="Microsoft.Web.CommandUI, Version=14.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>
<%@ Register Tagprefix="SharePoint" Namespace="Microsoft.SharePoint.WebControls" Assembly="Microsoft.SharePoint, Version=14.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>
<%@ Register Tagprefix="Utilities" Namespace="Microsoft.SharePoint.Utilities" Assembly="Microsoft.SharePoint, Version=14.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>
<%@ Register Tagprefix="asp" Namespace="System.Web.UI" Assembly="System.Web.Extensions, Version=3.5.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35" %>
<%@ Import Namespace="Microsoft.SharePoint" %>
<%@ Register Tagprefix="WebPartPages" Namespace="Microsoft.SharePoint.WebPartPages" Assembly="Microsoft.SharePoint, Version=14.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>
<%@ Control Language="C#" AutoEventWireup="true" CodeBehind="MarkStatusProduction.ascx.cs" Inherits="SPUserControl.ControlTemplates.SPUserControl.MarkStatusProduction" %>



<SharePoint:ScriptLink ID="ScriptLink1" Name="SP.js" runat="server" LoadAfterUI="true" Localizable="false" />
<SharePoint:FormDigest ID="FormDigest1" runat="server" />

<script language="ecmascript" type="text/ecmascript">
    var ticketsList;
    var web;
    var context;
    var ticketId;
    var ticketItem;
    var ticketStatusField = "Status";
    var ticketDoneStatus = "Done";
    var ticketResolvedStatus = "Production";

    function MarkStatusProduction(itemId) {
        ticketId = itemId;

        context = new SP.ClientContext.get_current();
        web = context.get_web();
        ticketsList = web.get_lists().getByTitle("TME");  //TME is the name of list
        ticketItem = ticketsList.getItemById(ticketId);

        // This will make sure the contents of the list and list item are actually loaded
        context.load(ticketsList);
        context.load(ticketItem);
        context.executeQueryAsync(OnTicketsListsLoaded);
    }

    function OnTicketsListsLoaded() {
        var currentStatus = ticketItem.get_item(ticketStatusField);

        // There's no need to continue this method when the status is already set to Production or Live.
        if (currentStatus == ticketResolvedStatus || currentStatus == ticketDoneStatus) {
            return;
        }

        // Set the ticket status field to the Production
        ticketItem.set_item(ticketStatusField, ticketResolvedStatus);
        ticketItem.update();

        // Submit the query to the server
        context.load(ticketItem);
        context.executeQueryAsync(OnTicketUpdated, OnError);
    }

    function OnTicketUpdated(args) {
        // Nothing really needed here other than refreshing the page to see that the change has been made
        window.location.href = window.location.href;
    }

    function OnError(sender, args) {
        alert(args.get_message());
    }
</script>


  


Deactivating feature: ( For any changes to Ribbon button like image, functionality, delete it features folder, do iisreset and deploy code again for these may be with new feature id)

To update the code, deactivate features for usercontrol (MarkStatusProduction) and SPRibbonButton added to Ribbon. ID’s for features are found in Templates\features. Update ID’s in the command below in command prompt.
Ex:
C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\BIN>stsadm.exe -o deactivatefeature -id  "eb6fe60b-fda7-4e40-bc18-ba88f1e9a954" -url http://yourserver/ -force

Thursday, October 18, 2012

SP 2010 Client Object Model with Examples


Brief  discussion about the ECMA script client object model.
Client OM Architecture
Before getting to actual usage we'll take a brief look at the architecture of the Client Object Model to understand how it functions.
Image1.png

As can be seen in the above diagram all versions of the Client OM go through the WCF Web Service namedClient.svc. This Web Service is located, along with all other SharePoint Web Services, in the folder [SharePoint Root]\ISAPI. The Client OM is responsible for packaging any requests into XML and calling the Web Server, however, when this call takes place is controlled by the developer as you will see. The response from the Client.svc Web Service is sent as JSON and the Client OM is responsible for transforming this into appropriate objects for use in the environment the call was made from.

The Client.svc Web Service has one method, ProcessQuery which takes a Stream object, an XML formatted stream as indicated above, and returns a Stream, JSON formatted. The implementation for this method can be found in the assembly Microsoft.SharePoint.Client.ServerRuntime.dll and the private class ClientRquestServiceImpl. Delving into this method, the first thing you find is an authentication check.

The Client OM uses Windows Authentication by default.


ECMAScript Client OM – Is a client object model extension for using JavaScript or JScript. This API is only available for applications hosted inside SharePoint (for example, web part deployed in SharePoint site can use this JavaScript API for accessing SharePoint from browser using JavaScript). You can however use this ECMAScript Client OM in web part pages or application pages (aspx pages) by referencing a javascript file (SP.js).
To use ECMAScript Client OM, add an entry for the below in your web part ascx control (the webparts deisgn interface) or to your content editor webpart’s HTML Source.

<script src=”/_layouts/SP.js” type=”text/ecmascript”></script>

Also, if If your code modifies SharePoint content you need to add a FormDigest control inside your page.The formdigest control can be added in master page and then all content pages will get it automatically.

<SharePoint:FormDigest runat=”server” />


For quick start add a Content editor webpart to your site page and modify its HTML source. Now, add the reference to SP.JS specified above and paste in the below code. Make sure you have ‘myCustomlist’ created in your site.
FYI… To get current client context we use SP.ClientContext.get_current() and to get current web we use ctx.get_web(). See the full example below.


Adding a List item – Now lets look at something advanced than above.

<script type=”text/javascript”>

function AddItem()
{
var context = new SP.ClientContext.get_current();
var web = context.get_web();
var list = web.get_lists().getByTitle(‘myCustomlist’);
var listItemCreationInfo = new SP.ListItemCreationInformation();
var newItem = list.addItem(listItemCreationInfo);
newItem.set_item(‘Title’, ‘SPUser’);
newItem.update();
context.executeQueryAsync(Function.createDelegate(this, this.success), Function.createDelegate(this, this.failed));
}
function success() {
alert(‘Added!’);
}
function failed(sender, args) {
alert(‘failed. Message:’ + args.get_message());
}

Delete an item - and finally how to delete an item.
function deleteItem(ItemId)
{
var context = new SP.ClientContext.get_current();
var web = context.get_web();
var list = web.get_lists().getByTitle(‘myCustomlist’);
var itemToDelete = list.getItemById(ItemId);
itemToDelete.deleteObject();
context.executeQueryAsync(Function.createDelegate(this, this.success), Function.createDelegate(this, this.failed));
}
function success() {
alert(‘Deleted!’);
}
function failed(sender, args) {
alert(‘failed. Message:’ + args.get_message());
}</script>
<a href=”#” onclick=”Javascript:AddItem();”>Create Item</a>
<a href=”#” onclick=”Javascript:deleteItem(1);”>Delete Item</a>

Thanks  LearningSharePoint Admin.