Chat now with support
Chat with Support

Metalogix Content Matrix 8.8 - eRoom Edition User Guide

Introduction Entering the License Key Content Matrix Console End User Interface Connecting to eRoom Connecting to SharePoint Preparing for Your Migration Initiating a Migration Configuring Copying Options Saving or Running a Migration Action Mapping Links and Running Link Correction Incremental Migration Log Files Using PowerShell with Content Matrix
Configuring PowerShell for Use with Content Matrix
Registering the Metalogix Command DLL Files Adding the PowerShell Snap-Ins for the Application Framework Content Matrix PowerShell Commandlet List
Metalogix.System.Commands Metalogix.SharePoint.Commands Metalogix.Jobs.Reporting.Commands Metalogix.ERoom.Commands
Using Powershell for Nested Content Reports and Pre-Migration Check
Modifying Content Matrix Configuration and Settings Frequently Asked Questions About Us

Enabling eRoom XML

Metalogix Content Matrix communicates with eRoom through the eRoom XML API which is remotely accessible.  This enables Metalogix Content Matrix to be a true client of eRoom by using this communication layer,  with no eRoom server side install required.

The eRoom XML API can be toggled on or off via eRoom settings. In the unlikely event that eRoom XML API is turned off, it will have to be re-enabled for Metalogix Content Matrix to be able to access the eRoom environment.

To enable eRoom XML:

1.Log in to eRoom via the web interface as an eRoom Site Administrator.

2.On the My eRooms page, go to the Administration section and follow the Site Settings link.

3.On the General Site Settings page, under the Options section, ensure that the Allow XML queries and commands from external applications option is turned on.

IMPORTANT: In some versions of eRoom, the Allow XML option is available, but not exposed via the settings web interface. If this is the case in your environment, please contact Metalogix directly for information about how to turn this option on.

Connecting or Reconnecting to eRoom Using Web Browser Authentication

If the connection to eRoom fails due to authentication issues - for example, if incorrect credentials are entered, or if the appropriate certificates are not provided when connecting to a secured eRoom server - the following dialog displays

eRoom Logon Fail

Click [Yes] to launch web browser authentication. Enter your credentials and click [OK][OK]

Invoking the Web Browser Authentication from the right-click menu

In order to reconnect to eRoom using web browser authentication - for example, if a certificate was revoked, or if the current session's authentication cookie expired - right-click the disconnected eRoom server node and choose Reconnect using Web Browser to launch web browser authentication. The Login Browser appears, along with a Windows Security dialog. Enter your credentials and click [OK].

Connecting to SharePoint

 

There are four 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 Native Web Service (NWS)

·A connection through the SharePoint Client-Side Object Model (CSOM) for SharePoint 2013 or 2016, and for SharePoint Online at the site level

* To be compliant with Transport Layer Security (TLS) v1.2, as of version 8.6 the Metalogix Content Matrix Console client application requires Microsoft .NET Framework 4.6 or later to run. Since this .NET requirement is on the machine that Metalogix Content Matrix is installed on, Metalogix Content Matrix cannot make a local Object Model (OM) connection on a SharePoint 2007 or 2010 environment, because SharePoint 2007 and 2010 require a lower version of the .NET Framework (v.3.5), which prohibits Metalogix Content Matrix from completing the connection.  Because of this change, any migration ‘jobs’ that are configured to connect to SharePoint 2007 and 2010 environments using a Local OM connection type will cease to work because of the .NET Framework criteria described above, 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 (Extensions Web Service installed on remote server)

SharePoint Native Web Service (NWS) Connection

SharePoint Client Side Object Model (CSOM) Connection

Windows SharePoint Services (WSS) 3.0

-

Green Checkmark

Green Checkmark

-

Microsoft Office SharePoint Server (MOSS) 2007

-

Green Checkmark

Green Checkmark

-

Microsoft SharePoint Foundation 2010

-

Green Checkmark

Green Checkmark

-

Microsoft SharePoint 2010

-

Green Checkmark

Green Checkmark

-

Microsoft Office 365

-

Green Checkmark

(Only for Office 365-D installations that have had the Extensions Web Service installed)

 

 

-

Green Checkmark

 

Microsoft SharePoint 2013

Green Checkmark

Green Checkmark

-

Green Checkmark

Microsoft SharePoint 2016

Green Checkmark

Green Checkmark

-

Green Checkmark

 

Adding a connection to Office 365 is essentially the same as connecting to any other SharePoint site or server, with a few minor differences. There are two "types" of Office 365 servers, and Metalogix Content Matrix Console can connect to both types: Standard and Dedicated. Users can make a site level connection to an O365 environment using the CSOM connection adapter.

The Metalogix Extensions Web Service has gone through testing and has been certified by Microsoft to be installed on Microsoft Online Services - Dedicated versions (Office 365 2010 and 2013) by request.  If connecting to a Dedicated server and the Extensions Web Service has been installed, then users can connect as a site or server using the Remote (Metalogix SharePoint Extensions Web Service) connection.

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

REMINDER:  If users are attempting to connect to a remote SharePoint server, then the Metalogix SharePoint Extensions Web Service is required on the remote SharePoint server.

To connect to a SharePoint site or server:

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

Connect to SharePoint No O365

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 …

Notes

directly to a SharePoint site

Site.

 

This option

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

AND

·is the only connection that is available for the NWS connection type.

to a specific Web application on a SharePoint server

Web App

·This option can only be used if using the Local or Extensions Web Service connection type

·The Extensions Web Service must be installed in order for "Dedicated" versions of Office 365 to use this 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 Extensions Web Service connection type.

·The Extensions Web Service must be installed in order for "Dedicated" versions of Office 365 to use this connection type.

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

CONTEN~1_img23

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 will be used

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

·If the connection is remote (installed on another machine) and the Metalogix SharePoint Extensions Web Service is not installed, the Remote Connection (Native SharePoint 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 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 (OM)).

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 Extension 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 Extensions Web Service.

This connection type cannot be used for SharePoint 2003 installations, since they do not use SharePoint solution files.

·Metalogix Content Matrix Console is not installed locally

AND

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

AND

·you are not connecting to a SharePoint 2013 or 2016 target

Remote Connection (Native SharePoint Web Service)

This connection type:

·should be used when a Local Connection or the 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.

·is one of the main connection types when connecting to SharePoint 2003 instances.

NOTE:  This connection type will fail if trying to connect to a SharePoint 2013 or 2016 target, including Office 365 tenants.

·Metalogix Content Matrix Console is not installed locally

AND

·Metalogix SharePoint Extension 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 2016 On Prem or O365 target

Remote Connection (SharePoint Client Side Object Model 2013/2016)

·This connection type should be used when a Local Connection or the 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 Standard/ADFS Authentication and Office 365 Web Browser Authentication (Not Auto Detected).  Use the information in the following table for guidance.

CONTEN~1_img24

· For a  SharePoint Online connection, you must select one of the Web Browser Authentication options if the Connect As account:

§uses "modern" (not "legacy") authentication methods.  (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.)

AND/OR

§is part of a SharePoint Online Multi-Factor Authentication Policy.

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.

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 Extensions Web Service or NWS 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 Extensions Web Service and NWS connection types because it authenticates through IIS and not the Active Directory (AD).

you want to connect to Office 365 – Standard editions or systems with ADFS authentication.

Office 365 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.

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 Extensions Web Service and NWS Connection Types 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

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

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.

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