Chat now with support
Chat with Support

Metalogix Content Matrix 8.9 - SharePoint Edition User Guide

Introduction Entering the License Key Content Matrix Console End User Interface Enabling Advanced Mode Connecting to SharePoint Migrating to O365 Using the Azure Pipeline/SPO Containers Preparing for a Migration How Content Matrix Handles Various SharePoint Components Initiating a Migration Configuring Copying Options Saving or Running a Migration Action Copying SharePoint Objects as a Separate Action Self-Service Migration Incremental Migration Log Files Using PowerShell with Content Matrix
Configuring PowerShell for Use with Content Matrix
Registering Metalogix Command DLL Files Adding PowerShell Snap-Ins for the Application Framework Content Matrix PowerShell Commandlet List
Metalogix.System.Commands Metalogix.SharePoint.Commands Metalogix.Jobs.Reporting.Commands Metalogix.SharePoint.Migration.Commands
Modifying Content Matrix Configuration and Settings Configuring Content Matrix for Distributed and Self-Service Migration Frequently Asked Questions
DB_Owner Permission Migrating with the Fabulous 40 Templates Item Count Discrepancies Keyboard Shortcuts License Key Troubleshooting Determining the Status of a Migration Running in the Background MySite and User Profile Migration Issues Optimal Setup for Best Performance Using Proxies, Load Balancing or Alternate Access Mappings Troubleshooting the Extensions Web Service Installing the Extensions Web Service on Specific Systems Extensions Web Service Installation Files Using Older Versions of the Extensions Web Service Preserving IDs when Migrating a Custom List as a Folder Migrating JavaScript Migrating Site Variations Migrating with SharePoint Document IDs Changing a Job Configuration for Multiple Files SharePoint 2003 Version Migration Limitations SharePoint 2013 and Later Site Collection Creation Issue Job List Database fails to Load After Upgrade Customized Wiki Page Web Part Zones Not Being Migrated Preserving SharePoint List Item IDs with a CSOM Connection Type Retrying Failed Document Copies to O365 CSOM Connections Migrating Content When the Source Custom List Template is Missing Are SharePoint Online Migrations Throttled? What to Expect when Migrating with StoragePoint on the Target Migration Error Message 'There was an Error Reading from the Pipe: The Pipe has been Ended (109, 0xd6)' How do I Remove Items from My Azure Blob Storage Account? Azure Batches Getting Stuck "Error, the batch will be resubmitted" Message Displays When Using Azure Item Count at Target is Increased When Migrating Using the Azure Pipeline Custom Lists with Versioning Enabled Not Being Migrated When Using the Azure Pipeline Supported Nintex Actions for SPO Migration "Insufficient Credentials" Message Connecting to Modern Team Site Using Web Browser Authentication Error Making a Browser-Based Connection with PowerShell Console Open
About Us

Migration Mode

Simplified UI   Advanced Migration Mode

To configure Migration Mode:

1.Select the mode that you want to use.  Use the information in the following table for guidance.

If …

Select …

·you are performing an initial copy or want a clean copy of the source to be migrated to the target.


·you want to overwrite any existing data on the target that matches migrated content

Full Copy.


·Comparing whether an object from the source matches an object on the target is usually performed by comparing the names of the objects. The only exception to this is that items in custom lists are matched by ID number (documents in document libraries are matched by file name).

·When this option is selected, the Preserve Item IDs option for items in lists (not libraries) is enabled. This is to ensure that the target has the exact same item IDs as the source so that the copy is a mirror of the source. This is required in order to perform incremental migrations later, since item ID values are used to match corresponding items on the source and target.

·you are performing an incremental migration


·you want to preserve (not overwrite) data on the target.

Incremental Copy.


·Only objects that do not yet exist on the target are copied.

EXCEPTION:  For lists and libraries that have versioning enabled, new versions will be copied from the source, while all versions that already exist on the target will be preserved.

·When this option is selected:

§the Preserve Item IDs option is enabled, and

§the Workflow Copy Options is disabled .(Incremental copies cannot be run on workflows.)

you want to choose which objects to preserve or overwrite on the target

Custom Copy.

2.If you selected Custom Copy as the migration mode, you can select the objects that you want to preserve, as well as individual settings that you want to update.  (By default, all options are set to Overwrite, as with a Full Copy.)

Migration Mode - Custom Copy

NOTE:  If you selected Full Copy or Incremental Copy, these options will be disabled.

If you want to …

Then …

·preserve existing sites, and

·(optionally) select specific site settings to be updated
(if newer on the source)

A.Choose Preserve Sites.

B.If you want to update individual site settings, select Update Sites  then, from the Update Existing Options dialog, select the settings you want to update (if newer on the source).  Options are:

