Skip to content

Commit bf1f8bc

Browse files
waldekmastykarzVesaJuvonen
authored andcommitted
Added guidance on loading modern pages in maintenance mode (SharePoint#1152)
1 parent 202dd46 commit bf1f8bc

File tree

5 files changed

+86
-0
lines changed

5 files changed

+86
-0
lines changed
Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
title: Load modern pages in maintenance mode
3+
ms.date: 12/15/2017
4+
ms.prod: sharepoint
5+
ms.assetid: 3ebd2a11-8291-4228-add0-9e0cd899dd3c
6+
---
7+
8+
# Load modern pages in maintenance mode
9+
10+
_**Applies to:** Office 365_
11+
12+
When working with modern pages, you can load them in maintenance mode. The maintenance mode can be helpful when trying to debug issues related to web parts placed on the page.
13+
14+
## Switch to maintenance mode
15+
16+
> [!NOTE]
17+
>
18+
> In order to load a modern page in maintenance mode, you have to have edit permissions for that specific page.
19+
20+
To switch to the maintenance mode, navigate to the modern page and in the URL append `?maintenancemode=true`, for example:
21+
22+
```text
23+
https://contoso.sharepoint.com/sites/team?maintenancemode=true
24+
```
25+
26+
To leave the maintenance mode, remove `?maintenancemode=true` from the URL and reload the page.
27+
28+
## Available information
29+
30+
The maintenance mode shows various information about each web part on the page.
31+
32+
### Web part summary
33+
34+
When in maintenance mode, for each web part you will see the following summary information:
35+
36+
![Web part summary information displayed in maintenance mode](../images/maintenance-mode-summary.png)
37+
38+
Property|Description
39+
--------|-----------
40+
Alias|Web part alias
41+
Id|The unique ID of the web part
42+
InstanceId|The ID of a specific instance of a web part (that is, if you have two more of the same web parts on a page, they will each have the same web part ID, but a different instance ID.
43+
IsInternal|Indicates whether the web part was made by Microsoft or a third party. If `true`, it is made by Microsoft. If `false`, it is made by a third party.
44+
Version|The version number of the web part.
45+
Environment|Enumeration indicating the environment on which the web part is running. Possible values: `1` - Local Workbench, `2` - SharePoint
46+
UserAgent|A string that contains information about the device and software in use (such as browser type and version).
47+
48+
### Web part manifest
49+
50+
To get more information about the web part, switch to the **Manifest** tab.
51+
52+
![Web part manifest information displayed in maintenance mode](../images/maintenance-mode-manifest.png)
53+
54+
By exploring the manifest information, you can learn details such as:
55+
56+
- where the web part bundle is hosted
57+
- which external scripts is the web part loading and from where
58+
- what version of the SharePoint Framework has the web part been built on
59+
- which components of the SharePoint Framework does the web part use
60+
61+
This information can be invaluable when trying to find a reason why the particular web part is malfunctioning.
62+
63+
### Web part data
64+
65+
Another piece of information available in the maintenance mode, is web part data.
66+
67+
![Web part data information displayed in maintenance mode](../images/maintenance-mode-data.png)
68+
69+
Using the information from the **Data** tab, you can see the configuration for each web part. This is helpful when trying to reproduce errors reported by users which could be caused by a specific web part configuration.
70+
71+
If the web part [integrates its properties with SharePoint](../spfx/web-parts/guidance/integrate-web-part-properties-with-sharepoint.md), the data section shows the types and values that are passed to SharePoint for further processing.
72+
73+
## Considerations
74+
75+
- the maintenance mode works only with modern SharePoint pages. See the [Open and use the web part maintenance page](https://support.office.com/en-us/article/Open-and-use-the-web-part-maintenance-page-eff9ce22-d04a-44dd-ae83-ac29a5e396c2#PickTab=2016,_2013) support article, to get more information about opening classic pages in maintenance view
76+
- to open modern page in maintenance mode, you have to have edit permissions for that page
77+
- when in maintenance mode, web part code is not being executed and you cannot edit web part properties
78+
- in maintenance mode, you can delete or move web parts on the page
79+
- the maintenance mode shows only information about web parts. You cannot use it to show information about SharePoint Framework extensions that are executed on the page
80+
- switching to maintenance mode only disables executing web part code. Any SharePoint Framework extensions registered on the page will still execute
81+
82+
## See also
83+
84+
- [Open and use the web part maintenance page](https://support.office.com/en-us/article/Open-and-use-the-web-part-maintenance-page-eff9ce22-d04a-44dd-ae83-ac29a5e396c2)

docs/images/maintenance-mode-data.png

43.4 KB
Loading
76.9 KB
Loading
39.8 KB
Loading

docs/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1024,6 +1024,8 @@
10241024
href: general-development/choose-the-right-api-set-in-sharepoint.md
10251025
- name: Use the site collection app catalog
10261026
href: general-development/site-collection-app-catalog.md
1027+
- name: Load modern pages in maintenance mode
1028+
href: general-development/modern-pages-maintenance-mode.md
10271029
- name: Set up and configure SharePoint Workflow Manager
10281030
href: general-development/set-up-and-configure-sharepoint-workflow-manager.md
10291031
- name: SharePoint Server Application Lifecycle Management

0 commit comments

Comments
 (0)