Chat now with support
Chat with Support

Metalogix Content Matrix 8.9 - SharePoint Edition User Guide

Introduction Entering the License Key Content Matrix Console End User Interface Enabling Advanced Mode Connecting to SharePoint Migrating to O365 Using the Azure Pipeline/SPO Containers Preparing for a Migration How Content Matrix Handles Various SharePoint Components Initiating a Migration Configuring Copying Options Saving or Running a Migration Action Copying SharePoint Objects as a Separate Action Self-Service Migration Incremental Migration Log Files 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 and Self-Service Migration Frequently Asked Questions
DB_Owner Permission Migrating with the Fabulous 40 Templates Item Count Discrepancies 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 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 Preserving IDs when Migrating a Custom List as a Folder Migrating JavaScript Migrating Site Variations Migrating with SharePoint Document IDs Changing a Job Configuration for Multiple Files SharePoint 2003 Version Migration Limitations 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 on the Target Migration Error Message 'There was an Error Reading from the Pipe: The Pipe has been Ended (109, 0xd6)' How do I Remove Items from My Azure Blob Storage Account? Azure Batches Getting Stuck "Error, the batch will be resubmitted" Message Displays When Using Azure Item Count at Target is Increased When Migrating Using the Azure Pipeline Custom Lists with Versioning Enabled Not Being Migrated When Using the Azure Pipeline Supported Nintex Actions for SPO Migration "Insufficient Credentials" Message Connecting to Modern Team Site Using Web Browser Authentication Error Making a Browser-Based Connection with PowerShell Console Open
About Us

Configuring Metabase Settings

Metalogix Content Matrix lets you configure the location of the Metabase file, which is a SQL CE (Compact Edition) database file that is used for storing metadata for a specific purpose, for a Console instance.  The  metabase temporarily holds any migrating content's metadata so it can be moved into the target SharePoint instance. This allows for any metadata to be used with other features, such as Transformers.  The Metabase file itself is both created and deleted during the course of a migration action.

To configure Metabase settings:

1.In the Metalogix Content Matrix Console ribbon, choose Settings > Configure Default Metabase Settings to display the Change Metabase Default Settings dialog.

2.Select the appropriate configuration option.  Use the information in the following table for guidance.

Change Metabase Default Settings

If you want to …

Then …

specify a new folder in which to create the Metabase

·Select Provision New SQL Server Compact database.

·Click the folder icon (CONTEN~1_img239) and select the new location.

select an existing SQL Server Compact database (SDF) to use for the Metabase

·Select Use SQL Server Compact Database.

·Click the database/file icon (CONTEN~1_img240) and select the existing Metabase.

NOTE:  Metalogix Content Matrix will add and remove the Metabase tables during the migration.

select a SQL Server database in which to create and delete the Metabase tables

NOTE: This option allows Metalogix Content Matrix to place the Metabase directly into SQL Server. The main benefit being that it can allow for a performance boost when migrating large amounts of content, since it has a direct connection to SQL Server, and the Metabase logs will have a 4GB limitation that SQL Server files have.

·Select Use SQL Server database.

·Click the database icon (CONTEN~1_img241).

·Connect to the SQL Server using one of the following options:

§Manually enter the name or IP address for the SharePoint Database you want to connect to.


§Chose a previously accessed SQL server from the drop-down.


§Click [Browse] then navigate to and select either a Local or Network SQL server.

SQL Server Browser

3.Click [OK].

Configuring Azure SPO Pipeline Settings

Metalogix Content Matrix has various XML properties that can be modified to fine-tune or help troubleshoot your Azure SPO Pipeline migrations.  These properties can be found in the EnvironmentSettings.xml file.

For a list of supported migration actions using the Azure Pipeline, see Objects and Actions Supported by the Azure SPO Migration Pipeline.

Connection String Setting

The following XML properties must have a value in order to migrate using the Azure SPO Pipeline:


This is the storage account information for your Azure storage, which allows containers to be created and files to be uploaded. Enter your account name and key in the following format:



   <Value>DefaultEndpointsProtocol=https;AccountName={your account name};AccountKey={your account key}</Value>







Batch Size Settings

The following XML properties can optionally be modified. However, it is generally recommended to not modify these values unless you are encountering issues when migrating using the Azure SPO Pipeline.

NOTE:  If you installed Content Matrix prior to version 8.9, the batch size settings UploadManagerDetermineBatchSizesByMB, UploadManagerBatchSizeThreshold, and UploadManagerBatchSizeThresholdInMB  will still appear in the EnvironmentSettings.xml file but are no longer used.


This controls the number of batches that can be uploaded simultaneously to Azure storage. The default value is 2 and the value must be a positive integer. Only increase this value in small increments (4, 5, 6, etc.), and only when taking into consideration your total upload bandwidth, resources such as CPU and free memory on the workstation that is performing the migration, batch size, and so on.






This key controls the maximum batch size in item count, including all folders and documents, to be used if Content Matrix will be submitting batches according to number of items. The default value is 200 and the value must be a positive integer.






This key controls the maximum batch size to be used if Content Matrix will be submitting batches according to size. The default value is 1000 megabytes and the value must be a positive integer. The value should be set carefully, taking into consideration factors such as total upload bandwidth, speed of data retrieval from the source system, and so on.





Batch Resubmission Settings


This key controls the maximum number of times Content Matrix will resubmit the batch until it is successfully migrated.  (The default value is 5.)




This key specifies error conditions for which you want Content Matrix to resubmit a batch, when it normally would not.  

NOTE:  Separate multiple error messages with a pipe character (|), as shown in the example below.



   <Value>Item does not exist|Object Reference Not Set</Value>




By default, if you are migrating a batch that includes a list with a base type of CustomList (such as Announcements) and versioning is enabled, these lists are excluded from the resubmission, because duplicate items may be migrated to the target if the batch is resubmitted.  You can choose to include these types of lists in resubmissions, however, by  changing the value of the key RetryBatchForCustomListWithVersions from False to True.

NOTE:  If custom lists are being excluded from batch resubmissions and all items are not successfully migrated, you can migrate any outstanding items using incremental migration.





Special Purpose Settings


This key indicates the directory in which the temporary binary files and manifest XML files for each batch are saved. If no filepath is specified, the default filepath of C:\ProgramData\Metalogix is used.



   <Value>C:\ProgramData\Metalogix\Temp folder sample</Value>



WARNING: This value should not be changed unless absolutely necessary.

This key controls the amount of time to wait for a response from the reporting queue before re-requesting a migration job. This value is specified in multiples of 15 seconds, meaning that the default value of 960 corresponds to 4 hours and the minimum value of 120 corresponds to 30 minutes. This value must be a positive integer greater than or equal to 120.






This key hides or displays the fields in the Metalogix Content Matrix Console UI that allows you to enter your Client ID and Application Secret when connecting to SharePoint. If this value is set to People, the fields are hidden. If this value is set to Graph, the fields are displayed. The default value is People.

It is recommended that only advanced users enable these fields and enter a client ID and application secret, as this is not mandatory to migrate using the Azure pipeline, and in most cases, provides negligible additional performance.





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 and Self-Service 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.

Self-Service Migration applies a similar model, but is designed to allow end users to perform migrations on a remote machine from their own workstations, using pre-configured migration job templates and a simplified set of options.

Both feature sets consist of a Metalogix Content Matrix Console Controller (Host), a central jobs database, and one or more loosely-coupled Metalogix Content Matrix Console agents (for Distributed Migration) or workstations (for Self-Service Migration).

Distributed and Self Service Migration Illustration*


·Self-Service Migration is an additionally-licensed component.  If your Metalogix Content Matrix license does not include Self-Service functionality, these options will be disabled.  However, you can use Distributed Migration with any standard Metalogix Content Matrix license.

·The Metalogix Content Matrix license file is copied to Self-Service workstations as part of the workstation configuration process.  However, if other (full) editions of Metalogix Content Matrix Console, Organizer, or License Check are installed on a machine that is also designated as a SharePoint Edition Self-Service workstation, the license key will need to be re-entered to cover the additional component(s).


Connection icon

Distributed Migration and Self-Service Migration support the following SharePoint connection adapters:

·Metalogix Extensions Web Service (MEWS)

·SharePoint Client Side Object Model (CSOM), including all connections to SharePoint Online.

Distributed Migration also supports Database connections on the source side.

Related Documents