1. Home
  2. Adapters
  3. Microsoft
  4. Microsoft Adapters: Standard and Advanced Fields in Job Configuration

Microsoft Adapters: Standard and Advanced Fields in Job Configuration


Microsoft adapters have several fields that enable you to optimize your migration experience in various ways. The fields described below are not available for all adapters.

Standard Fields

DOCUMENT LIBRARY:  [Deprecated] You must select a Document Library.  If selecting a Team Site and Document Library, select the Team Site first and wait for that to validate.  Then select the Document Library and wait for that to validate.  You will only see this option on Legacy jobs. New jobs will select SharePoint doc libraries via the file chooser.

Leave this field blank for OneDrive Personal.

Microsoft Account: This is where you enter your user credentials for your Microsoft tenant. Click on the Click Here to Log In button to enter authorization for CFP to access your tenant.


  • For OneDrive Personal, keep the specified default of https://api.onedrive.com.
  • For OneDrive for Business (non admin system), enter the path to your OneDrive tenant in the format: https://tenantName-my.sharepoint.com (e.g., https://company-my.sharepoint.com).
  • For OneDrive for Business (admin), you can leave this field blank. The admin credentials will automatically provide directives on the OneDrive site url to the system.

Sub Site Name [Deprecated]: Leave this field blank.

Advanced Fields

Add Permission to Owner: Add permission to the owner when creating folders. Default permission added to folders is Contribute (Edit). Do not change this field unless advised to do so by Tervela support.

Check Permission of Owner: Check that the owner has write permission when listing folders. Default is deselected; do not change this field unless advised to do so by Tervela support.

COMPRESSED CONTENT:  This provides optimization for sending compressed files such as .zip and .tar files. Leave this checkbox deselected unless you are sending compressed files.

Create External Collaborators:  If this option is selected, CFP will automatically create a guest (external) user on the Microsoft tenant that has an ID if an item is shared with that user and they are not present on the tenant.  Default is false; use this option with caution, as it may create guest users that do not have the standard email confirmation of their identity.

Decoupled SPO Migration Jobs: Selecting this option enables the CFP job to complete before all file batches have been confirmed migrated from Azure to their final destinations in SPO and OneDrive. The Microsoft API limits CFP to transferring files only as far as the Azure server; Microsoft alone must transfer those files, in batches, to their final destinations in the SPO/OneDrive layer of the tenant. Because confirmation of straggling batches can take several hours, the CFP job can complete sooner if it doesn’t wait for this confirmation. However, files that are still in pending batches at the time the job “completes” will have a status of batch-queued, and cannot be considered transferred until the job later runs and those files have a status of match-exists (meaning the batch did eventually complete) or success (meaning the batch failed on the first job, but CFP transferred the files on the next sync run). Therefore, if you see any file statuses of batch-queued in your transfer report when this option is set, you must run the job again at a later time to confirm that all batches have completed successfully.

Once the first instance of the job starts, batches will be queued up on the Azure server.

If you attempt to run the job again while one of these batches from the previous job is still queued up to move from Azure to SPO/OneDrive, the job will fail with this message:

Previous batch jobs still busy 0 queued 1 processing 250 files 0 dirs 1142719 bytes

You can periodically re-run the job again until it has a status of complete, at which time all batch-queued statuses should be gone from the transfer report.

If the Decoupled SPO Migration Jobs option is selected, you must also ensure that Use SPO Migration API and Use SPO Migration API to Create Directories are selected. Both of the SPO Migration API options are selected by default.

Enable Async Metadata Read This feature enables CFP to list the entire contents of an element selected in your Microsoft (OneDrive or SPO) source or target node in a single rest call. It makes the listing of Microsoft sites and directories much faster and more efficient under most circumstances, but is optimized for large folders and, in data sets that have many small folders, performance may be better without AMR. Default for this option is checked on; leave it checked unless directed to do otherwise by Tervela support.

KEEP EXISTING PERMISSIONS: Do not delete any permissions on the target when applying ACLs.

KEEP PARENT PERMISSIONS:  If this box is selected, parent permissions on folders will be inherited by child items, even if the child item has reduced permissions. Note that this strategy can be useful if you are trying to minimize the number of ACLs that are applied to a given Microsoft subsite on OneDrive or Sharepoint Online.

LIST ALL PERMISSIONS:  This field stores the permissions associated with every item – file and folder – in the job. Depending on the characteristics of the source and target, and how permissions are shared, the listings in the spreadsheet will be significantly less than this. For example, inherited permissions will not be listed unless there is something that either breaks or expands upon that inheritance. Default for this option is selected; Tervela recommends that you leave this option set at the default.

Max Files Per Upload Batch, Max Bytes Per Upload Batch:  These options – and several other batch parameters listed in Advanced Settings – relate to the overall size, configuration and management of the batches that are moved from Azure to OneDrive and SPO.  These fields all have default settings optimized for the vast majority of migrations, but in rare instances, Microsoft may advise Tervela to tweak these in response to characteristics of the data set or tenant.  Leave these settings at the defaults unless otherwise advised by Tervela support.

Parallel Upload of File Versions Limit: The max number of concurrent versions to upload for a given file at any one time.

Reapply Matching Permissions: If this option is selected, it will reapply permissions to all shared items, regardless of whether they are already present on the target. Leave these settings at the defaults unless otherwise advised by Tervela support.

SHAREPOINT ONLINE SITE URL:  Enter your Sharepoint site URL for the non admin SharePoint system. If your company is companyName, the standard URL would be https://companyName.sharepoint.com. Leave this field blank for the admin version of the SharePoint system unless advised to complete it by Tervela support.

SHAREPOINT ONLINE TEAM SITE NAME:  [Deprecated] You may optionally select a Team Site name from the dropdown to transfer a subset of your SharePoint data. You will only see this option on Legacy jobs. New jobs will select SharePoint subsites via the file chooser.

Sharing Message: The message sent to first time (i.e., not yet registered with the tenant) external user sharees on Microsoft target jobs. Default content is “Created by Cloud_FastPath,” but you can edit this to fit your needs.

Suppress Email Notification for Sharing: This setting, for jobs that have OneDrive or SPO as a target, suppresses email notifications for when items are shared with unregistered external (guest) sharees. Email notifications for registered guest sharees and internal sharees are suppressed independent of whether this option is set or not. Note that an email to an unregistered guest sharee does two things: it notifies the user that s/he has data that is shared, and provides a link in the email to register with the tenant as a guest user. If you suppress these emails, the user can be registered manually as a guest, but it requires admin intervention. Once the external sharee registers as a guest and is known to the tenant with a user id, they will not receive further sharing notifications.

TENANT URL:  Enter your O365 Tenant Admin URL (e.g., https://companyName-admin.sharepoint.com). This field is primarily for users who have custom URLs for their tenant that deviate from the standard format. Leave this field blank unless advised to complete it by Tervela support.

Use SPO Migration API: Uses the Sharepoint API rather than the OneDrive API when selected. Leave this field selected unless advised to deselect it by Tervela support.

Use SPO Migration API to Create Directories: Uses the Sharepoint API to apply user metadata to folders on OneDrive and SPO targets. It must be selected to send folder Last Modifier (“Use Last Modifier” option must be set and configured; available only on select source platforms) to OneDrive folders. If “Use Last Modifier” is not set, the “Use SPO Migration API to Create Directories” should still be selected, as it ensures that the OneDrive target account user will be listed as the last modifier of all their folders. If this option is not selected, the admin used to oauth the OneDrive system will be listed as the last modifier of all folders transferred to OneDrive, which can confuse and concern individual end users.



Updated on November 18, 2021

Related Articles