TechEd: ‘Creating Custom SharePoint Service Applications 101’ with Todd Bleeker

This afternoon Todd Bleeker opened his TechEd session, Creating Custom SharePoint Service Applications 101 by saying that Service Applications is "probably the most complex topic you can talk about in SharePoint 2010."  Todd went on to say that this session would represent "One of the few times in the last decade I've done a technical presentation [with] no demo," explaining his rationale as "I could probably build one in an hour, but it would kill you."   Thus, Todd chose to focus instead on the fundamentals in his session, explaining that the slide deck, along with source code for a sample service application would soon be posted on his blog.

Todd is famed as being an energetic speaker, and I must say that he was easily the most animated presenter I've seen all week, fairly bursting with passion for his subject matter.  I'll be honest, Todd works fast, and I did my best to keep up, but … well, let's just say that interested parties would unquestionably be best served by visiting Todd's blog and downloading the (incredibly detailed) slide deck and the accompanying source code.

Beginning with a brief history of what would ultimately become service applications, including a discussion on conceptual versus actual topology, Todd then moved on to ask the question, "Why use an application layer?"  The reasons he provided were that "We want to offload the processing of something that's incredibly intensive, we want to centralize state," and cross platform (farm).

Todd explained that the "Service application framework is created to mitigate ASMX issues," and involves: hosted, middle-tier services; scalable shared services; the ability to be consumed by multiple SharePoint Web applications or even external consumers; "and it's extensible."   Also provided by the service application framework are: provisioning; optional management pages; claims awareness; backup, restore, and upgrade support; pluggable round robin load balancer; and custom permissions which are "built into Central Administration."

Following "A little bit of SharePoint history to explain why SharePoint needed one of these," Todd explained that to create a service application, some kind of service to surface must first exist.  If such a service doesn't yet exist, you'll need to create some sort of WCF.  Todd shared the "anatomy of service application" as consisting of: 

  • SVC
  • Contract (behavioral and maybe a data interface)
  • {SharePointRoot}WebServices
  • {SharePointRoot}WebClient
  • DLL to GAC

Next you need to create the infrastructure for the service application, using core component names as class suffixes for each of the five classes: 

  • *Service ("All it does is say, 'I have a service.' You get one per farm.")
  • *ServiceInstance ("I call this the on/off switch," and it allows you to turn a service on or off on a given server.)
  • *ServiceApplication (When you say "New" and it shows up accordingly.)
  • *ServiceProxy ("Used to consume it on the client." Here again, there is one per farm.)
  • *ServiceApplicationProxy ("The actual mechanism by which the client talks to the service proxy.")

Todd said that there is also a full range of optional extensions "you might want to do," including such things as PostDeploy.ps1 PowerShell Script, and custom SAF permissions.  You'll find the full list of optional extensions in Todd's slide deck.  As well, exhaustive details pertaining to each of the five classes described above will also be found in the deck.

Todd wrapped up by talking through a slide outlining the individual steps involved in developing your first service application:

  • Create WCF Service; host in IIS
  • Test service with WcfClientTest.exe
  • Write 5 classes of SA (3 server, 2 client)
  • Add GUID; default 'ctors, other 'ctors, TypeName
  • Farm Feature Receiver creates/destroys:

                    o  Service (1/Farm)

                    o Service Instance (1 each server)

                    o Service Proxy (1/Farm)

  • Proxy Groups – Web Application Association
  • PowerShell to Auto-Create
  • _LayoutsProjectsConsumer.aspx (Application page)

 Again, don't forget to keep an eye on Todd's blog for his slide deck and the source code for a sample service application.  Todd said that those resources would be posted "hopefully in the next couple days."

 

Read our complete coverage of Microsoft TechEd North America 2011:

All SharePoint Versions

The web parts are functional components that extend your SharePoint environment whether it’s hosted, on-premises, or part of Microsoft® Office 365.

SharePoint 2013, 2016, 2019, Online (Office 365)

On-Premises Only

These web parts extend SharePoint beyond its out-of-the-box capabilities by tailoring it to your requirements with Bamboo Solution’s growing portfolio of SharePoint Web Parts.

SharePoint 2013, 2016, 2019

SharePoint

Product Suites

Experience greater power and savings by bundling our SharePoint apps and web parts.


Essentials Suite


Essentials Plus Suite


Bamboo Premier Suite


Project Management Suite


Knowledge Management Suite


External User Manager


 

For more information on our product suites, contact us.

Featured Services

SharePoint Health Check

A SharePoint Health Check will identify the causes of issues and risks associated with your specific environment, and is custom tailored to provide you with the best recommendations to optimize your SharePoint environment.

SQL Health Check

Document recommendations relating to performance, stability, availability, or a specific focus you request of your SQL Server database instances.

My SharePointXperts

The truth is that each SharePoint skill may not be a full time job for many organizations, and it is nearly impossible for one person to do everything you need – so augment your team with SharePointXperts; providing the skill sets you need when you need them!