Chat now with support
Chat with Support

Metalogix Content Matrix 9.3 - SharePoint Edition User Guide

Introduction Entering the License Key Content Matrix Console End User Interface Enabling Advanced Mode Connecting and Migrating Account Requirements Connecting to SharePoint Preparing for a Migration How Content Matrix Handles Various SharePoint Components
How Team Sites are Migrated to Modern Team Sites How Publishing Sites are Migrated to Communication Sites How MySites are Migrated How Records Centers are Migrated to SharePoint Online Using the Import Pipeline How Master Pages are Migrated How List Template Galleries Are Migrated How Content Types are Migrated Document Version and Checked Out File Limitations How Ghosted and Un-Ghosted Pages are Migrated How Document Sets are Migrated How Navigation is Migrated How "Share With" Metadata is Migrated to SharePoint Online Using the Import Pipeline How Web Parts are Migrated How Site Themes are Preserved How Site Features Are Migrated How Managed Metadata, Terms, and Term Stores are Migrated How Users and Permissions are Migrated How BCS/BDC Data is Migrated How OneNote Notebooks are Migrated How Customized Form Pages are Migrated How InfoPath Forms are Migrated How SharePoint Workflows are Migrated How Nintex Workflows and Forms are Migrated How Link Correction Works
Initiating a Migration Configuring Copying Options Saving or Running a Migration Job Copying SharePoint Objects as a Separate Action Converting Classic Pages to Modern Pages After a Migration Incremental Migration Using PowerShell with Content Matrix
Configuring PowerShell for Use with Content Matrix Creating and Running a PowerShell Script 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 Migration Frequently Asked Questions
DB_Owner Permission 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 Migrating SharePoint On Premises 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 Migrating JavaScript Migrating Site Variations Migrating with SharePoint Document IDs Changing a Job Configuration for Multiple Files 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 How Do I Identify and Remove Containers and Queues from My Azure Private Storage Account? Import Pipeline Batches Getting Stuck "Error, the batch will be resubmitted" Message Displays When Using the Import Pipeline Item Count at Target is Increased When Migrating Using the Import Pipeline Custom Lists with Versioning Enabled Not Being Migrated When Using the Import Pipeline Supported Nintex Actions for SPO Migration Support for GCC High Tenants
About Us

Setting the Template Path for a Database Connection (When Using Link Correction)

If you are planning on using Link Correction, your Database (DB) connection must point to a specific file location from which to fetch template data. The specified folder location must contain all of the templates that will be used.

1.In the Explorer view tab, navigate to the Database connection for which the template location should be specified.

2.Select the root node of the DB connection, right-click and choose Properties.

3.In the Node Properties dialog line, click the [...] button to the right of the Template Path field, then select the folder that contains the template data.

4.Click [OK].

The following warning message displays:

Changing this setting impacts how data is read from this connection.  If there are any actions currently running that use this connection, changing the setting may invalidate their results.  Continue?

5.To continue, click [OK].

The specified folder location is now listed next to the Template Path line, and all the template data for the DB connection will be called from this location.

Connecting to a SharePoint On Premises Site or Server

The same connection methods and options can be used for a normal connection to SharePoint and a read-only connection to SharePoint. The below steps can be used for both connection types. The read-only connection can be used to help users keep their source and target connection separate (and it can help ensure that users do not accidentally migrate any data to a source connection).

To connect to a SharePoint site or server:

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

If you want to make …

Then in the Metalogix Content Matrix ribbon, choose …

a full connection

Connection > Connect to SharePoint.

A read-only connection

Connection > Connect to SharePoint – Read Only

Connect to SharePoint

To complete the Connection Options tab:

1.For Address, enter either the URL or IP address of the SharePoint site or server to which you want to connect.

Note that the drop-down menu displays a list of previous connections.

2.For Target Type, select the connection type.  Use the information in the following table for guidance.

If you want to connect…

Select …

directly to a SharePoint site

Site.

 

to a specific Web application on a SharePoint server

Web App.

 

NOTE: This option can only be used if using the Local or Metalogix Extensions Web Service connection type.

to a SharePoint instance at the Farm/server level

(which will allow you to see all site collections for all Web Application on the selected server)

Farm.

 

NOTE: This option can only be used if using the Local or Metalogix Extensions Web Service connection type.

3.  Select a Connection Type from the drop-down.  Use the information in the following table for guidance.

Connect to SharePoint Connection Type

If …

Select …

Notes

you want to have Metalogix Content Matrix choose the connection adapter type that makes the most sense for the target SharePoint instance

Auto Detect

·If the SharePoint instance is local (installed on the same machine as the Metalogix Content Matrix Console), the Local Connection (SharePoint Object Model) will be used

·If the SharePoint instance is remote (installed on another machine), and the Metalogix Extensions Web Service is installed, the Remote Connection (Metalogix SharePoint Extensions Web Service) type will be used.

Metalogix Content Matrix Console is installed locally (that is, on the same SharePoint server or one of its Web Front Ends (WFEs)

Local Connection (SharePoint Object Model)

This connection type

·is generally recommended for the target SharePoint instance if possible, to help with performance and to help provide the product with greater leverage into SharePoint.

AND

·the account used for the connection. must be the logged in user and have the following permissions:

·Farm Administrator

·Site Collection Administrator

·DB_Owner on the Content Database (to allow the connecting user access to the local SharePoint Object Model).  

NOTE:  If StoragePoint is installed and running on the same SharePoint instance, the connecting account must also have access to the BlobStore, as well as both DataReader and DataWriter permissions to the Metalogix StoragePoint Database.

·Metalogix Content Matrix Console is not installed locally

AND

·Metalogix SharePoint Extensions Web Services (MEWS) is installed on the SharePoint server/WFE to which you are connecting

Remote Connection (Metalogix SharePoint Extensions Web Service)

The connecting account requires Full Control over the content being connected to and migrated. Additional permissions are provided through the use of the Metalogix Extensions Web Service.

·Metalogix Content Matrix Console is not installed locally

AND

·Metalogix SharePoint Extensions Web Services (MEWS) is not installed on the SharePoint server/WFE to which you are connecting

AND

·you are connecting to a SharePoint 2013 or later on prem or O365 target

Remote Connection (SharePoint Client Side Object Model 2013  or later)

·This connection type should be used when a Local Connection or the Metalogix Extensions Web Service connections cannot be made; for example, when the SharePoint deployment is hosted by a third party provider, this connection type would be used.

·The connecting account requires Full Control over the content being migrated.

When using this connection type, some Advanced Settings cannot be preserved,  including:

·Quick Edit

·Open document in browser

·Launch form in a dialog

·Allow items to be downloaded to offline clients

While these setting cannot be preserved as part of a migration if either the source or target is using a CSOM connection, they can still be manually set once the migration is complete.

4.For Authentication Type, select the method to use when trying to connect to the specified SharePoint instance.

Use the information in the following table for guidance.

Connection Types ON PREM

 

If …

Select ….

Notes

you want Metalogix Content Matrix to automatically check against the SharePoint environment

Auto Detect

Metalogix Content Matrix will check for non-Office 365 authentication types listed in the drop-down (in order), and use the first method that is found.

you want to connect to the SharePoint environment using the currently logged in Windows user’s credentials

Windows Authentication

·The logged in user credentials are used by default; however, other credentials that use this  authentication method can also be entered.

·This is the authentication type that most environments use.

·you selected Metalogix SharePoint Extensions Web Service as the Connection Type

AND

·you want to connect using Forms Based Authentication

Forms Based Authentication

·Most setups for Forms Based Authentication are supported.

·This method is limited to the Metalogix SharePoint Extensions Web Service connection type because it authenticates through IIS and not the Active Directory (AD).

you want to connect through a Web browser

Web Browser Authentication (Not Auto Detected)

This option is not searched for within the “Auto Detect” option, and needs to be manually set.

In order for the Metalogix Content Matrix Console to logon to the system, users must have logged on to the system being connected to through the web browser on that system first (only before the initial connection). Since this is all done using the Web browser for authentication, the credentials section of the window will be grayed out (since it is not needed), and it is limited to the MetalogixSharePoint Extension Web Services and SharePoint Client Side Object Model Connection Types because it authenticates through IIS and not the Active Directory (AD).

 

NOTES:  

·Select this Authentication Type if you are using Okta authentication.

·Because this connection method uses cookies from the browser, it may require multiple logins when running a single migration. However, this is only likely if the migration is running for a long session; this is mainly determined by the web browser settings for authentication. In the event that a login is required, a dialog box appears that lets users log in. After the user logs in, the migration will continue from where it left off.  

·If you are planning to run a job using a PowerShell script, make sure the PowerShell console is closed before you make the connection using this method.  Otherwise, an error will occur when you attempt to run the PowerShell job.

5.For Connect As, enter/select the login credentials you want to use to connect to the SharePoint site/server. Use the information in the following table for guidance.

NOTE:  This option is disabled if you selected Local Connection (SharePoint Object Model) or Web Browser Authentication (Not Auto Detected).

If you want to …

Then …

use the current Windows user's authentication credential

Select the (default)  <Domain>\<user> radio button.

use different authentication credentials

·Select the Different User radio button, and

·Enter the applicable user name and Password.

In cases where alternate credentials are entered, it is recommended that you select the Remember my password check box so Metalogix Content Matrix will automatically remember that user account password.  This is especially important if you chose Web Browser Authentication, as credentials must be stored in the Credential Manager vault before the connection is made.

6.If you need to configure proxy settings:

a)Select the Proxy Options tab.

b)Follow the procedure for Configuring Proxy Settings.

SharePoint Login Proxy Tab

7.If you want to Add or Remove certificates to be included when connecting to SharePoint:

a)Select the Included Certificates tab.

Please see the Connecting with Certificates for more details on connecting to SharePoint instances that require certificates.

b)After all of the desired connection options have been set, for all options tabs, click [OK] to establish the connection.

If you selected a connection type other than Site, the Limit Site Collections dialog displays, giving you the option to limit the site collections to include in your connection (which by importing an xml file with the list of URLs you want to include).  This is useful if the environment you are connecting to includes a very large number of site collections. In this case, limiting displayed site collections can improve performance.

Load xml ON PREM

NOTE:  If you want to View Sample xml, click the link on the dialog.  The xml file you import must follow the same format as this sample.

8.Either:

§Click [Yes – Import from XML] to specify the URLs of the sites you want to include in the connection, then browse/upload the file

OR

§Click [No – Continue with Connection] to add all sites within the selected scope to the connection.

If Metalogix Content Matrix successfully makes the connection, a new node will appear in the Explorer View, and you can expand this node and navigate through the SharePoint objects.

NOTE:  Should the log file ever show a "could not find site on remote SharePoint server" exception message when working with CSOM connections, simply restart the CSOM service on all machines running the Metalogix Content Matrix console and then rerun the action.

Connecting to SharePoint Online

Metalogix Content Matrix Console can make a tenant or site level connection to a SharePoint Online environment.   While a tenant connection is similar to the CSOM connection type, the process of creating the connection is slightly different, and also involves some prerequisite steps to set up permissions.

Requirements for Making a Tenant-level Connection

NOTE:  A tenant level connection works the same as a CSOM connection to an O365 environment, except that the tenant connection can also migrate Site Collections, MySites, and Managed Metadata.

·In order for users to make a SharePoint Online tenant-level connection, the connecting user must have the SharePoint Administrator permissions, as well as Site Collection Administrator permissions for each site collection being migrated.

Refer to the Office Support article Assigning admin roles in Office 365 for details.

If the connecting user does not have sufficient permissions, the connection will not be completed and the following connection error will display:

O365 Tenant Authentication Error

·The SharePoint Administration URL must be used in order for a tenant-level connection to be completed; that is:

"https://<CompanyTenantName>-admin.sharepoint.com"

If an incorrect URL, such as a specific site or Site Collection URL is used, then the connection will not be completed and the following connection error will display:

O365 Tenant Connection Error

To connect to SharePoint Online:

In the Metalogix Content Matrix ribbon, choose Connection > Connect to SharePoint.

Connect to SharePoint

To complete the Connection Options tab:

1.For Address, enter either the URL or IP address of the SharePoint site or tenant to which you want to connect.

Note that the drop-down menu displays a list of previous connections.

2.For Target Type, select the connection type.  Use the information in the following table for guidance.

If you want to connect…

Select …

Notes

directly to a SharePoint site

Site.

 

This option must be used for a site-level connection to an Office 365 tenant

NOTE:  If you want to connect to an Office 365 tenant root node, use the Office 365 Tenant connection type.

to the root of an O365 Tenant environment

(comparable to a farm-level connection in an on premises environment)

Office 365 Tenant.

·This connection type has most of the limitations of the CSOM connection adapter, but can run Site Collection migrations.

 

3.For Connection Type, select Remote Connection (SharePoint Client Side Object Model 2013).

NOTE:  If you accept the default (Auto Detect), this option will be detected automatically.

Connect to SharePoint Connection Type

4.For Authentication Type, select the method to use when trying to connect to the specified SharePoint instance. When connecting to Office 365, the two main Authentication Types will be Office 365 OAuth/Standard/ADFS Authentication and Office 365 Web Browser Authentication (Not Auto Detected).  Use the information in the following table for guidance.

Connect to SharePoint Authentication TYPE

For a  SharePoint Online connection that uses"modern" (not "legacy") authentication, you must select one of the O365 OAuth Authentication options or Office 365 Web Browser.  If the account is also part of a SharePoint Online Multi-Factor Authentication Policy, Office 365 Web Browser or O365 OAuth with MFA Authentication must be used.

For more information about legacy vs. modern authentication, refer to the Microsoft Support article How modern authentication works for Office 2013 and Office 2016 client apps.)

If …

Select ….

Notes

you want Metalogix Content Matrix to automatically check against the SharePoint environment

Auto Detect

Metalogix Content Matrix will check for authentication types listed in the drop-down (in order), and use the first method that is found.

NOTE:  At the time you click [OK] to complete the connection, a pop-up box will display that asks if you want to use Office 365 OAuth.  See Using Office 365 OAuth Authentication to Connect to SharePoint Online for details.

·you want to connect to Office 365 OAuth, Office 365 – Standard editions, or systems with ADFS

AND

·MFA is not being used

Office 365 OAuth/Standard/ADFS Authentication*

By default the logged in user credentials will be unavailable, since this uses the Windows authentication method, and the Office 365 credentials will need to be entered.

NOTE:  At the time you click [OK] to complete the connection, a pop-up box will display that asks if you want to use Office 365 OAuth.  See Using Office 365 OAuth Authentication to Connect to SharePoint Online for details.

your account requires the use of Multi-Factor Authentication (MFA)

Office 365 OAuth with MFA Authentication (Not Auto Detected)*

With this authentication type,  you do not have to enter account credentials in Content Matrix, and the Connect As options will be disabled.

NOTE: There are some migration limitations with this connection type.  See Migration Limitations When Using Office 365 OAuth with MFA Authentication for details.

you want to connect through a Web browser

Web Browser Authentication (Not Auto Detected)

This option is not searched for within the “Auto Detect” option, and needs to be manually set.

In order for the Metalogix Content Matrix Console to logon to the system, users must have logged on to the system being connected to through the web browser on that system first (only before the initial connection). Since this is all done using the Web browser for authentication, the credentials section of the window will be grayed out (since it is not needed), and it is limited to the Metalogix Extensions Web Service Connection Type because it authenticates through IIS and not the Active Directory (AD).

 

NOTES:  

·Because this connection method uses cookies from the browser, it may require multiple logins when running a single migration. However, this is only likely if the migration is running for a long session; this is mainly determined by the web browser settings for authentication. In the event that a login is required, a dialog box appears that lets users log in. After the user logs in, the migration will continue from where it left off.  

·If you are planning to run a job using a PowerShell script, make sure the PowerShell console is closed before you make the connection using this method.  Otherwise, an error will occur when you attempt to run the PowerShell job.

you want to connect through a Web browser using authentication for Office 365

Office 365 Web Browser Authentication

This option works the same as Web Browser Authentication (Not Auto Detected) except:

·it looks for more specific Office 365 cookies

·it requires that users first log into Office 365 through the browser

·instead of allowing multiple logins, only one "request" for data can be made at a time, which ensures that no data is missed or lost due to the system locking from too many requests (but which may result in a slower connection).

* If you are connecting to SharePoint Online using OAuth authentication and you used a custom domain as the Address, you will also need to check the Override SharePoint Online Tenant Domain Name and enter the default tenant domain name (which can be found at https://admin.microsoft.com/Adminportal#/Domains) to allow Content Matrix to route the request to the proper region.

Custom Domain for OAuth

5.For Connect As, enter/select the login credentials you want to use to connect to the SharePoint site/server. Use the information in the following table for guidance.

NOTE:  This option is disabled if you selected Office 365 OAuth with MFA Authentication, or Web Browser Authentication (Not Auto Detected).

If you want to …

Then …

use the current Windows user's authentication credential

Select the (default)  <Domain>\<user> radio button.

use different authentication credentials

·Select the Different User radio button, and

·Enter the applicable user name and Password.

In cases where alternate credentials are entered, it is recommended that you select the Remember my password check box so Metalogix Content Matrix will automatically remember that user account password.  This is especially important if you chose Web Browser Authentication, as credentials must be stored in the Credential Manager vault before the connection is made.

 

6.If you want to Add or Remove certificates to be included when connecting to SharePoint:

a)Select the Included Certificates tab.

Please see the Connecting with Certificates for more details on connecting to SharePoint instances that require certificates.

b)After all of the desired connection options have been set, for all options tabs, click [OK] to establish the connection.

If you are making a tenant-level connection, the Limit Site Collections dialog displays, giving you the option to limit the site collections to include in your connection (which by importing an xml file with the list of URLs you want to include).  This is useful if the environment you are connecting to includes a very large number of site collections. In this case, limiting displayed site collections can improve performance.  Additionally, the Include Office 365 tenant my site host connection allows  MySites to display under their own top-level connection node (alongside the main tenant node) with the following URL format: http://[Tenant URL]-my.sharepoint.com. It is selected by default, but if you want to exclude them from the connection, uncheck this box.

CONTEN~1_img26

NOTE:  If you want to View Sample xml, click the link on the dialog.  The xml file you import must follow the same format as this sample.

7.Either:

§Click [Yes – Import from XML] to specify the URLs of the sites you want to include in the connection, then browse/upload the file

OR

§Click [No – Continue with Connection] to add all sites within the selected scope to the connection.

If Metalogix Content Matrix successfully makes the connection, a new node will appear in the Explorer View, and you can expand this node and navigate through the SharePoint objects.

NOTE:  Should the log file ever show a "could not find site on remote SharePoint server" exception message when working with CSOM connections, simply restart the CSOM service on all machines running the Metalogix Content Matrix console and then rerun the action.

Using Office 365 OAuth Authentication to Connect to SharePoint Online

Office 365 OAuth Authentication is a token-based authentication method that can be used as an alternative to Standard/ADFS Authentication to reduce throttling.

If Multi-Factor Authentication is set up for the tenant and enabled for the account (as described in the Microsoft TechNet article SharePoint Online - O365: Set up Multi-Factor Authentication), you can connect using Office 365 OAuth with MFA Authentication as an alternative to Office 365 Web Browser authentication.  

NOTE:  If you are using the Office 365 OAuth with MFA Authentication type, be aware that some migration limitations apply.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating