Export (0) Print
Expand All

Tenancies and deployment scopes for SharePoint Add-ins

SharePoint Add-ins

Learn about the concept of tenancies and the differences between deploying apps for SharePoint at tenant scope and web scope.

Last modified: June 16, 2015

Applies to: apps for SharePoint | Office 365 | SharePoint Add-ins | SharePoint Foundation 2013 | SharePoint Server 2013

Note Note

The name "apps for SharePoint" is changing to "SharePoint Add-ins". During the transition, the documentation and the UI of some SharePoint products and Visual Studio tools might still use the term "apps for SharePoint". For details, see New name for apps for Office and SharePoint.

In this article
Tenancies and app scope
Limitations of tenant-scoped apps
How to install, uninstall, and update an app on multiple websites in a tenancy
Additional resources

A SharePoint 2013 tenancy is a set of site collections in either a SharePoint farm or in SharePoint Online. In SharePoint Online, the site collections belong to a single customer account. In a SharePoint farm, the site collections can be all the site collections in a SharePoint web application or a subset of them, or it can be a set of site collections from across multiple web applications in the farm. A tenancy can have an app for SharePoint app catalog just as a SharePoint web application can.

An app for SharePoint has an app scope. The two possible app scopes are web scope or tenant scope. The difference is not an intrinsic property of the app, and you, the developer, do not decide what the scope of your app is. The decision is made by tenant administrators as a side effect of how the app is installed. After an app is uploaded to the app catalog of a tenancy, it is immediately available to be installed on websites within the tenancy on a website-by-website basis. Apps that are installed this way have web scope. Tenant administrators have another option, however. They can choose to batch install the app to a subset of websites within the tenancy. Apps that are installed in this way have tenant scope. The tenant admin can specify which websites the app is installed to by means of a list of managed paths, a list of site templates, or a list of site collections. An app that has been batch-installed can only be uninstalled by a tenant administrator. When the tenant admin uninstalls the app, it is uninstalled from every website in the tenancy. Users can't uninstall a batch-installed app on a website-by-website basis. The same principle applies to updating a batch-installed app: only a tenant administrator can do it, and it is batch-updated on every website in the tenancy where it is installed.

If an app that includes an app web is batch-installed, only one app web is created and it is shared by all the host websites on which the app is installed. The app web is located in the site collection of the organization's app catalog.

When new site collections are created in the tenancy, apps that were previously batch-installed are automatically installed on the new site collection.

Note Note

App scope should not be confused with Feature scope. Feature scope determines where the elements in a Feature are deployed. The possibilities include Farm, WebApplication, Site (that is, site collection), and Web. Only Web is permitted for Features in apps for SharePoint (both host web Features and Features inside a .wsp in an app package).

App scope should also not be confused with app permission levels. Apps for SharePoint can request permissions to all or selected parts of SharePoint content at the levels of list, web, site collection, and tenancy. Installing an app with tenant scope does not give it permissions that it would not otherwise have, nor does it cancel key provisions of the SharePoint security model. For more information about app permissions, see Add-in permissions in SharePoint 2013.

The following kinds of apps cannot be batch-installed:

  • Apps that contain a custom action for the ribbon. (Custom actions that are deployed as menu items are allowed.)

  • Apps that contain an app part.

In addition, note again that installation with tenant scope is not possible in the Office 365 Small Business Premium version of SharePoint Online.

Regardless of whether an app is installed from the Office Store or from an app catalog, tenant admins can install it to multiple websites in a tenancy, uninstall it, and update it by using the following procedures.

To install an app for SharePoint to multiple websites

  1. Navigate to the Site Contents page of the corporate catalog website.

  2. Select Add an app and install the app just as you would on any other SharePoint website.

  3. After the app is installed, hover over the link to the app in the Site Contents page. A "..." link appears.

  4. Select the link, and a callout appears.

  5. Select Deployment on the menu.

  6. Use the deployment UI that opens to specify the site collections to which you want the app installed. You can filter by managed paths, site templates, or URLs. The filters have a logical "OR" relationship: the app is installed to the union of all the site collections that pass any one or more of the filters.

  7. Select OK.

To uninstall a batch-installed app for SharePoint

  1. Navigate to the Site Contents page of the corporate catalog website.

  2. Hover over the link to the app in the Site Contents page. A "..." link appears.

  3. Select the link, and a callout appears.

  4. Select Remove on the callout.

To update a batch-installed app for SharePoint

  1. Navigate to the Site Contents page of the corporate catalog website. If there is an update available for an app, a message appears beside the app. There will be a link to update the app.

  2. Click the link to update the app.

  3. When you are prompted to approve the permission requests of the app, choose Trust It.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2015 Microsoft