Three ways to think about design options for SharePoint Add-ins

Prerequisite: You should first be familiar with the article SharePoint Add-ins.

This article looks at the architectural choices for SharePoint Add-ins in three different ways. First, you learn about the most important categories of design choices; second, you view add-in architecture in terms of application tiers; and, third, you see a set of factors you need to consider when making your design choices.

The first decision to make is whether your SharePoint extension should be a SharePoint Add-in or a classic SharePoint farm solution or sandboxed solution. Some parts of the SharePoint object model, mainly connected with customizing SharePoint administration and security, are not accessible from clients. Only custom code running on the SharePoint server can access them, and custom server-side code is not allowed in a SharePoint Add-in. (A rich set of client object models and a REST/OData service make it possible for SharePoint Add-ins to do almost any end-user-oriented SharePoint extension.)

For more information about deciding between classic solutions and add-ins, see SharePoint Add-ins compared with SharePoint solutions. Also helpful for making this decision is Choose the right API set in SharePoint.

Key elements in the design of SharePoint Add-ins

Three major categories of choices need to be made when a SharePoint Add-in is designed. As always, application design involves trade-offs; choices you make in one category may limit your options in another. Not every possible combination of choices is feasible.

  • Hosting: SharePoint Add-ins can be divided into two major types based on how they are deployed and hosted.

    • Provider-hosted add-ins have their primary data storage and business logic deployed and hosted by you—the developer—outside of SharePoint in servers or a cloud account that you provide. You are responsible for enforcing isolation between the accounts of the various customers who purchase your add-in. Such add-ins can have SharePoint components too. These are hosted in the customer's SharePoint farm. This type of add-in provides you with the most flexibility in the other categories of design choices. It also enables you to use non-Microsoft platforms for the external data, logic, and web user interface (UI). (Within the category of provider-hosted add-ins, you also need to distinguish between add-ins whose remote components are within the same corporate firewall as the SharePoint farm and those whose remote components are outside of that firewall. The authorization systems for these two scenarios are different, which, in turn, makes a difference in which programming language you use to access the SharePoint data.)

    • SharePoint-hosted add-ins consist entirely of SharePoint components, such as lists, content types, workflows, and Web Parts. There are no external components. For more information about the kinds of SharePoint components that can be included in SharePoint Add-ins, see Host webs, add-in webs, and SharePoint components in SharePoint.

      For more detailed information about the hosting options of SharePoint Add-ins, see Choose patterns for developing and hosting your SharePoint Add-in.

  • Connectivity: SharePoint supports three kinds of secure create/read/update/delete (CRUD) access to data.

  • UI: There are three ways to surface a SharePoint Add-in in SharePoint: at a minimum, all add-ins are surfaced in a full web page. Optionally, an add-in can also be surfaced through an add-in part, and through a menu item or ribbon button. For more information, see UX design for SharePoint Add-ins.

Note

SharePoint Add-ins can be installed by your customers to multiple site collections in a tenancy, or on a website-by-website basis. The former are called tenant-scoped add-ins. If you want your customers to have the tenant-scoped option, you may not include a custom ribbon button or an add-in part. For more information, see Tenancies and deployment scopes for SharePoint Add-ins.

Architectural tiers

Another way to think about your add-in architecture options is to think of the add-in as having three logical tiers: the UI, the business logic, and the data access. Each layer has multiple implementation options; again, choices made for one layer limit the options for others. The following tables describe some of the options, and their uses, for the remote components of an add-in and the SharePoint components.

Remote components in provider-hosted add-ins: options for each tier

Tier Options Good for
UI ASP.NET pages in an ASP.NET form or MVC application that is hosted in an Azure web role Leveraging the skills of an ASP.NET development staff
HTML 5 page with JavaScript Rich user interface
PHP or other kind of web page hosted in a non-Microsoft cloud service Integrating non-Microsoft applications into SharePoint
Silverlight in a Windows Phone app Mobile access to SharePoint data and integration with geolocation data and push notifications
Business logic Client-side JavaScript UI logic and light business logic; accessing SharePoint data through the JavaScript client object model
A Microsoft Azure worker role Processor-intensive functionality; accessing SharePoint data through the .NET Framework client object model
A remote web service Processor-intensive functionality; accessing SharePoint data through the .NET Framework client object model
Data SQL Azure Full-featured relational data
Azure Table storage Application settings and other metadata
Azure Blob storage Storage of large files
A non-Microsoft cloud service Leveraging existing data sources that are based on non-Microsoft platforms
A database on the developer's own server Provider-hosting and developer control of tenancy isolation

SharePoint components: options for each tier

Tier Options Good for
UI Custom views of SharePoint lists and libraries on add-in web pages Maximizing integration with SharePoint appearance and behavior
Silverlight application hosted in a Web Part (or within tags) on an add-in web page Leveraging existing Silverlight development experience; rich user interface
Business logic A SharePoint workflow Implementing business processes
Client-side JavaScript supplemented with the SharePoint cross-domain library Accessing SharePoint data in the add-in web; accessing data in other websites within the tenancy
A remote event handler Handling CRUD events in SharePoint lists and libraries using externally hosted logic
Data SharePoint lists and libraries that are queried through Collaborative Application Markup Language (CAML), or LINQ queries with one of the SharePoint client object models Leveraging existing SharePoint and .NET Framework development experience
SharePoint lists and libraries that are queried through the SharePoint REST/OData web service Accessing SharePoint data from non-Microsoft platforms; leveraging existing OData query experience
A BCS Model Surfacing external data in SharePoint as a SharePoint list

Factors to consider when making your design decisions

The SharePoint Add-in model enables so many possibilities for design that a simple decision tree is not possible. The following are some of the most important factors to consider when constructing the architecture of a SharePoint Add-in.

  • Most importantly, of course, is the functionality you want to make available to customers—the use cases. For example, if your add-in includes processor-intensive functions, such as converting video files to another video format, that would be an argument for creating a provider-hosted add-in in which the processing is done on one of your servers or an Azure worker role.

  • Because one kind of SharePoint Add-in, provider-hosted add-ins, requires you (or your customer) to host the non-SharePoint components and to enforce tenant isolation, you need to consider whether you have the hardware and IT staff to do this (or whether your targeted customers do).

  • Which customers you are targeting is also a crucial consideration. If all your add-ins will be used in-house (that is, you have no external customers) or used by a single customer, provider-hosted add-ins are significantly easier to implement and maintain than when you have external customers or multiple customers will use the add-in. If you intend to sell the add-in publicly, you should also consider whether you will market it to businesses that have SharePoint Online accounts or those with their own SharePoint farms, or both.

  • You should also consider your existing skills or the skills of your development staff. For example, if you are an experienced ASP.NET developer, that would be a point in favor of creating a remote web application and surfacing SharePoint list data on an ASP.NET page. On the other hand, if you are an experienced SharePoint developer, that would be a point in favor of using a custom SharePoint list and site page, with JavaScript to perform processing.

See also