23
SharePoint Solutions with SPServices Marc D Anderson

SPSNH 2013 - SharePoint Solutions with SPServices

Embed Size (px)

DESCRIPTION

SPServices is a widely used jQuery library that abstracts SharePoint's Web Services and makes them easier to use. It also includes functions that use the various Web Service operations to provide more useful (and cool) capabilities. It works entirely on the client and requires no server install. Using SharePoint’s Web Services client-side, you can provide your users a more “tactile” experience. In this class, you'll learn how to use SPServices to build a more compelling user experience on top of SharePoint. We'll look at the most popular "value-added" SPServices functions as well as how you can use SPServices as part of your own development toolkit. We’ll also discuss how you should think about migrating from SPServices to REST calls and when it makes sense.

Citation preview

Page 1: SPSNH 2013 - SharePoint Solutions with SPServices

SharePoint Solutions with SPServices

Marc D Anderson

Page 2: SPSNH 2013 - SharePoint Solutions with SPServices

was made possible by the generous support of the following sponsors…

And by your participation… Thank you!

Page 3: SPSNH 2013 - SharePoint Solutions with SPServices

Who Is Marc?• Co-Founder and President of Sympraxis

Consulting LLC, located in the Boston suburb of Newton, MA, USA. Sympraxis focuses on enabling collaboration throughout the enterprise using the SharePoint application platform.

• More than 30 years of experience in technology professional services and software development. Over a wide-ranging career in consulting as well as line manager positions, Marc has proven himself as a problem solver and leader who can solve difficult technology problems for organizations across a wide variety of industries and organization sizes.

• Three-time awardee of the Microsoft MVP award for SharePoint Server (2011, 2012, 2013).

Page 4: SPSNH 2013 - SharePoint Solutions with SPServices

What Is SPServices?

SPServices is a jQuery library which abstracts SharePoint's Web Services and makes them easier to use. It also includes functions which use the various Web Service operations to provide more useful (and cool) capabilities. It works entirely client side and requires no server install.

SharePoint's first [useful] client side object modelTM?

Page 5: SPSNH 2013 - SharePoint Solutions with SPServices

Where Does SPServices Work?

Page 6: SPSNH 2013 - SharePoint Solutions with SPServices

Where Do I Get SPServices?

http://spservices.codeplex.com/

Page 7: SPSNH 2013 - SharePoint Solutions with SPServices

What Else Do I Need?

http://jquery.com

"jQuery is a fast, small, and feature-rich JavaScript library. It makes things like HTML document traversal and manipulation, event handling, animation, and Ajax much simpler with an easy-to-use API that works across a multitude of browsers. With a combination of versatility and extensibility, jQuery has changed the way that millions of people write JavaScript."

Page 8: SPSNH 2013 - SharePoint Solutions with SPServices

How Does It All Fit Together?

Page 9: SPSNH 2013 - SharePoint Solutions with SPServices

Add More Plugins

?

Page 10: SPSNH 2013 - SharePoint Solutions with SPServices

Referencing Script Files

• Adding jQuery, SPServices, and jQueryUI

Referencing jQuery, jQueryUI, and SPServices from CDNs – Revisitedhttp://sympmarc.com/2013/02/07/referencing-jquery-jqueryui-and-spservices-from-cdns-revisited/

Note the protocol-less references

Page 11: SPSNH 2013 - SharePoint Solutions with SPServices

What Can You Do with SPServices?• SPServices Core• Call SharePoint’s SOAP Web Services• Parse the returned XML to provide page content

or user feedback• Make changes to SharePoint objects

• Value-Added Functions• Enhance forms• Improve the user experience (UX)

Page 12: SPSNH 2013 - SharePoint Solutions with SPServices

SPServices’ Core Functions

Page 13: SPSNH 2013 - SharePoint Solutions with SPServices

Anatomy of an SPServices Call$().SPServices({ operation: "operationname",

});

[webURL: "/sitepath",] [option1: value1,] [option2: value2,] [async: false,]

completefunc: function (xData, Status) { ...do stuff...}

Page 14: SPSNH 2013 - SharePoint Solutions with SPServices

Anatomy of an SPServices Call using Promisesvar thisPromise = $().SPServices({ operation: "operationname", [webURL: "/sitepath",] [option1: value1,] [option2: value2]});

thisPromise.done(function() { ...do stuff...});

Promises were added in 2013.01

Page 15: SPSNH 2013 - SharePoint Solutions with SPServices

How Does an SPServices Call Work?

XML

Page 16: SPSNH 2013 - SharePoint Solutions with SPServices

Parsing Results: GetListItems Examplecompletefunc: function (xData, Status) { $(xData.responseXML).SPFilterNode("z:row").each(function() { var liHtml = "<li>" + $(this).attr("ows_Title") + "</li>"; $("#tasksUL").append(liHtml); });}

• Alabama•Hawaii• Texas•North Dakota

<ul id="tasksUL"/>

Page 17: SPSNH 2013 - SharePoint Solutions with SPServices

Value-Added Functions

• Combining multiple Web Services calls allows us to build cool functionality

• Big focus on form enhancements to improve the overall user experience (UX)

• The value-added functions are useful on their own but also can be used as prototypes for you to build your own functionality

Page 18: SPSNH 2013 - SharePoint Solutions with SPServices

SPCascadingDropdowns

• Lets you set up cascading dropdowns on SharePoint forms (think Country / Region/ State/ City)

• Enforces hierarchical relationships between column values using the GetListItems operation of the Lists Web Service to refresh the allowable values based on relationships which are maintained in reference lists

• Users manage the relational content in reference lists

Page 19: SPSNH 2013 - SharePoint Solutions with SPServices

SPDisplayRelatedInfo

Page 20: SPSNH 2013 - SharePoint Solutions with SPServices

SPSetMultiSelectSizes

Page 21: SPSNH 2013 - SharePoint Solutions with SPServices

Demos

Page 22: SPSNH 2013 - SharePoint Solutions with SPServices

Be sure to fill out your evaluation form & turn it in at the end of the day for a

ticket in the BIG raffle!

Join us for the raffle & SharePint

following the last session