§Update Core Metadata (such as  the "web" name, time zone settings, site descriptions, display name, etc

§Update Site Columns

§Update Content Types

§Update Site Navigation Settings

§Update Features

§Update Site Web Parts

§Update Permissions  (at the site-level)

§Update Permission Levels – If Update Permissions is selected, you can also choose to update any permissions levels  that exist on the sites

§Update Associated Group Settings - These are settings for the three basic groups that are associated with a site, the Owners, Members, and Visitors groups.


·preserve existing list settings


·(optionally) select specific list settings to update (if newer on the source)

A.Choose Preserve Lists.

B.If you want to update individual list settings, select Update Lists box then, from the Update List Options dialog, select the elements you want to update (if it is newer on the source).  Options are:

§Update Core Metadata (including list description, title, etc).

§Update Fields – (including settings for columns/fields that are within the lists, but not the values for data within those fields)

§Update Views - When selected, this  option will only update the views for lists and libraries that are within the scope of the migration. This will check to see is any views have been edited or added to the lists within the migration, and adds any new or modified views that it finds. This will not migrate any "Personal" views.

§Update Content Types at the list level

§Update Permissions  at the list level

C.Check modified dates for Lists - update the list metadata if the value on the source is greater than the value on the target.

When selected, this option will check the Modified Date for a SharePoint list, and will only update the list metadata if the value on the source is greater then the value on the target.



This option is available only if you have  already chosen to Preserve Existing Sites.

·preserve existing list item settings


·(optionally) select specific list item settings to update (if newer on the source)

A.Choose Preserve List Items.

B.If you want to update individual list item settings, select Update List Items box then, from the Update Items/Documents Options dialog, select the settings you want to update.  Options are:

§Update Core metadata  (including the Authorship fields)

§Update Permissions – When selected, this  option will only update the item level permissions, within the scope of the migration.


This option is available only if you have  already chosen to Preserve Existing Lists.

·delete any items on the target that have since been deleted on the source
(using  item/document ID comparison)

Select Migrate Item Deletions Only.  

(If this option is not selected―which is the behavior for all other Migration Modes―and a file has been deleted from the source, Metalogix Content Matrix will not delete those files from the target.)


NOTE:  This option:

·is available only if you chose to Preserve List Items


·is not available for a SharePoint CSOM (Client Side Object Model) connection to a target environment.

Site Collection Options

If you initiated a site collection level migration, select the Site Collection Options tab (in Simplified mode, Migration Options > Site Collection Options section) and specify the options described below.


Connection icon

Site Collections can only be pasted to a Web App or Farm connection type, using an Object Model (OM) level connection (through the use of a local or Extensions Web Service connection). A similar (but slightly limited) set of Site Collection options is also available for migrating to O365 environments, when an Office 365 Tenant connection is used.


Simplified UI icon

Unless otherwise noted, if you are using Simplified mode and an option is not available for selection, the default value that displays in Advanced mode will automatically be applied.  If you want to change the value of the option, click [Advanced Mode] and switch to the Advanced mode interface.

Site Collection Options

Site Collection Options SIMPLIFIED

To configure Site Collection Options:

1.Use the information in the following table to determine the appropriate action to take.

If your target environment is ….

Then …

On premises

select the Web Application into which you want to migrate the site collection from the drop-down.


Office 365

For Web Application, select the appropriate Url from the drop-down:




2.If different from the default, select an available Language from the drop-down.

NOTE:  If you are using Simplified mode, the primary language of the target SharePoint site will be applied.

3.If different from the default (the template used on the source), select a Site Collection Template from the drop-down.

4.If you are migrating from a SharePoint 2010 source to a SharePoint 2013 On Premises target, choose the Experience Version (2013 or 2010) from the drop-down.

NOTE:  This option is only visible when you are migrating from SharePoint 2010 to 2013.

5.If you are using Advanced mode for an On Premises target:  If the Web Application into which you are migrating the Site Collection has more than one Content Database and you would like to specify the one you want to use, select it from the drop-down.

6.Use the information in the following table to determine the appropriate action to take.

If you want to use …

Then …

a Host Header for your Site Collection Url


(Using Advanced Mode for On Premises target installations only)

·check the Host Header box, and

·enter the host name in the Site Url field.


a path-based Url for your site collection

select the appropriate managed path and enter the Url name in the Site Url field.


7.Use the information in the following table to determine the appropriate action to take.

If your target environment is ….

Then …

On premises

·If different from the default (the migrating account), enter the user account that will be the Primary Administrator for the new Site Collection.

The migrating account should be set as the Primary (or Secondary) Administrator to help ensure that the account can access the new site collection after its creation, so it can migrate the remaining content.

·(Optional) Enter a user account that will be the Secondary Administrator for the Site Collection.

NOTE:  This field does not authenticate, so any spelling mistakes will not be automatically corrected.


Enter the O365 account that will be the Owner/Site Collection Administrator of the new Site Collection.

8.For SharePoint Online tenants::  If different than the default(s), adjust the values for:

§Storage Quota (the amount of storage allocated to the site collection by Microsoft), and/or

§Server Resource Quota (the amount of resources―such as CPU and RAM―allocated to the site collection by Microsoft).

9. If you want to copy Master Pages, Page Layouts, and/or Other Resource from the Master Page Gallery on the source site, select Copy Master Page Gallery.

By default,  Content Matrix will copy all three components Pages, Layouts, and Resources), but, if you are using Advanced mode, you can choose components to include/exclude by clicking the […] button and selecting/deselecting individual components.

Depending on the source and target SharePoint version(s), there are limitations on how Master Pages are migrated.  For details, see How Master Pages are Migrated.

Note that, if you choose to Copy Master Pages and you are using Advanced mode, you also have the option to Correct Links on Master Pages (that is, so links point to the same relative path on the target).  If you leave this box unchecked, links will continue to point to the source.


For more detailed information on link correction, see How Link Correction Works.

10.If your source and target use either the same version of SharePoint or you are migrating from 2010 to 2013 using the 2010 experience and you want to Copy List Template Gallery, check this box.

NOTE:  This option

§Requires an Object Model (OM) connection on both the source and target environments, and

§is not available if you are migrating to a different version of SharePoint (unless you are migrating from 2010 to 2013 using the 2010 experience).

For more information on this option, see How List Template Galleries are Migrated.  

11.For SharePoint On Premises installations: If you want to set a Site Quota:

§select Set Site Quota, and

§if you are using Advanced mode, click the […] button to display the Set Site Quota dialog, and select the appropriate option:


§To Source Value (default) - the quota value from the source site will be used.

§To Individual Values:

§Limit site storage to a maximum of: "X" Mb - The maximum size of the new site collection., in megabytes (Mb)

§Send warning e-mail when site storage reaches: "X" Mb - The size at which to send a warning e-mail to the Site Collection Administrator, that the site collection is getting near it's set volume capacity.

§To Template - Match the same value for a site template on the target side.

NOTE:  This drop down list will only display site templates that contain a site quota value.

12.If you want to Copy Site Collection Admins from the source site collection, make sure this option is selected.  (If you are using Advanced mode, click the […] button to view the Site Collection Administrator(s) on the source Site Collection.)

This option is separate from the Primary Administrator and the Secondary Administrator fields, as it will copy all of the users that are set in the Site Collection Administrators field in the SharePoint Users/Groups section and requires an Object Model connection for both source and target. If removing all of the users from this list users will not be able to add a new user value unless the account that is running the migration has permissions (on the target Site Collection) to add any new accounts. If the migrating account does not have permissions to add a new account, then it is recommended that at least one of the old user accounts that is currently set as a Site Collection Administrator is left in the dialog.*

13.If you want to preserve the source Site Collection’s audit settings on the target, select Copy Audit Settings.

Connection icon

This option is not available from a Native Web Service (NWS) source connection.

Modern Team Site Options

If you initiated an SPO modern team site migration, select the Modern Team Site Options tab (in Simplified mode, Migration Options > Modern Team Site Options section).

Specify the Site Name, Group Email Name, and Privacy Settings as you would if you were creating a modern team site in SharePoint Online.  

Modern Team Site Options


Modern Team Site Creation SHAREPOINT


NOTE:  The Office 365 group e-mail will be automatically generated with the same name as your team site.

MySite Options

If you initiated a MySite migration, select the MySite Options tab and specify the options described below.

Advanced Mode Icon These options are only available when Advanced Mode is enabled.

MySite Options

NOTE: The Available MySites section of the MySite Options tab will only display MySite Site Collections that are using a MySite template (such as SPSPERS#0) and that the current user account has access to. Any MySites that do not meet these requirements will not be displayed. It is also possible that a MySite might not appear because it has run into a timeout issue, but if a Refresh is done for the server, the MySite may then be displayed.

Because language packs are not included in the migration action, the base language setting of the MySite being migrated must already be installed on the target environment. If it is not, an error message containing the language code of the missing language pack will be displayed.

To configure MySite Options:

1.From the MySite Target Web Application drop-down, select the Web application in the target environment into which you want to migrate the MySites.

NOTE: When selecting a web application to use for the migration be sure that the selected target web application contains the MySite host site collection (the site collection that hosts all the MySites). If it doesn't then you won't be able to link the user profile to the site collection. However, different managed paths under the same web application will link the user profiles.

2.For MySite Target Managed Path, select the managed path (which already exist on the target server) that you want to use for the MySite from the drop-down.

In most cases you can select between /sites/ and /my/personal/ for the path, provided these exist in your environment:

§Any sites pasted with the /sites/ option will be displayed as "[Server Name]/sites/[MySite Name]."

§Any sites pasted with the /my/personal/ option will be displayed as "[Server Name]/my/personal/[MySite Name]."

3.From the Available MySites panel, move the MySites you want to migrate to the MySites to Copy panel.  To remove a MySite from the copy action, move it from the MySites to Copy panel back to the Available MySites panel.  

Related Documents