Merge pull request #6 from tony-li-avepoint/main

Add FAQ section
AvePoint · May 8, 2023 · ed5bb76 · ed5bb76
2 parents 7f25f32 + 4702960
commit ed5bb76
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 7 deletions.
diff --git a/powershell/README.md b/powershell/README.md
@@ -45,8 +45,6 @@ $certificate = (Get-ChildItem -Path 'Cert:\LocalMachine\My\304CAFB0719971D7F180D
 ```
 After you connect to Fly public API, then you can perform various operations like creating projects, adding mappings to projects, running jobs and monitoring mapping migration status, etc.
 
-**Note**: this command is valid for one hour, run the command again in case of timeout or 401(Unauthorized) error code.
-
 ### 2. [**New-FlyMigrationProject**](docs/FlyProjectApi.md#new-flymigrationproject)
 Following PowerShell command will create a SharePoint project:
 ```powershell
@@ -110,13 +108,13 @@ After all the mappings are finished, you can use the following command to genera
 ```powershell
 Export-FlySharePointMigrationReport `
     -Project "project name" `
-    -OutFile "file path to store the generated migration report" `
+    -OutFolder "file path to store the generated migration report" `
     -Mappings "csv file contains all mappings you want to export report of" `
     -FileType "Excel or CSV" `
     -TimeZoneOffset "your timezone offset, this value will be used to adjust time values in the report" `
     -Include "Object status to be included in the generated report"
 ```
-Only ```-Project``` and ```-OutFile``` are required for this command.
+Only ```-Project``` and ```-OutFolder``` are required for this command.
 If you omit the ```-Mappings``` parameter, this command will generate report for all mappings with proper status in this project.
 ```-FileType``` will be defaulted to CSV if you omit it.
 If you omit ```-TimeZoneOffset```, this command assume you want to use UTC time.
@@ -126,6 +124,18 @@ If you omit ```-Include``` parameter, only summary information will be included
 
 We also provided some other powershell commands with which you can automate your migration process. You can refer to the [**documentation**](docs/FlyApi.md) for more details.
 
+## FAQ
+
+- **Q** How can I find the Fly public API URL when using [**Connect-Fly**](docs/FlyConnectApi.md#connect-fly)?
+  - **A**: The public API URL varies with your data center. Choose the public API URL according to your data center. Please refer to [**Fly user guide**](https://cdn.avepoint.com/assets/webhelp/fly/index.htm#!Documents/usepowershellsdk.htm) for more details.
+- **Q**: What can I do if there is a 401(Unauthorized) error?
+  - **A**: This error code means your access token is expired, normally the token is valid for one hour, you need run [**Connect-Fly**](docs/FlyConnectApi.md#connect-fly) to retrieve the access token again, then continue with the other cmdlets.
+- **Q**: How can I handle 429(Too many request) error?
+  - **A**: You can use following code to wait for the end of Fly public API rate limit, then continue with the other cmdlets.
+    ```powershell
+    Start-Sleep -Seconds 60
+    ```
+
 ## About Fly 
 
 [AvePoint Fly](https://www.avepointonlineservices.com) provides an all-in-one migration solution for Exchange Online, Exchange On-Premises, Microsoft Teams, SharePoint Online, OneDrive for Business, Microsoft 365 Groups, Power Platform, and Microsoft Teams Chat. The solution allows organizations to simply and quickly migrate objects between sources and destinations without the need for any installation or complex configuration. 
diff --git a/powershell/docs/FlyProjectApi.md b/powershell/docs/FlyProjectApi.md
@@ -54,7 +54,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **Projects** | **String[]**| Specify a list of project names to generate their error report. 
  **OutFolder** | **String**| Specify the folder path of error report file to download. 
- **FileType** | **String**| Specify the format of the generated report file, use Tab for available values, optional if use CSV type. | [optional]
+ **FileType** | **String**| Specify the format of the generated report file, support 'CSV' and 'Excel', optional if use CSV type. | [optional]
  **TimeZoneOffset** | **Int32**| Specify the UTC timezone offset of current browser. This value will be used to adjust time values when generating the report file, optional for UTC timezone. | [optional]
 
 ### Example

diff --git a/powershell/docs/FlySharePointApi.md b/powershell/docs/FlySharePointApi.md
@@ -82,7 +82,7 @@ Name | Type | Description  | Notes
  **Project** | **String**| Specify the name of the project to export mappings. | 
  **OutFile** | **String**| Specify the csv file path of the project mappings to export. | 
  **Mappings** | **String**| Specify the csv file to specific project mappings to export, optional if you want to export the whole project mappings. | [optional]
- **FileType** | **String**| Specify the format of the generated report file, use Tab for available values, optional if use CSV type. | [optional]
+ **FileType** | **String**| Specify the format of the generated report file, support 'CSV' and 'Excel', optional if use CSV type. | [optional]
  **TimeZoneOffset** | **Int32**| Specify the UTC time offset of current browser. This value will be used to adjust time values when generating the report file, optional for UTC timezone. | [optional]
  **Include** | **String**| Specify a list of objects to be included in the migration report, use Tab for available values, optional if you do not export object details. | [optional]
 
@@ -165,7 +165,7 @@ Start a migration job against the selected project mappings.
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **Project** | **String**| Specify the name of the project to run job. | 
- **Mode** | **String**| Specify the mode of the migration job, use Tab for available values. | 
+ **Mode** | **String**| Specify the mode of the migration job, support 'FullMigration', 'IncrementalMigration' and 'ErrorOnly', 'PermissionOnly'. | 
  **Mappings** | **String**| Specify the csv file to specific project mappings to run job, optional if you want to specify all of the mappings of the project. | [optional]
  **ScheduleTime** | **DateTime**| Specify the UTC time when you want the job to be scheduled. By default the job will be executed as soon as possible, optional for no schedule. | [optional]