You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/features/embed-pages-to-teams.md
+43-42Lines changed: 43 additions & 42 deletions
Original file line number
Diff line number
Diff line change
@@ -1,85 +1,86 @@
1
1
---
2
-
title: Embedding modern SharePoint pages to Microsoft Teams as personal apps (preview)
3
-
description: SharePoint pages can be embedded to be visible in the Microsoft Teams as personal applications.
2
+
title: Embedding modern SharePoint pages in Microsoft Teams as personal apps (preview)
3
+
description: SharePoint pages can be embedded as personal apps in the Microsoft Teams.
4
4
ms.date: 06/05/2020
5
5
localization_priority: Priority
6
6
---
7
7
8
-
# Embedding modern SharePoint pages to Microsoft Teams as personal apps (preview)
8
+
# Embedding modern SharePoint pages in Microsoft Teams as personal apps (preview)
9
9
10
-
You can use the Microsoft Teams personal app model to pin any modern SharePoint page to the left navigation in the Microsoft Team. This provides a great opportunity to expose intranet landing pages to serve corporate communication needs, directly accessible by Microsoft Teams users. Example scenarios could include:
10
+
You can use the Microsoft Teams personal app model to pin any modern SharePoint page to the left navigation of Microsoft Teams. This provides a great opportunity to expose intranet landing pages to serve corporate communication needs, directly accessible by Microsoft Teams users. Example scenarios could include:
11
11
12
-
- Adding your corporate intranet landing page to the Microsoft Teams for easy discovery and access of news and content
13
-
- Add Learning Pathways solution to Microsoft Teams left navigation to provide easy access on the learning materials
12
+
- Adding your corporate intranet landing page to Teams for easy discovery of news and content
13
+
- Add the Learning Pathways solution to Teams to embed learning and adoption materials
14
14
- Add single page communications on important topics for your company
15
15
16
-
Use the steps defined in this article on embedding any modern SharePoint Portal to Microsoft Teams for easily accessing the corporate communicational information from the Microsoft Teams.
16
+
Use the steps defined in this article to embed any modern SharePoint page or site in Teams.
17
17
18
18
19
19
20
20
VIDEO
21
21
22
-
You can embed any modern page on Microsoft Teams by creating a Teams Personal App and manually create the needed configuration for this custom setup. Be aware of the following considerations.
22
+
You can embed any modern SharePoint page in Microsoft Teams by creating a Teams personal app and manually creating the needed configuration for this custom setup. Be aware of the following considerations:
23
23
24
-
- This capability is provided as a preview integration path until more native solution will be available
25
-
- You must use a modern SharePoint site or page to make this work. Embedding classic publishing portals or other classic sites is not supported and will not work
26
-
- A personal app exposing SharePoint sites and pages can be pinned to Microsoft Teams using normal app management capabilities, which can be also controlled centrally from the Microsoft Teams admin user interface
27
-
- We do acknowledge that there are some experience gaps with this approach, including the following, which we are actively looking to address:
28
-
- There is no navigation, headers, or footer visible natively on the embedded pages
29
-
- Search initiated from the suite navigation bar will leverage existing Teams search results, not those configured for the pinned site
30
-
- Content creation cannot be performed through the Microsoft Teams, rather will happen from the native SharePoint Online portal
31
-
- All users accessing the target SharePoint page will need to have at least read permissions to access the target page
32
-
- If a tenant, SharePoint site or page name or URL is changed, Teams Personal App manifest will need to be updated
33
-
- If changes are made to the pinning model for modern SP pages or sites, it could require deletion of existing pinned personal apps and redeploying
24
+
- This capability is provided as a PREVIEW INTEGRATION PATH unti a native solution becomes available.
25
+
- The target must be a modern SharePoint site or page. Embedding classic publishing portals or other classic sites or pages is not supported and will not work .
26
+
- A user can add a personal app from the APPS link in Teams. A user can pin an app to the app bar (the left-most navigation in Teams) by right-clicking it and choosing PIN.
27
+
- Administrators can deploy and pinn an app to all or targeted users from the Microsoft Teams admin center.
28
+
- There are some gaps in user experience including the following, which we are actively looking to address in a future, integrated solution:
29
+
- There is no native navigation, header, or footer on embedded pages.
30
+
- Search initiated from Teams will return search results from Teams, not search results from the embedded site.
31
+
- You cannot create content (news, pages, lists or libraries) in Teams. You must create content from the SharePoint site using a web browser or SharePoint mobile app.
32
+
- All users accessing the embedded SharePoint page will need to have at least read permission to access the page.
33
+
- If a tenant, SharePoint site or page name or URL is changed, the Teams personal app manifest will need to be updated.
34
+
- If changes are made to the pinning model for modern SP pages or sites, it could require you to delete existing pinned personal apps and redeploy them.
34
35
35
36
> [!IMPORTANT]
36
-
> This option is provided as a preview integration path and can evolve with a requirement to delete the existing configuration and re-adding native solution. This will not however require recreation or deletion of any content from the Microsoft Teams or from SharePoint side.
37
+
> This option is provided as a preview integration path. Microsoft reserves the right to make changes to the model, which could require you to delete existing pinned apps and re-deploy them with an updated solution. Changes to the integration path will not require you to delete or recreate the targeted SharePoint site or page.
37
38
38
39
## Embed SharePoint modern sites & pages into Microsoft Teams with App Studio
39
40
40
-
We will be using following tags in the below steps, which you should be updating based on the SharePoint modern page or site, which you want to embed to Microsoft Teams:
41
+
We will be using following tags in the steps below, which you should update based on the modern SharePoint page or site that you want to embed in Teams:
41
42
42
43
-[domainUrl] – Root URL of the ___domain
43
44
- Example – https://contoso.sharepoint.com
44
45
-[PageUrl] – Page, which should be shown in the tab relative to the root of the tenant
45
46
- Example - /sites/theperspective/SitePages/Home.aspx
46
47
47
48
> [!TIP]
48
-
> If you are looking into creating a demo or sample content around this area, you can use the [https://lookbook.microsoft.com](https://lookbook.microsoft.com) service for creating sample portals for your usage.
49
+
> If you want to create a sample to demonstrate this integration, you can use the [https://lookbook.microsoft.com](https://lookbook.microsoft.com) service to create sample apps and pages in your tenant.
49
50
50
-
You will need to use **App Studio** or other editor for creating the Microsoft Teams manifest file for the creating an app file with the necessary URLs to your SharePoint pages. Follow the next steps to complete the steps in App Studio.
51
+
You will need to use **App Studio** or another editor to create the Teams manifest file with the necessary URLs to your SharePoint pages. Complete the following steps in App Studio.
51
52
52
-
1.Navigate to Microsoft Teams
53
-
1. Navigate to Teams store by clicking Apps on the Teams left menu
53
+
1.Open Microsoft Teams.
54
+
1. Navigate to Teams store by clicking Apps on the Teams app bar (left navigation).
54
55
55
56
56
57
57
-
1. Use search to find App Studio
58
+
1. Use search to find App Studio.
58
59
59
60
60
61
61
-
1. Install or open App Studio depending on whether you have previously installed the app.
62
+
1. Install or open App Studio.
62
63
63
64
64
65
65
-
1. Open App Studio
66
-
1. Navigate to the Manifest editor tab
67
-
1.Select Create a new app
68
-
1. Provide required app information on the form
66
+
1. Open App Studio.
67
+
1. Navigate to the Manifest editor tab.
68
+
1.Click Create a new app.
69
+
1. Provide required app information on the form:
69
70
1.**Short name** – Company Intranet [use something descriptive that supports your scenario]
70
71
1.**Full name** – Contoso Intranet
71
-
1. Click **Generate** to randomize unique App ID
72
-
1.**Package Name** – com.contoso.portal.app – Use unique value here for your own setup
72
+
1. Click **Generate** to create a unique, random App ID
73
+
1.**Package Name** – com.contoso.portal.app – Use a value that is unique to your environment
73
74
1.**Version** – 1.0.0
74
75
1.**Description** – My first intranet application
75
-
1.**Full description** – My awesome intranet application to embed modern SharePoint to our Teams setup
76
+
1.**Full description** – My awesome intranet application to embed modern SharePoint in Teams
76
77
1.**Developer Information - Name** – Your name
77
78
1.**Developer Information - Website** – Your web site – company web site or whatever is your preference
78
79
1.**Partner information** – Leave empty
79
80
1.**App URLs** – These could be pages in your portal, but you can randomize the value for this tutorial
80
81
1.**Terms of use** – Could be also a page in your portal, but let us use random value in this tutorial
81
-
1.**Branding** – These would be visible on the left navigation and in the app installation user interfaces. You can leave them as they are for the tutorial, but we absolutely recommend updating them for the official configuration
82
-
1. See branding guidance from the Microsoft Teams official documentation related on the image and outline settings.
82
+
1.**Branding** – These would be visible on the app bar (left navigation) and in the app installation user interface. You can leave them as they are for the tutorial, but we absolutely recommend updating them for your production configuration
83
+
1. See branding guidance for the image and outline settings in the Microsoft Teams official documentation
83
84
84
85
1. Navigate to Tabs under Capabilities
85
86
@@ -90,8 +91,8 @@ You will need to use **App Studio** or other editor for creating the Microsoft T
1. Update provided URL based on your own tenant details. Example URL would be https://contoso.sharepoint.com/_layouts/15/teamslogon.aspx?SPFX=true&dest=/sites/theperspective/SitePages/Home.aspx
94
-
1.Used URL will need to be encoded to avoid issues on accessing is across different devices.
94
+
1. Update the URL based on your own tenant details. Example URL would be https://contoso.sharepoint.com/_layouts/15/teamslogon.aspx?SPFX=true&dest=/sites/theperspective/SitePages/Home.aspx
95
+
1.The URL will need to be encoded to avoid issues accessing it across different devices.
95
96
1.**Website URL** – You can leave this optional value empty
96
97
97
98
1. Navigate to **Domains and Permissions** under **Finish**
@@ -124,17 +125,17 @@ You will need to use **App Studio** or other editor for creating the Microsoft T
124
125
125
126
126
127
127
-
Notice that you can modify the settings by going back to the **App Studio** and edit the manifest by using the **Manifest editor**.
128
+
Notice that you can modify the settings by going back to **App Studio** and editing the manifest using the **Manifest editor**.
128
129
129
-
You can deploy the portal configuration available for your company employees by downloading the manifest from the **App Studio** and publishing it to be available from your company catalog.
130
+
You can deploy the app to all users or to targeted users by downloading the manifest from the **App Studio** and publishing it to the app catalog in Teams administration.
130
131
131
132
132
133
> [!IMPORTANT]
133
-
> To be able to deploy this solution to your tenant for other users, you will need to have sufficient permissions to perform the app deployment to your tenant Microsoft Teams app catalog.
134
+
> To deploy this solution to users in your tenant, you must have sufficient permissions to deploy apps in the Microsoft Teams app catalog.
134
135
135
136
## Sample manifest of the solution
136
137
137
-
If you download the solution file from the App Studio and see the detailed configuration of the manifest file, it has the following configurations to enable it work properly in web and in desktop modes.
138
+
If you download the solution file from the App Studio and see the detailed configuration of the manifest file, it has the following configuration to enable it to work properly in web and in desktop modes.
138
139
139
140
```json
140
141
{
@@ -201,4 +202,4 @@ See more information on these options from the office Microsoft Teams documentat
0 commit comments