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

Using Powershell for Nested Content Reports and Pre-Migration Check

You can perform Pre-Migration Checks, Nested Contents Reports, and Nested Contents URL Length Reports through the PowerShell command window.

In order to create a PowerShell script for a Nested Contents Report or a Pre-Migration Check, Nested Contents URL Report, a report item must first exist in the Job List section.

To create a PowerShell script for Nested Content Reports and Pre-Migration Checks:

1.In the Job List section, select the report(s) want to run in PowerShell.


§Click the [Generate PowerShell Script] button in the Job List menu options


§Right-click and choose Generate PowerShell Script.

3.Choose the appropriate option from the sub-menu to specify the security method that will be used when generating the PowerShell script . Use the information in the following table for guidance.

If you want to generate a PowerShell script …

Choose …

that can be used only by the currently logged in User Account on the machine it is generated on

For Current User and Machine.

NOTE:  Any PowerShell scripts that are generated for scheduling through this option can only be run by the logged in user on the machine they were generated on.

that can be used by any User account on the machine it is generated on

For Current Machine.

that can be used by any User account on any machine that has the certificate that is specified when the script is created

For Certificate.

When you save the PowerShell script using this method you will be prompted to select a security certificate that exist on that machine. The selected certificate will be required on any system that attempts to run the script at a later date.



Once the applicable option is selected, Metalogix Content Matrix Console will generate a PowerShell script for the selected report, which will be written to a Notepad file. If multiple reports are selected, they will all be included in that single file.

3.To save the file as a PowerShell script:

a)In the Job List section toolbar, choose File > Save As....

b)In the Save As dialog box, navigate to the directory in which the script file is to be saved.

c)Click the Save as type drop-down menu and select All Files.

d)Enter a name for the script and append the .ps1 file extension to the file name to save it as a PowerShell script.

To run the PowerShell script:

1.Open the Metalogix Content Matrix Console - eRoom Edition PowerShell Console

eRoom PowerShell Console

2.Change the active directory to the file path in which the script file is saved by using the change directory command ("cd <File path>") and then enter ".\" followed by the script name. For example, if your script is named "ResourceScript.ps1", you would enter .\ResourceScript.ps1 to run the script.

NOTE:  If the active directory is different than the directory in which the script file is saved, enter the full file path of the script file relative to your current directory, and then the script file name. For example, if your prompt is at "C:\", your script is named "ResourceScript.ps1", and the script is saved on the desktop, you would enter C:\Users\<User>\Desktop\ResourceScript.ps1 to run the script.

In some cases, the Execution Policy may prevent you from executing a PowerShell script. In this case, you will likely see the following message: [Script].ps1 cannot be loaded because the execution of scripts is disabled on this system. Please see "get-help about_signing" for more details. In this case, run the following command: set-executionpolicy RemoteSigned. This will change the existing script policy to allow you to run these scripts in the specified location. However, it is advised that you check with your System Administrators before doing so to ensure that no Company Policies are being broken by this action.

All Pre-Migration Checks, Nested Contents Reports and Nested Contents URL Reports included in the PowerShell script will run, and any warnings or errors that are encountered while the script runs will be displayed in the PowerShell window.

Modifying Content Matrix Configuration and Settings

You can configure and customize a number of Metalogix Content Matrix settings, including:

·distributed migration configuration

·proxy settings

·available actions and events

·client-side Managed Metadata batch size and metabase settings

·resource utilization settings

·default settings in configuration variable files

Configuring Content Matrix for Distributed Migration

Metalogix Content Matrix can significantly improve the time it takes to complete migration jobs by using a distributed migration model. This model essentially consists of a Metalogix Content Matrix Console Controller (Host), a central jobs repository or queue, and one or more loosely-coupled Metalogix Content Matrix Console agents.

Distributed Migration Illustration

By automatically selecting the jobs from a central repository, Metalogix Content Matrix Console agents are able to distribute 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 end-user productivity from deployed resources.

Connection icon

Distributed Migration supports the following SharePoint connection adapters:

·Metalogix Extensions Web Service (MEWS)

·SharePoint Client Side Object Model (CSOM)

·CSOM using the Azure Pipeline

Distributed Migration Components

Distributed Migration is typically used for large migration projects and relies on the following three  components:

Controller (or Host)

This is the primary Metalogix Content Matrix Console that manages agents, the Distributed database and the migration jobs.

Distributed Database

A SQL Server database that contains the repository or queue of migration job definitions which the agents can execute.

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


This is a physical or virtual machine that is remote from the Controller machine. It is connected to through the Controller to run jobs remotely. Once connected, the Controller will push an installation of the Metalogix Content Matrix Console onto the Agent machine, which is then configured to execute the migration jobs that are sent from the Controller. Any logging information would 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.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating