Skip to content

Commit 118023a

Browse files
committed
Modernization scanner documentation updates
1 parent 3d7f301 commit 118023a

17 files changed

+815
-0
lines changed

docs/toc.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1407,6 +1407,26 @@
14071407
href: transform/modernize-userinterface-site-pages-layout.md
14081408
- name: The SharePoint Modernization scanner
14091409
href: transform/modernize-scanner.md
1410+
items:
1411+
- name: Understand the created reports
1412+
href: transform/modernize-scanner-reports.md
1413+
items:
1414+
- name: Office 365 Group connect report
1415+
href: transform/modernize-scanner-reports-groupconnect.md
1416+
- name: Modern list and libraries report
1417+
href: transform/modernize-scanner-reports-lists.md
1418+
- name: Page modernization report
1419+
href: transform/modernize-scanner-reports-pages.md
1420+
- name: Publishing portal modernization report
1421+
href: transform/modernize-scanner-reports-publishingportals.md
1422+
- name: Workflow usage report
1423+
href: transform/modernize-scanner-reports-workflow.md
1424+
- name: InfoPath usage report
1425+
href: transform/modernize-scanner-reports-infopath.md
1426+
- name: Blog usage report
1427+
href: transform/modernize-scanner-reports-blogs.md
1428+
- name: Scanner FAQ
1429+
href: transform/modernize-scanner-faq.md
14101430
- name: Modernization scripts
14111431
href: transform/modernize-sample-scripts.md
14121432
- name: Modernize customizations
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
---
2+
title: The SharePoint modernization scanner FAQ
3+
description: he SharePoint modernization scanner FAQ
4+
ms.date: 10/23/2019
5+
ms.prod: sharepoint
6+
localization_priority: Priority
7+
---
8+
9+
# Frequently Asked Questions
10+
11+
## What's the impact of running a scan and how do I get the best performance
12+
13+
The scanner is only doing read operations and will not cause a big impact on your tenant. The scanner is also "throttling-aware" and will back off when a tenant responds with a throttle response.
14+
15+
If you do have a large tenant than a scan can take a long time. Some tips to speed up the scan are:
16+
17+
- Only scan for what you need. Doing a **full** scan is easy but will also take the most time
18+
- Partition your scans:
19+
- Do a run per scan output you need
20+
- Scan for a subset of your site collections
21+
- Run the scan from a machine that's relatively seen close to the region where your SharePoint tenant is hosted. E.g. running the scan from an Azure VM in the same region will typically give you the best results.
22+
23+
## I only want to scan a few sites, can I do that?
24+
25+
Using the urls command line switch you can control which sites are scanned. You can specify one or more url's which can have a wild card. Samples of valid url's are:
26+
27+
- https://contoso.sharepoint.com/sites/portals*
28+
- https://contoso.sharepoint.com/sites/hrportal
29+
- https://contoso-my.sharepoint.com/personal/*
30+
31+
To specify the url's you can use the -r parameter as shown below:
32+
33+
```console
34+
SharePoint.Modernization.Scanner -r https://contoso.sharepoint.com/sites/portals*,https://contoso.sharepoint.com/sites/hrportal,https://contoso-my.sharepoint.com/personal/*
35+
-i 7a5c1615-997a-4059-a784-db2245ec7cc1
36+
-s eOb6h+s805O/V3DOpd0dalec33Q6ShrHlSKkSra1FFw=
37+
```
38+
39+
An alternative model is specifying the url's inside a CSV file and then using the -f parameter as shown below:
40+
41+
```console
42+
SharePoint.Modernization.Scanner -v "c:\temp\files.csv"
43+
-i 7a5c1615-997a-4059-a784-db2245ec7cc1
44+
-s eOb6h+s805O/V3DOpd0dalec33Q6ShrHlSKkSra1FFw=
45+
```
46+
47+
A sample file would look like this:
48+
49+
```console
50+
https://contoso.sharepoint.com
51+
https://contoso.sharepoint.com/sites/test1
52+
https://contoso.sharepoint.com/sites/test2
53+
```
54+
55+
## Can I generate the Excel reports for existing scan data?
56+
57+
You can do this by specifying the folder(s) with already existing scan data using the -g parameter. The scanner will concatenate the data from all passed folders and will generate the needed reports. Reports will only be generated if the relevant data is available.
58+
59+
```console
60+
SharePoint.Modernization.Scanner -g <paths>
61+
62+
SharePoint.Modernization.Scanner -g "c:\temp\636529695601669598,c:\temp\636529695601698765"
63+
```
64+
65+
## I'm running SharePoint with vanity URL's (SharePoint Online Dedicated), is this different?
66+
67+
In SharePoint Online Dedicated one can have vanity url's like teams.contoso.com which implies that the tool cannot automatically determine the used url's and tenant admin center url. Using below command line switches you can specify the site url's to scan and the tenant admin center url. Note that the urls need to be separated by a comma.
68+
69+
```console
70+
SharePoint.Modernization.Scanner -a <tenantadminsite> -r <wildcard urls> -i <clientid> -s <clientsecret>
71+
```
72+
73+
A real life sample:
74+
75+
```console
76+
SharePoint.Modernization.Scanner -a https://contoso-admin.contoso.com
77+
-r "https://teams.contoso.com/sites/*,https://portal.contoso.com/*"
78+
-i 7a5c1615-997a-4059-a784-db2245ec7cc1 -s eOb6h+s805O/V3DOpd0dalec33Q6ShrHlSKkSra1FFw=
79+
```
80+
81+
## I want to use an Azure AD app to authenticate, how do I that?
82+
83+
This scanner, like all scanners built using the SharePoint Scanner framework, do support Azure AD App-Only:
84+
85+
```console
86+
SharePoint.Modernization.Scanner -t <tenant> -i <Azure App ID> -z <Azure AD Domain>
87+
-f "<Path to PFX file holding your certificate" -x <Password for the PFX file>
88+
```
89+
90+
A real life sample:
91+
92+
```console
93+
SharePoint.Modernization.Scanner -t contoso -i e4108e9b-9865-44a9-c6e1-9003db04a775 -z contoso.onmicrosoft.com
94+
-f "C:\scanning\AzureADAppOnlyScanning.pfx" -x pwd
95+
```
96+
97+
## I don't want to use app-only, can I use credentials?
98+
99+
The best option is to use app-only since that will ensure that the tool can read all site collections but you can also run the tool using credentials.
100+
101+
```console
102+
SharePoint.Modernization.Scanner -m GroupifyOnly -t <tenant> -u <user> -p <password>
103+
104+
SharePoint.Modernization.Scanner -t <tenant> -u <user> -p <password>
105+
```
106+
107+
A real life sample:
108+
109+
```console
110+
SharePoint.Modernization.Scanner -m GroupifyOnly -t contoso -c [email protected] -p mypassword
111+
112+
SharePoint.Modernization.Scanner -t contoso -c [email protected] -p mypassword
113+
```
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: The SharePoint modernization scanner reports for the blog scanner mode
3+
description: Explains the blog output created by the modernization scanner
4+
ms.date: 10/23/2019
5+
ms.prod: sharepoint
6+
localization_priority: Priority
7+
---
8+
9+
# SharePoint Modernization scanner reports: Blog reports
10+
11+
## Excel dashboard
12+
13+
![Blog dashboard](media/modernize/excel_blogusage.png)
14+
15+
## Understanding the ModernizationBlogWebScanResults.csv file
16+
17+
This report contains the following columns:
18+
19+
Column | Description
20+
---------|----------
21+
**Site Collection Url** | Url of the scanned site collection.
22+
**SiteUrl** | Url of the scanned web.
23+
**Web Relative Url** | Relative Url of the scanned web.
24+
**Web Template** | Used web template (should all be BLOG#0).
25+
**Language** | Language used to create the blog site.
26+
**Blog Page Count** | Number of blog posts in this site.
27+
**Last blog change date** | Last blog post change date for this site.
28+
**Last blog publish date** | Last blog post publish date for this site.
29+
**Change Year** | Year of the last blog post change.
30+
**Change Quarter** | Quarter of the last blog post change.
31+
**Change Month** | Month of the last blog post change.
32+
33+
### Key takeaways from this report ###
34+
35+
Load the ModernizationBlogWebScanResults.csv into Microsoft Excel and use below filters to analyze the received data
36+
37+
Filter | Takeaway
38+
---------|----------
39+
**No filter** | Lists all the blog sites found in your tenant.
40+
**Blog Page Count > 10 AND Change Year = this year** | A good filter to identify the actively used blog sites in your tenant. These sites are good candidates for modernization.
41+
42+
## Understanding the ModernizationBlogPageScanResults.csv file
43+
44+
This report contains the following columns:
45+
46+
Column | Description
47+
---------|----------
48+
**Site Collection Url** | Url of the scanned site collection.
49+
**SiteUrl** | Url of the scanned web.
50+
**Web Relative Url** | Relative Url of the scanned web.
51+
**Page Title** | Title of this blog post.
52+
**Modified At** | Last modified date of this blog post.
53+
**Modified By** | This blog post was last modified by.
54+
**Published At** | This blog post was published at.
55+
56+
### Key takeaways from this report ###
57+
58+
Load the ModernizationBlogPageScanResults.csv into Microsoft Excel and use below filters to analyze the received data
59+
60+
Filter | Takeaway
61+
---------|----------
62+
**No filter** | Lists all the blog posts found in your tenant.
63+
**Modified At in this year** | Gets you all the blog posts which have been edited in the current year.

0 commit comments

Comments
 (0)