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

Changing Resource Utilization Settings

Metalogix Content Matrix can manage its performance level through the Resource Utilization Setting. This type of management is also known as throttling, and is used for any migration action that is run with Metalogix Content Matrix.

To edit Resource Utilization Settings:

From the Contrent Matrix Console ribbon, choose Settings > Edit Resource Utilization Settings.

Resource Utilizatin Settings

By default, the Efficiency value is set in the center or the slide bar. This is the recommended setting for best performance and resource utilization (use of RAM, CPU, Network and SharePoint load) during a migration.

If the slide bar is further to the left, the migration will run more slowly, but will have less chances of overloading the available resources and causing potential errors. If the slide bar is further to the right, it with use more system resources, and can speed the migration up, but could cause some potential errors if the system resources cannot handle the data being migrated. There is a chance that if the speed is too high, you would actually see a slowdown in the overall migration, because the migration is trying to run actions faster than the resources properly allow.

The actual values that are provided in the slide bar are determined by the systems resources (the system that has the Metalogix Content Matrix installed on it). A system with high resources will be able to run faster migrations, even if using the default setting, because over all available resources will be higher. This also means that the Efficiency and Speed values will have a larger spread between them. A system that has low resources will run more slowly, simply because it doesn't have the resources to run at faster levels. Again, this also affects the default values for Efficiency and Speed, since these numbers will be lower, and have a smaller spread between them.

NOTE: If the Efficiency is set to its maximum (all the way to the left), the migration will run more slowly, but the "slowest" speed will be the same between systems with high and low resources. The "slowest" value between systems will always be the same, however, the *"highest" value will be different based on the systems resources.

While this value can be set through the Contrent Matrix Console, you can also set it through the back end, if the UI setting does not seem to be working for you. Please contact Quest Support for more information on this back end setting.

Configuring Content Matrix for Distributed Migration

You can use Distributed Migration to significantly improve the time it takes to complete large migration jobs by distributing the workload efficiently across the resource pool. The distributed model enables parallel processing of migration jobs that reduces migration time, and enables higher utilization, better workload throughput and higher productivity from deployed resources.

The feature consist of a central Distributed Database and one or more Distributed Migration agents.

Distributed Migration New Model

Distributed Migration Components

Distributed Migration relys on the following components:

Distributed Database

This is a SQL Server database that contains the repository or queue of migration job definitions which the agents can execute. Distributed Migration agents share the same Distributed Database.

NOTE:  The Distributed Database cannot be a SQL CE database.


Agents are physical or virtual machines on which you can run migrations remotely.  Installed on each agent are the Content Matrix Console and the Metalogix Agent Service, which handles job queuing and processing.  Any available agent can pull a migration job that has been set to Run Remotely directly from the Distributed Database.

Any logging information is then be sent to the Distributed Database.

When an agent is executing a migration job, any interaction with the agent, such as changing a configuration setting, is not recommended.

If Distributed Migration was configured prior to version 9.2:

To provide more efficient resource utilization, the Distributed Migration model has been re-architected to eliminate the use of a Controller to push jobs to agents. Instead, Distributed Migration uses a Windows Service that allows any available agent to pull a migration job that has been set to Run Remotely directly from the Distributed Database.

If you configured Distributed Migration prior to version 9.2, you will need to reconfigure each agent in order to continue using Distributed Migration and to run any migration jobs remotely.

Refer to the Reconfiguring Distributed Migration After an Upgrade guide for more information.


NOTE:  You will notice after an upgrade that the Configure Distributed Migration and Configure Self-Service options no longer display in the Content Matrix Console ribbon (Self-Service Migration has been removed as of version 9.2) and the Manage Agents dialog is empty.  

Important Notes About Global Mappings

Currently, Distributed Migration does not support the following Global Mappings:

·Domain Mappings

·Url Mappings

·Guid Mappings

In the case of User Mappings, whenever a machine connects the Distributed Database, a pop-up displays with the option to copy local settings (which include User Mappings) from the local machine to the database.

Distributed Migration User Mappngs prompt

User Mappings and settings can be copied from any machine that connects to the Distributed Database, even if it is not configured as an agent.

Distributed Migration System Requirements

Requirements for the Distributed Database

·The Distributed Database must use a Microsoft-supported SQL server.

·The Distributed Database can reside on any machine in network, provided that all agents have access to that machine.

·The Distributed Database should be created from the Metalogix Content Matrix Console.

NOTE: It is recommended that SQL Server Authentication be used to connect to the Distributed Database, as it will allow for cross-domain connections.

Requirements for an Agent Machine

·An agent machine or workstation should have 16 GB of free RAM.

NOTE:  An agent machine can be a physical or virtual machine.

·Microsoft .NET Framework 4.6.2 must be installed on the machine.

·The agent machine must meet all the prerequisites as specified in the Metalogix Content Matrix Console Advanced Installation Guide.

·The machine must allow remote connections to itself.

·All instances of Windows PowerShell must be closed.

·The following services must be started:

§Remote Registry

§Server Service


Connection icon

· If a migration job is using SP 2013 or 2016 DB as a source connection, then users can only run jobs remotely on an agent that meets the connection requirements for the same DB version as the machine from which the migration is configured. This means that the agent machines must either:

§Have the same version of SharePoint installed on or be a SharePoint WFE for a comptible version.


§Be a 64-bit machine that has no version of SharePoint installed on it.

·Local Object Model (OM) connections to SharePoint are not supported when using Remote Agents. - A Local OM connection to SharePoint can only be made when Metalogix Content Matrix is installed on a machine that is running SharePoint (a SharePoint server or WFE). Since this type of connection can be made on the Host machine, but cannot be guaranteed to also be available on an agent machine, it is not a supported connection adapter for running migrations using remote Agents.  For making remote Object Model connections, make sure the Metalogix Extension Web Service (MEWS) is installed on each agent machine.  

Configuring Agents for Distributed Migration

Configuring an Agent for Distributed Migration consists of the following high-level tasks:

I.Install the latest version of Content Matrix then:

·create and/or connect to the Distributed Database and

·on the first agent only, create and/or connect to the Metalogix Metabase (which is used to store metadata during migration).

II.Copy the Agent Service installation files to the agent machine and install from a Command Prompt.

III.For the first agent, generate a unique security certificate for the Metalogix Agent Service.

NOTE:  Once created on the first agent, the name of the certificate is stored in the Distributed Database and then it can be copied to other agents.  (The same certificate needs to be used across all agents.)

IV.Install the Metalogix Agent Service, which

·installs the Agent Service as a Windows service

·installs the certificate to “My User Account” storage

·saves the certificate name to the Distributed Database

V.Start the Metalogix Agent Service.

Permission Requirements

The account used to configure agents for Distributed Migration must:

·be an Administrator


·have permissions to Log on as a Service (via Administrative Tools > Local Security Policy > User Rights Assignment).

To install the latest version of Content Matrix then connect to the Distributed Database:

1.Log into the machine using an account that meets Permissions Requirements.

2.Download or copy the latest version of the Content Matrix installation kit to the machine.

3.Install the Content Matrix Console and the Metalogix Extension Web Service (MEWs). (See the Metalogix Advanced Installation Guide for details.)

4.Open the Console and create/connect to the Distributed Database as follows:

a)From the Jobs List, choose File > Connect to Distributed Database.

Distributed Database CONNECT

b)Enter or browse to the SQL Server and SQL Database you want to use.  If the database does not already exist, create it.

NOTE: Remember to use the same Distributed Database for all agents in the "cluster."

Browse to Database

Whenever a machine connects to the Distributed Database, a pop-up will display with the option of copying User Mappings and other local machine settings to the database.

CAUTION:  If you are configuring multiple agents, remember that if you click [Yes], any User Mappings and settings that already exist in the Distributed Database will be overwritten.

Distributed Migration User Mappngs prompt

5.On the first agent only, close then reopen the Content Matrix Console.  Create/connect to the Metabase (which is used to store metadata during migration) as follows:

a)Navigate to Settings > Configure Default Metabase Settings.

Change Metabase Settings DISTRIBUTED MIGRATION

b)Select Use SQL Server database. Enter or browse to the SQL Server database you want to use, or create the database if it does not already exist


·Distributed Migration requires the use of a full-featured SQL Server database.  If you have an existing Metalogix Metabase that uses SQL Server Compact Edition, you will need to create a new one for use with Distributed Migration.

·This step only needs to be performed on the first agent, because all agents use a common database.

6.Close the Content Matrix Console.

To copy the Agent Service installation files to the agent machine:

1.Copy the ContentMatrixAgentService_[version].zip file from the Content Matrix download folder and extract the files (the recommended location is C:\Program Files (x86)\Metalogix\Agent Service).

2.Open a Command Prompt using the Run as Administrator option.

3.Change the directory to point to the location containing the Agent Service files.

Command Prompt Agent Service

To generate a self-signed certificate for agents:

NOTE: Create the certificate for the first agent only, then copy that certificate to additional agent machines.  Make sure that the folder into which you are generating the certificate already exists.

At the command prompt, use following command to generate a certificate:

Metalogix.Agent.exe --generateCertificate <certificateName> --certificatePassword <certificatePassword> --path <certificatePath>


NOTE:  When generating a certificate, there is no need to enter the file extension as it will be ignored.



Metalogix.Agent.exe --generateCertificate ContentMatrixAgentCertificate --certificatePassword certPass --path C:\Certificates

To install the Metalogix Agent Service:

NOTE:  If you have already created a self-signed certificate on the first agent, make sure it is copied to the other agent(s) before performing this procedure .

At the command prompt, use following command:

Metalogix.Agent.exe -i --user <domain\username> --password <password> --certificatePath "<certificatePath>\<certificateName.FileExtension>" --certificatePassword <certificatePassword>



Metalogix.Agent.exe -i --user metalogix\Administrator --password userPass# --CertificatePath "C:\Certificates\ContentMatrixAgentCertificate.pfx" --certificatePassword certPass

To Start the Metalogix Agent Service:

1.Navigate to Administrative Tools > Services > Metalogix Agent Service.

2.Right-click and choose Start.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating