Skip to content

Commit caf0f89

Browse files
Adds SharePoint marketplace guidance (SharePoint#5851)
* Adds SharePoint marketplace guidance * Removes optional locales from URLs
1 parent 6c6628c commit caf0f89

File tree

2 files changed

+83
-1
lines changed

2 files changed

+83
-1
lines changed

docs/spfx/publish-to-marketplace.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
title: Publish SharePoint Framework applications to the marketplace
3+
description: Considerations for publishing SharePoint Framework applications to the marketplace
4+
ms.date: 06/09/2020
5+
ms.prod: sharepoint
6+
localization_priority: Priority
7+
---
8+
9+
# Publish SharePoint Framework applications to the marketplace
10+
11+
Publishing your SharePoint Framework solutions to marketplace allows you to reach other organizations and let them easily install your application in their Microsoft 365 tenant. Following sections describe considerations that you should take into account before publishing your solutions to the marketplace.
12+
13+
## Use SharePoint Framework v1.11 or newer
14+
15+
We recommend that you use SharePoint Framework v1.11 or newer to build solutions that you want to publish to the marketplace. Starting from version 1.11, SharePoint Framework solution manifest has additional information about your organization and solution.
16+
17+
In the solution's manifest (managed in the `package-solution.json` file) there is a new section named `developer` with the following properties:
18+
19+
Attribute|Description|Mandatory
20+
---|---|---
21+
`name`|Name of the organization that built the application|Yes
22+
`websiteUrl`|URL of a website with additional information about the application|Yes
23+
`mpnId`|Microsoft Partner Network ID (more details on [MS Partner Network](https://docs.microsoft.com/partner-center/mpn-overview))|Yes (for solutions published to the marketplace)
24+
`privacyUrl`|Privacy statement URL|Yes
25+
`termOfUseUrl`|Terms of use URL|Yes
26+
27+
Including this additional information allows you to clearly communicate information about your application towards your users and in the future should allow you to access additional usage data.
28+
29+
The developer information is displayed when installing web parts in Microsoft Teams. Information about the application and the developer that is displayed in the marketplace is managed separately in the marketplace.
30+
31+
> [!TIP]
32+
> If your application is built using an older version of the SharePoint Framework, you can easily upgrade it to SharePoint Framework v1.11 or newer using Office 365 CLI. For more information, visit [https://pnp.github.io/office365-cli/cmd/spfx/project/project-upgrade/](https://pnp.github.io/office365-cli/cmd/spfx/project/project-upgrade/).
33+
34+
## Install applications from the marketplace in the tenant app catalog
35+
36+
SharePoint Online allows you to create a tenant app catalog where you centrally manage applications available in your organization. Additionally, you can create site collection app catalogs, where you can deploy applications to specific sites.
37+
38+
Applications that you acquire from the marketplace, you can install only in tenant app catalogs. After installing the application, you can decide whether you want to deploy it globally and make it available to all sites in your tenant or if you want to deploy it only to specific sites.
39+
40+
For more information about managing SharePoint Framework solution in the app catalog visit: [https://docs.microsoft.com/sharepoint/use-app-catalog](https://docs.microsoft.com/sharepoint/use-app-catalog) and [https://docs.microsoft.com/sharepoint/dev/general-development/site-collection-app-catalog](https://docs.microsoft.com/sharepoint/dev/general-development/site-collection-app-catalog).
41+
42+
## Permissions required to install applications from the marketplace
43+
44+
By default, only tenant administrators can install applications from the marketplace. They can however choose to delegate the responsibility to others in your organization by granting them access to the tenant app catalog.
45+
46+
SharePoint Framework applications execute on behalf of the current user and can do whatever the current user can do. Because of this, only tenant app catalog administrators can install applications from the marketplace. Users who are not app catalog administrators can request a specific application to be installed by the app catalog administrator, but they cannot install the application themselves.
47+
48+
## Use auto-generated Microsoft Teams manifest
49+
50+
When building SharePoint Framework web parts, you can choose to [expose them in SharePoint and Microsoft Teams as personal apps or tabs](https://docs.microsoft.com/sharepoint/dev/spfx/integrate-with-teams-introduction). To use your web parts in Teams you can either generate the manifest and the Teams solution package yourself or have the SharePoint Framework generate it for you. Creating the manifest manually gives you more flexibility and allows you to create multi-tab personal apps.
51+
52+
At this moment, the marketplace does not support embedding custom Teams manifests in SharePoint Framework packages. You can expose your web parts in Teams using the manifest auto-generated by SharePoint Framework.
53+
54+
If your web part requires configuration and you expose it as a personal Teams app, you need to implement a custom UI yourself to allow users to configure it.
55+
56+
## Notify users of new versions
57+
58+
As you update your application, you should notify your users when an updated version is available. The marketplace does not offer any version checking mechanism and you should implement it your application so that notifications are meaningful and as unobtrusive as possible. In your code you can for example call a custom API that you own to compare the current version of the application with the latest version available.
59+
60+
Tenant app catalog administrators can update applications acquired from the marketplace directly from the app catalog, by selecting the application in the app catalog and from the ribbon choosing the **Upgrade Store App** option. When the upgrade succeeds, the latest version will be automatically visible to users in all sites where the application has been installed.
61+
62+
## Applications listed in the SharePoint category
63+
64+
All SharePoint Framework applications published in the marketplace are listed in the **SharePoint** category. At this moment, it is not possible to specify a custom category. Also, even if you configured web parts in your application to be exposed in Microsoft Teams, the application will still be listed in the **SharePoint** category.
65+
66+
## Frequently asked questions
67+
68+
### Is it required to configure web parts to be isolated for publishing in the marketplace
69+
70+
No, it is not required to configure web parts to be isolated. It is fully up to you to decide if your web parts should be isolated or not and you can use either mode in the application you publish to the marketplace.
71+
72+
### Can I request additional API permissions for my solution
73+
74+
Yes, if your solution needs additional API permissions to work as intended, then you should request these permissions to be granted in your solution’s manifest. Please note, that the marketplace verification team could ask you to justify access to the permissions that you have requested when verifying your submission.
75+
76+
### Can I expose my web parts in Office add-ins
77+
78+
At this moment exposing SharePoint Framework web parts in Office add-ins is in preview and is not yet supported in solutions published in the marketplace.
79+
80+
### Can I include library components in my solution
81+
82+
Yes, library components are fully supported in solutions published to the marketplace.

docs/spfx/toolchain/sharepoint-framework-toolchain.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: SharePoint Framework toolchain
33
description: The toolchain is the set of build tools, framework packages, and other items that manage building and deploying your SharePoint Framework client-side projects.
4-
ms.date: 01/12/2018
4+
ms.date: 06/16/2020
55
ms.prod: sharepoint
66
localization_priority: Priority
77
---

0 commit comments

Comments
 (0)