Chat now with support
Chat with Support

Metalogix Content Matrix 9.2 - SharePoint Edition User Guide

Introduction Entering the License Key Metalogix Content Matrix Console End User Interface Enabling Advanced Mode Connecting to SharePoint Migrating to SharePoint Online Using the Import Pipeline Preparing for a Migration How Content Matrix Handles Various SharePoint Components
How Team Sites are Migrated to SharePoint Online and SharePoint 2019 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 Records Centers are Migrated to SharePoint Online Using the Import Pipeline How Document Sets are Migrated How Navigation is Migrated How MySites are Migrated How Managed Metadata, Terms, and Term Stores are 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 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 Incremental Migration 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 Migration Frequently Asked Questions About Us

Connection Type Functional Comparison

SharePoint Database Connection

The SharePoint Database connection is a read-only connection that accesses the  SharePoint data by reading the content databases directly from the SQL server used by an on-premises SharePoint farm.

Required Permissions

DBReader and SPDataAccess rights on Content Database.

When to Use

·When connecting to the source farm

·When there is a need to optimize migration performance

·When there is a requirement to use the Search function in SharePoint 2013

Optimal Use Cases

·Migrating Managed Metadata using GUID mapping

·Migrating SharePoint 2010 lists and libraries containing Managed Metadata using the Import Pipeline, provided all affected Metadata is migrated to the target and the source and target GUIDs of all affected Metadata is mapped

·Migrating workflows

·Migrating alerts to a SharePoint on-premises target

Unsupported Operations

·Creating and deleting SharePoint objects (because it is a read-only connection)

·Migrating MySites (because they will be migrated as site collections and will not include some of the User Profile data)

·Migrating InfoPath forms

·Mapping site templates (because it can only detect site templates for any site that exists under the selected source node)

Local Object Model (OM) Connection

The local Object Model connection accesses the SharePoint OM API locally on the machine, which allows it to preserve more existing metadata and grant deeper access for some Content Matrix features.

Required Permissions

Site collection administrator and db_owner on SharePoint Admin, Config and content databases.

When to Use

·When the Content Matrix Console is installed on a WFE server of an on-premises SharePoint farm.

·On the target farm, to help with performance.

Optimal Use Cases

·Updating site collection settings

·Migrating Web part connections

·Migrating Managed Metadata

·Migrating InfoPath forms

·Migrating List Template Gallery

·On the source farm:

§migrating alerts to SharePoint on-premises

§migrating Audiences

§migrating Records Centers to SharePoint Online using the Import Pipeline

§preserving workflow associations

·On the target farm:

§migrating Site collections, including site collection administrators

§migrating MySites

§migrating Master Page Gallery

§preserving Site themes

§preserving SharePoint List and List Item IDs

§preserving Authorship metadata

§setting site quotas

§transforming list and site columns into a Managed Metadata column

Remote Object Model Connection Using Metalogix Extensions Web Service

The Remote Object Model connection allows Content Matrix to have a remote connection to the SharePoint OM API through a SharePoint solution, which grants all of the same access for features and metadata that is available from the Local OM connection.

Required Permissions

Site collection administrator

When to Use

When the Metalogix Extensions Web Service (MEWS) is installed on the SharePoint farm

Optimal Use Cases

·Migrating Web parts

·Migrating Managed Metadata

·Migrating InfoPath forms

·Migrating List Template Gallery

·Updating site collection and navigation settings

·On the source farm:

§migrating alerts to SharePoint on-premises

§migrating Audiences

§migrating Records Centers to SharePoint Online using the Import Pipeline

§migrating Workflows

·On the target farm:

·migrating Site collections, including site collection administrators

·migrating MySites

§migrating Master Page Gallery

§preserving Site themes

§preserving SharePoint List and List Item IDs

§preserving Authorship metadata

§migrating site quotas

§transforming list and site columns into a Managed Metadata column

Client Side Object Model (CSOM)

The Client Side Object Model connects through the SharePoint CSOM.  It can be used to connect to SharePoint on-premises, but does not have the same level of fidelity that the Object Model connections have.  It is the only method for making site-level connections to SharePoint Online.  

Required Permissions

Site collection administrator

When to Use

·For SharePoint on-premises, when Local OM connection cannot be made or MEWS cannot be installed on the environment.

·For SharePoint Online, when making a site-level connection.

Optimal Use Cases

·Migrating Managed Metadata (for a connection to SharePoint Online)

·Migrating libraries that contain .aspx files, even if migration using the Import Pipeline is enabled

·On the target:

§migrating OOB and SPD workflows

§preserving major, minor, and draft versions of a document

§preserving Web Part views

§transforming list and site columns into Managed Metadata columns

Unsupported Operations

·Migrating to a farm that uses Storage Point

·Migrating site collections with host headers

·Preserving list/library settings such as Quick Edit, Open document in browser, Launch form in a dialog and Allow items to be downloaded to offline clients

·On the target:

§migrating Nintex workflows

§migrating Access request settings

§preserving workflow instances

Office 365 Tenant Connection

The Office 365 Tenant connection works the same as a CSOM connection to an Office 365 environment, but since it connects at the tenant level it can also migrate site collections, MySites, and Managed Metadata.

Required Permissions

Global Administrator and Site Collection Administrator in the Office 365 tenant environment

Optimal Use Cases

·Migrating Site collections, including site collection administrators

·Migrating Managed Metadata

·Migrating Web parts

·Transforming list and site columns into a Managed Metadata column

·On the target:

·migrating MySites

§migrating SPD workflow associations for lists and content types

§preserving SharePoint list item IDs

Unsupported Operations

On the target:

·migrating Nintex workflows

·migrating workflow instances

·preserving Web Part Views

·preserving major, minor, and draft versions of documents.

Connecting to a SharePoint Database

This connection type is read only and can also can be used as a source connection for SharePoint 2007, 2010, 2013 and 2016.   In case of performance concerns, this connection type can also help, as the source data would be read directly from the database, and does not have to go through the source SharePoint APIs.

See Connection Type Functional Comparison for required permissions as well as optimal use cases and unsupported migration actions.

NOTE: Connecting to a SharePoint 2013 or 2016 database is supported either:

·from a server where the corresponding version of SharePoint is installed

OR

·from a non-SharePoint 64-bit machine that has had the compatible version of the SharePoint Database Adapter configured via the Content Matrix Console installer. If you are using Distributed Migration, you will also need to update the database adapter version on the agents.)

IMPORTANT:  If you have installed Content Matrix on a client machine and have an existing SharePoint 2016 database connection, you will need to reconnect and accept the terms of the Microsoft third-party license agreement. Also remember that if you are running Content Matrix on a client machine, you cannot have both SharePoint 2013 and 2016 database adapters installed at the same time.  If you need to switch from one version of the database adapter to the other, you will need to first uninstall and then re-install the SharePoint Edition using Modify operation.

SP 2016 DB Connection License Agreeement Message

To connect to a SharePoint database:

1.From the ribbon toolbar, choose Connections > Connect to SharePoint Database to display the Connect to SharePoint SQL Server dialog.

Connect to SP Database

2.For SQL Server, enter or browse to the SQL Server that hosts the SharePoint database you want to connect to.

NOTE:  You can enter the server's name or IP address.

3.For SQL Database, either:

§enter the name of the SharePoint database (the fastest way to make the connection)

OR

§browse to the SharePoint database.

SQL Database List

NOTES:  

§Remote connections must be enabled in order for Metalogix Content Matrix to connect to any remote database.  

§The Database Browser lists all databases in SQL server, not just SharePoint databases.  This allows for faster retrieval of the database list, especially in large environments.  

§You will receive an error of you try to connect to anything but a SharePoint database.

4.For Authentication User Current Windows user, either:

§ Accept the default (Use Current Windows user)

OR

§Select Use SQL Server login and enter the credentials used to authenticate with the selected SQL Server.

5.Click [Connect].

The Connect to SharePoint SQL Server dialog displays.

6.Select either the database (for a connection to all sites within the database) or a single site.

Connect to SharePoint SQL Server

7.Click [OK].

The Set Host Name dialog displays.

SetHostName

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

If …

Then …

·you are planning to use Link Correction as part of the migration

Enter the Host Name in the format "http://<ServerName>:<PortNumber>"

For example, if connecting to a SharePoint DB for a system that has the web URL of http://2010foundation:1818, you would want to use that as the Host Name, even though the database name will be different.

CONTEN~1_img31

When connecting to a Database, the URLs for links that point internally to the SharePoint server have a different format, which would prevent link correction. The host name is used to replace the different formatting from the DB connection, enabling links will be viewed in the proper format.

you are not planning to use Link Correction as part of the migration

Click [Skip].

NOTE: It is possible to go back and set the Host name after a database connection has been made. To do this, select the DB connection, right-click, and choose Properties. In the Properties dialog click the [...] button at the end of the Host column, and this will open the Set Host Name dialog, allowing this value to be edited.

The selected node will now appear in the Explorer view.

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 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 initiate a connection to a SharePoint site or server:

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.

NOTE:  If you want to connect an Office 365 tenant root node, see Specifying the URL to Connect to an O365 Tenant.

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 a specific Web application on a SharePoint server

Web App.

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.

This option can only be used if using the Local or Metalogix Extensions Web Service 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.

NOTE:  See also Additional Requirements for O365 Tenant Connections.

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. 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 the next three authentication types listed in the drop-down (in order), and use the first method that is found.

NOTE:  If you are connecting to an SPO site or tenant, 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 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).i

·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:  If you are connecting to an SPO site or tenant, 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

NOTE:  This option is disabled for all other authentication types.

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), 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 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.

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.

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.

NOTE:  If you are connecting to an O365 tenant, an additional option, Include Office 365 tenant my site host connection, displays. The MySites appear 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.

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.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating