There are six basic connection adapters that can be used to make connections to SharePoint from Metalogix Content Matrix Console:
·A local connection to a SharePoint site or server *
·A remote connection to a SharePoint site or server
·A connection through the SharePoint Client-Side Object Model (CSOM) for SharePoint 2013 or later, and for SharePoint Online at the site level
·An Office 365 Tenant connection (based on the CSOM connection type) `
·A read-only connection to a SharePoint Database (DB)
* As of version 9.3 the Metalogix Content Matrix Console client application requires Microsoft .NET Framework 4.7.2 to run. Since this .NET requirement applies to the machine on which Metalogix Content Matrix is installed, Metalogix Content Matrix cannot make a local Object Model (OM) connection on a SharePoint 2007 or 2010 environment, because SharePoint 2007 and 2010 require an earlier version of the .NET Framework (v.3.5), which prohibits Metalogix Content Matrix from completing the connection. Because of this, any migration jobs configured to connect to SharePoint 2007 and 2010 environments using a Local OM connection type will cease to work, and these jobs will need to be recreated for use over a different adapter type such as MEWS or DB.
The following table describes the connection adapter types that can be made for each supported version of SharePoint:
SharePoint Server Type |
Local Object Model (OM) Connection (Metalogix Content Matrix Console - installed on server) |
Remote Object Model (OM) Connection (Metalogix Extensions Web Service installed on remote server) |
SharePoint Client Side Object Model (CSOM) Connection |
SharePoint Database (DB) Connection (Read Only) |
SharePoint Office 365 Tenant Connection |
---|---|---|---|---|---|
Windows SharePoint Services (WSS) 3.0 |
- |
|
- |
|
- |
Microsoft Office SharePoint Server (MOSS) 2007 |
- |
|
- |
|
- |
Microsoft SharePoint 2010 (Foundation and Server) |
- |
|
- |
|
- |
Microsoft Office 365 |
- |
- |
|
- |
|
Microsoft SharePoint 2013 (Foundation and Server) |
|
|
|
** |
- |
Microsoft SharePoint 2016 |
|
|
|
** |
- |
Microsoft SharePoint 2019 |
|
|
|
- |
- |
** If Content Matrix Console is installed on a server where SharePoint is also installed, the appropriate version of the adapter will be configured automatically. If SharePoint is not installed on the same machine as the Content Matrix Console, the installer will prompt for the configuration of either a SharePoint 2013 or SharePoint 2016 database adapter, as both cannot exist on the same non-SharePoint machine 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. If you are using Distributed Migration, you will also need to update the database adapter version on the agents
For each of the direct connections to SharePoint (local OM, remote OM, CSOM, and Tenant) there is a full connection and a read-only connection (with the exception of DB connections, which are read-only by default). The Write and Read-Only connection states are available under the Add Connection menu, and are differentiated in the Explorer View tab by different icons (the read-only icon has a lock over the system connection).
Adding a connection to Office 365 is essentially the same as connecting to any other SharePoint site or server, with a few minor differences. Users can make a site level connection to an O365 environment using the CSOM connection adapter, and they can also make a Site Collection level connection using the Tenant connection adapter.
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 |
·For SharePoint 2013 and 2016: The combination of Reader and Execute on the Content Database is the minimum set of required permissions, but the combination of db_dataReader and SPDataAccess can also be used. ·For SharePoint 2007 and 2010: Only Reader or DBReader on the Content Database is required. |
Okta authenticaton support |
N/A |
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 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 on premises 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 and db_owner on SharePoint Admin, Config and content databases. NOTE: The connecting account must be the currently logged-in user. |
Okta authenticaton support |
N/A |
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 List Template Gallery ·On the source farm: §migrating alerts to SharePoint on premises §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 Master Page Gallery §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 on premises 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 |
Okta authenticaton support |
Supported* with the following limitations: ·Content Matrix SharePoint Edition only ·Must be used with Web Browser Authentication (which is not auto-detected) ·Not supported for a connection that uses a proxy and/or certificate EXCEPTION: Okta supports the use of certificates for SharePoint 2010 only. Refer to the article For SharePoint 2010 only: Import security certificate to Trusted Root Certificate Authority on the Okta website for details. ·Because Okta requires web browser authentication, use with Distributed Migration and PowerShell are not supported.
* Only connections to SharePoint 2016 have been tested by Quest. |
Optimal Use Cases |
·Migrating List Template Gallery ·Updating site collection and navigation settings ·On the source farm: §migrating alerts to SharePoint on premises §migrating Records Centers to SharePoint Online using the Import Pipeline ·On the target farm: ·migrating Site collections, including site collection administrators §migrating Master Page Gallery §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. |
Okta authenticaton support |
Supported for connections to SharePoint on premises*, with the following limitations: ·Supported for Content Matrix SharePoint Edition only ·Must be used with Web Browser Authentication (which is not auto-detected) ·Not supported for a connection that uses a proxy and/or certificate ·Because Okta requires web browser authentication, use with Distributed Migration and PowerShell are not supported.
* Only connections to SharePoint 2016 have been tested by Quest. |
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 §migrating OOB and SPD workflows §preserving major, minor, and draft versions of a document ·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 be the migration target for site collections, MySites, and Managed Metadata.
Required Permissions |
SharePoint Administrator (and Site Collection Administrator for each target site collection in the Office 365 tenant environment) |
Okta authenticaton support |
N/A |
Optimal Use Cases |
·Migrating Site collections, including site collection administrators ·Migrating Managed Metadata (This also requires the Term Store Administrator role) ·Transforming list and site columns into a Managed Metadata column ·Migrating SPD workflow associations for lists and content types |
Unsupported Operations |
On the target: ·migrating Nintex workflows ·migrating workflow instances ·preserving Web Part Views ·preserving major, minor, and draft versions of documents. |
You can connect to SharePoint on premises by:
·making a read-only connection to a SharePoint database
OR
·by connecting to a SharePoint site or server at the farm, Web application, or site level.
This connection type is read only and can be used as a source connection for SharePoint 2007, 2010, 2013 and 2016 content databases. 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.
SharePoint Version Connection Requirements
·When connecting from a server, the database must have the same version of SharePoint as the content being migrated.
·A client connection to a SharePoint 2013 or 2016 database is supported from a non-SharePoint 64-bit machine that has had the compatible version of the SharePoint Database Adapter configured. 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 may 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, uninstall and then re-install SharePoint Edition.
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.
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.
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.If you want to use an encrypted connection to the database, check the Encrypt Connection box.
NOTE: If the certificate used for encryption is not trusted, you will also need to check the Trust Server Certificate box.
5.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.
6.Click [Connect].
The Connect to SharePoint SQL Server dialog displays.
7.Select either the database (for a connection to all sites within the database) or a single site.
8.Click [OK].
The Set Host Name dialog displays.
9.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. 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 Explorer View.
Troubleshooting Client-Side SharePoint Database Connections
If you encounter any issues when trying to deploy or connect to a SharePoint database from a client machine, refer to the Quest Support Knowledge Base article https://support.quest.com/metalogix-content-matrix/kb/317316.
© 2021 Quest Software Inc. ALL RIGHTS RESERVED. Feedback Terms of Use Privacy