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

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.

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 Job 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

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



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



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

·It is necessary to use double quotation marks (" ") to enclose:

§a password that contains special characters

§a file path that contains spaces (as shown in the example above).

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:\Content Matrix Certificates\ContentMatrixAgentCertificate.pfx" --certificatePassword certPass


NOTE:  It is necessary to use double quotation marks (" ") to enclose:

·a password that contains special characters

·a file path that contains spaces (as shown in the example above).

To Start the Metalogix Agent Service:

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

2.Right-click and choose Start.

Managing Agents

From any agent machine, you view, refresh and disable/enable jobs.

NOTE:  All agents connecting to the same Distributed Database must have the same version of Content Matrix installed.

To open the Manage Agents dialog:

From the Metalogix Content Matrix Console ribbon, choose Connection > Manage Agents.

NOTE:  If the machine is not connected to a configured Distributed Database, Manage options will be disabled.

Manage Agents Dialog

The Manage Agents dialog presents a toolbar with the following options:

·View Agent - Displays more information about a selected agent such as log history, and other pertinent information.

Agent Details

·Refresh - Displays the most recent status of a selected agent.

·Enable/Disable Job  - Allows/prevents the agent from pulling migration jobs from the Distributed Database.

NOTE:  If you want to uninstall the agent completely, use the procedure for Uninstalling a Distributed Migration Agent.

·Agent Support Zip - Generates a zip file containing logs that can be sent to Quest Support for troubleshooting.

Generating an Agent Support Zip File

From the Manage Agents dialog, you can generate a zip file to send to Quest Support for troubleshooting purposes.

The contents of the zip file will vary, depending on which agent is selected in the grid.

If the agent selected in the grid is ...

Then ...

the local machine

the zip file will contain two files:

·Distributed Database logs for the agent (AgentServiceDBLogs.txt)


·event log entries for the local agent (AgentServiceEventLogs.txt).

a remote machine

the zip file will contain the Distributed Database logs file for the agent (AgentServiceDBLogs.txt) only.

If you want to provide event logs for a remote agent, you will need to log onto that machine and generate a Support zip file from there.

To generate an Agent Support zip file:

1.Make sure the appropriate agent is selected in the grid.

2.From the Manage Agents toolbar, select Agent Support Zip and save the zip file to the desired location.

Send any zip files you generate to Quest Support.

Uninstalling an Agent

To uninstall an agent:

1.Log into the machine using an Administrator account.

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.  (C:\Program Files (x86)\Metalogix\Agent Service is the recommended default location, but the files may be in a different location.)

Command Prompt Agent Service

4.Run the following command:

Metalogix.Agent.exe -u

5.Uninstall the Content Matrix Console.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating