Skip to content

Commit 60fec33

Browse files
committed
doc updates
1 parent 758c71b commit 60fec33

File tree

5 files changed

+51
-43
lines changed

5 files changed

+51
-43
lines changed
Loading
Loading
Loading

docs/transform/modernize-scanner-reports-workflow.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Column | Description
2626
**Scope** | Workflows are either connected to a site, list or content type.
2727
**Has subscriptions** | Is this workflow being used or is it just defined.
2828
**Enabled** | Is the workflow enabled.
29-
**Is OOB** | Is this one of the OOB workflows that SharePoint Online has.
29+
**Is OOB** | Is this one of the OOB workflows that SharePoint Online has. (OOB workflows are never analyzed)
3030
**List Title** | If the workflow is scoped to a list this contains the title of that list.
3131
**List Url** | If the workflow is scoped to a list this contains the url of that list.
3232
**List Id** | If the workflow is scoped to a list this contains the id of that list.
@@ -38,16 +38,16 @@ Column | Description
3838
**Subscription Name** | Name of the subscription created for this workflow.
3939
**Subscription Id** | Id of the subscription created for this workflow.
4040
**Definition Changed On** | When was this workflow definition last changed.
41-
**Subscription Changed On** | When was the workflow subscription last changed.
42-
**Action Count** | Number of actions detected in this workflow.
43-
**Used Actions** | List of the unique actions used in this workflow.
44-
**Used Triggers** | List of the workflow triggers that trigger this workflow to start.
45-
**Flow upgradability** | % indicating how well the detected actions are upgradable to Microsoft Flow.
46-
**Incompatible Action Count** | Number of actions that are not compatible with Microsoft Flow.
47-
**Incompatible Actions** | List of unique actions which are not compatible with Microsoft Flow.
48-
**Change Year** | Year of last workflow definition change.
49-
**Change Quarter** | Quarter of last workflow definition change.
50-
**Change Month** | Month of last workflow definition change.
41+
**Subscription Changed On** | When was the workflow subscription last changed. (only when used with the `WorkflowWithDetailsOnly` or `Full` mode)
42+
**Action Count** | Number of actions detected in this workflow. (only when used with the `WorkflowWithDetailsOnly` or `Full` mode
43+
**Used Actions** | List of the unique actions used in this workflow. (only when used with the `WorkflowWithDetailsOnly` or `Full` mode
44+
**Used Triggers** | List of the workflow triggers that trigger this workflow to start. (only when used with the `WorkflowWithDetailsOnly` or `Full` mode
45+
**Flow upgradability** | % indicating how well the detected actions are upgradable to Microsoft Flow. (only when used with the `WorkflowWithDetailsOnly` or `Full` mode
46+
**Incompatible Action Count** | Number of actions that are not compatible with Microsoft Flow. (only when used with the `WorkflowWithDetailsOnly` or `Full` mode
47+
**Incompatible Actions** | List of unique actions which are not compatible with Microsoft Flow. (only when used with the `WorkflowWithDetailsOnly` or `Full` mode
48+
**Change Year** | Year of last workflow definition change. (only when used with the `WorkflowWithDetailsOnly` or `Full` mode
49+
**Change Quarter** | Quarter of last workflow definition change. (only when used with the `WorkflowWithDetailsOnly` or `Full` mode
50+
**Change Month** | Month of last workflow definition change. (only when used with the `WorkflowWithDetailsOnly` or `Full` mode
5151

5252
### Key takeaways from this report ###
5353

docs/transform/modernize-scanner.md

Lines changed: 40 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -74,20 +74,22 @@ The easiest approach is to simply launch SharePoint.Modernization.Scanner.exe as
7474

7575
The first page of the modernization scanner wizard asks you for authentication information. The scanner supports four options, select the one you need and fill in the needed information as described below. Ideally you use an app-only model as that will ensure the scanner has access to all sites it needs to scan.
7676

77-
![Azure AD App-Only](media/modernize/scanner_p1_1_2.9.png)
77+
![Azure AD App-Only](media/modernize/scanner_p1_1_2.14.png)
7878

7979
If you've [setup access via Azure AD App-Only](../solution-guidance/security-apponly-azuread.md), you do have created an Azure App and configured a certificate for accessing it. This information needs to be provided to the tool:
8080

8181
- **Azure AD Application ID**: ID of the created application in your Azure AD environment
8282
- **Azure AD Domain name**: the default ___domain of your Azure AD environment. You can find this from the overview page of the Azure AD admin center. Typically this ___domain is formatted as *.onmicrosoft.com, for example, contoso.onmicrosoft.com.
8383
- **Certificate file**: the certificate that you granted app-only access to the Azure AD app, this needs to be presented as a password protected PFX file
8484
- **Password for the PFX file**: the password used to secure the previously provided PFX file
85+
- **Authentication region**: if your tenant is located in the US Government (ITAR), Germany or China cloud environment then select the respective region
8586

8687
> [!NOTE]
8788
> You can also opt to install the certificate on your computer and reference it via the -w command line parameters. To reference the certificate you would use this value for the -w parameter "My|CurrentUser|1FG498B468AV3895E7659C8A6F098FB701C8CDB1". You can use My/Root and CurrentUser/LocalMachine to identify the store. The last argument is the certificate thumbprint. This option is available as of the 2.7 release. If you're using LocalMachine then be aware that you'll need to ensure the scanner has permissions to read in the LocalMachine store. You can do this by either running the scanner process under administrative privileges or alternatively (and better) grant the account you're using to run the modernization scan permissions to read the private key of the certificate stored in the LocalMachine store.
88-
>
89+
8990
> [!IMPORTANT]
90-
> The default instructions mentioned to grant the Azure AD app the **Sites.FullControl.All** permission which is needed if you want to run all scan components. If you're not interested in workflow scanning you can also use **Sites.Read.All** as a permission as of version 2.6 of the SharePoint Modernization Scanner.
91+
> - The default instructions mentioned to grant the Azure AD app the **Sites.FullControl.All** permission which is needed if you want to run all scan components. If you're not interested in workflow scanning you can also use **Sites.Read.All** as a permission as of version 2.6 of the SharePoint Modernization Scanner.
92+
> - Azure AD App-Only is the only supported authentication option for tenants in the US Government (ITAR), Germany or China cloud environment.
9193
9294
#### Authenticate via SharePoint AD app-only
9395

@@ -139,7 +141,7 @@ If you're using URLs that do not end on sharepoint.com (so called vanity URLs),
139141

140142
#### Scan a list of site collections defined in a CSV file
141143

142-
![CSV file](media/modernize/scanner_p2_3_2.9.png)
144+
![CSV file](media/modernize/scanner_p2_3_2.14.png)
143145

144146
As a third option you can provide the scanner with a CSV file listing the site collections to scan. This CSV file is a simple list of site collections, the file doesn't have a header as shown in this sample:
145147

@@ -153,7 +155,7 @@ https://contoso.sharepoint.com/sites/opensourcerocks
153155

154156
The SharePoint modernization scanner does support multiple modes, depending on your modernization mode you might want to scope the scan to a certain area or alternatively, execute a full scan.
155157

156-
![scanner modes](media/modernize/scanner_p3_1_2.8.png)
158+
![scanner modes](media/modernize/scanner_p3_1_2.14.png)
157159

158160
Select the option you want in the dropdown and then the checkboxes will show which components will be included in the scan. The "Microsoft 365 group connection readiness" component is the main component that will be included all scan modes.
159161

@@ -213,13 +215,14 @@ Mode | Description
213215
`PublishingOnly` | Includes a classic publishing portal scan at site and web level + includes the Microsoft 365 group connection readiness component
214216
`PublishingWithPagesOnly` | Includes a classic publishing portal scan at site, web and page level + includes the Microsoft 365 group connection readiness component
215217
`WorkflowOnly` | Includes the classic workflow scan + includes the Microsoft 365 group connection readiness component
218+
`WorkflowWithDetailsOnly` | Includes the classic workflow scan with workflow migration readiness analysis + includes the Microsoft 365 group connection readiness component
216219
`InfoPathOnly` | Includes the InfoPath scan + includes the Microsoft 365 group connection readiness component
217220
`BlogOnly` | Includes the Blog scan + includes the Microsoft 365 group connection readiness component
218221

219222
### Command-line parameter overview
220223

221224
```text
222-
SharePoint PnP Modernization scanner 2.9.0.0
225+
SharePoint PnP Modernization scanner 2.14.0.0
223226
Copyright (C) 2020 SharePoint PnP
224227
==========================================================
225228
@@ -267,31 +270,6 @@ e.g. SharePoint.Modernization.Scanner.exe -r "https://teams.contoso.com/sites/*,
267270
https://contoso-admin.contoso.com -u [email protected] -p pwd
268271
269272
270-
-m, --mode (Default: Full) Execution mode. Use following modes: Full, GroupifyOnly,
271-
ListOnly, HomePageOnly, PageOnly, PublishingOnly, PublishingWithPagesOnly,
272-
WorkflowOnly, InfoPathOnly or BlogOnly. Omit or use full for a full scan
273-
274-
-b, --exportwebpartproperties (Default: False) Export the web part property data
275-
276-
-c, --skipusageinformation (Default: False) Don't use search to get the site/page usage information and
277-
don't export that data
278-
279-
-j, --skipuserinformation (Default: False) Don't include user information in the exported data
280-
281-
-k, --skiplistsonlyblockedbyoobreaons (Default: False) Exclude lists which are blocked due to out of the box
282-
reasons: base template, view type of field type
283-
284-
-d, --skipreport (Default: False) Don't generate an Excel report for the found data
285-
286-
-g, --exportpaths List of paths (e.g. c:\temp\636529695601669598,c:\temp\636529695601656430)
287-
containing scan results you want to add to the report
288-
289-
-n, --disabletelemetry (Default: False) We use telemetry to make this a better tool...but you're
290-
free to disable that
291-
292-
-q, --dateformat (Default: M/d/yyyy) Date format to use for date export in the CSV files. Use
293-
M/d/yyyy or d/M/yyyy
294-
295273
-i, --clientid Client ID of the app-only principal used to scan your site collections
296274
297275
-s, --clientsecret Client Secret of the app-only principal used to scan your site collections
@@ -302,6 +280,9 @@ https://contoso-admin.contoso.com -u [email protected] -p pwd
302280
303281
-z, --azuretenant Azure tenant (e.g. contoso.microsoftonline.com)
304282
283+
-y, --azureenvironment (Default: Production) Azure environment (only works for Azure AD Cert
284+
auth!). Possible values: Production, USGovernment, Germany, China
285+
305286
-f, --certificatepfx Path + name of the pfx file holding the certificate to authenticate
306287
307288
-x, --certificatepfxpassword Password of the pfx file holding the certificate to authenticate
@@ -315,7 +296,8 @@ https://contoso-admin.contoso.com -u [email protected] -p pwd
315296
316297
-r, --urls List of (wildcard) urls (e.g.
317298
https://contoso.sharepoint.com/*,https://contoso-my.sharepoint.com,https://co
318-
ntoso-my.sharepoint.com/personal/*) that you want to get scanned. Ignored if -t or --tenant is provided.
299+
ntoso-my.sharepoint.com/personal/*) that you want to get scanned. Ignored if
300+
-t or --tenant are provided.
319301
320302
-o, --includeod4b (Default: False) Include OD4B sites in the scan
321303
@@ -326,6 +308,32 @@ https://contoso-admin.contoso.com -u [email protected] -p pwd
326308
327309
-e, --separator (Default: ,) Separator used in output CSV files (e.g. ";")
328310
311+
-m, --mode (Default: Full) Execution mode. Use following modes: Full, GroupifyOnly,
312+
ListOnly, PageOnly, HomePageOnly, PublishingOnly, PublishingWithPagesOnly,
313+
WorkflowOnly, WorkflowWithDetailsOnly, InfoPathOnly or BlogOnly. Omit or use
314+
full for a full scan
315+
316+
-b, --exportwebpartproperties (Default: False) Export the web part property data
317+
318+
-c, --skipusageinformation (Default: False) Don't use search to get the site/page usage information and
319+
don't export that data
320+
321+
-j, --skipuserinformation (Default: False) Don't include user information in the exported data
322+
323+
-k, --skiplistsonlyblockedbyoobreaons (Default: False) Exclude lists which are blocked due to out of the box
324+
reasons: base template, view type of field type
325+
326+
-d, --skipreport (Default: False) Don't generate an Excel report for the found data
327+
328+
-g, --exportpaths List of paths (e.g. c:\temp\636529695601669598,c:\temp\636529695601656430)
329+
containing scan results you want to add to the report
330+
331+
-n, --disabletelemetry (Default: False) We use telemetry to make this a better tool...but you're
332+
free to disable that
333+
334+
-q, --dateformat (Default: M/d/yyyy) Date format to use for date export in the CSV files. Use
335+
M/d/yyyy or d/M/yyyy
336+
329337
-w, --storedcertificate (Default: ) Path to stored certificate in the form of
330338
StoreName|StoreLocation|Thumbprint. E.g.
331339
My|LocalMachine|3FG496B468BE3828E2359A8A6F092FB701C8CDB1

0 commit comments

Comments
 (0)