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

Job List Database fails to Load After Upgrade


I recently upgraded to Metalogix Content Matrix Console version v.6.2.x.x and my Job List database is failing to load. What might be causing this issue? and how can I fix it?


This issue was likely caused by a recent upgrade to Metalogix Content Matrix Console's security features. A security upgrade has been made in Metalogix Content Matrix Console version and later. This change has resulted in two potential issues that users can encounter. These issues and their resolutions are:

·Issue 1: The Job List database failing to load.
Resolution: When the Metalogix Content Matrix Console client opens, an error message will prompt the user to open the Job List file again. Go down to the Job List section and click File > Open Job List. This will open a Browser window. Navigate to the location that contains the LST file for the Job List that was previously listed in the Job List section. Then select the LST file and click Open. The Job List will now be loaded and users can continue as normal.
Due to the security upgrades in version and later, the security settings for the Job List need to be upgraded. Metalogix Content Matrix Console cannot do this while the job is actively selected, but can apply the update to the existing Job List the next time it is loaded back to the Job List section of the client application.

·Issue 2: Any connections that have had the Save my credentials check box selected will no longer have their passwords saved.
Resolution: For any connections that had their credentials previously saved by using the Save my credentials option, you will need to connect or reconnect to that environment and enter the password in again, then complete the connection. The security upgrade has caused the encryption file for any saved passwords within Metalogix Content Matrix Console to be upgraded, and to apply this upgrade to this file, any saved passwords must be re-entered.

Customized Wiki Page Web Part Zones Not Being Migrated


Why is it that when I migrate a wiki page that has been modified using SharePoint Designer (SPD),  web part zones and web parts are not preserved on the target?


To be able to migrate web part zones and web parts that were added using SPD:

·the SharePoint source version and the source connection type must support customized wiki page migration


·the Configuration Key AllowCustomizedWikiPageMigration in the ApplicationSettings.xml file must be set to True.

Supported Source SharePoint Versions and Connection Types

You can migrate custom web part zones and web parts added using SPD for the following SharePoint versions and connection types on the source.

Supported Source Version

Supported Source Connection Types

SharePoint 2007

·Remote Object Model (MEWS)

·Database (Db)

SharePoint 2010

SharePoint 2013

·Local Object Model (OM)

·Remote Object Model (MEWS)

·Database (Db)

NOTE:  Currently, customized wiki page migration is not supported for a SharePoint 2016 or SharePoint 2019 source.

Adding a Configuration Key to Allow Customized WikiPage Migration

If you want to migrate Customized wiki pages instead of treating them as normal wiki pages for which source content will not be preserved at the target after migration, you can add the Configuration Key AllowCustomizedWikiPageMigrationto the ApplicationSettings.xml file manually (ideally after the Configuration Key EnableSslForEmail) and set the value to True.

Application Setting AllowCustomizedWikiPageMigration

Preserving SharePoint List Item IDs with a CSOM Connection Type


Is it possible to Preserve SharePoint list item IDs when migrating with a CSOM (Client Side Object Model) or Office 365 Tenant connection type on the target?


Yes, it is possible to preserve SharePoint list item IDs when migrating content to a target with a CSOM/Tenant connection.

Item IDs and Document IDs are a little different in SharePoint (not the SharePoint 2010 or 2013 Document ID feature), and this means that how they can be accessed through a CSOM connection is a little different. Preserving Document IDs will only work if an OM (Object Model) connection is made to the target, through either a Local OM or Remote OM (Extensions Web Service) connection. There are some limitations that can be encountered when trying to preserve Item IDs that are dependent on the connection type. There are three basic connection types that we need to keep in mind when looking at these limitations. They are:

·Local or Remote OM (Object Model) Connection - This connection type is made either when the Metalogix Content Matrix Console client application is installed directly on the target SharePoint server, or a remote connection is made using the Metalogix Extensions Web Service. When this type of connection is made, Metalogix Content Matrix will be able to directly set the list item ID value in SharePoint through the Object Model. This value can be set as long as that specific value is not already being used by another list item.

·SharePoint CSOM (Client Side Object Model) or Office 365 Tenant Connection - This connection type is made when remotely connecting to an Office 365 environment. When connected to SharePoint Office 365 using a CSOM connection, Metalogix Content Matrix cannot directly set the list item ID value so another method must be used instead. The CSOM method for preserving the list item ID value is for Metalogix Content Matrix to create a temporary item and then deleting it. This creation and deletion process is done in batches and each item that is added will increment the ID value by 1. This will continue until the Metalogix Content Matrix reaches the necessary item ID value. If the target ID value is already in use, or if another item with a higher ID value exists in the list, then the item(s) will be added to the end of the target list (and not at its ID value). There are a few limitations to this method:

oOlder items that are placed into newer folders - The general case for this is if an older item, that has a lower ID number value is moved and placed into a folder that was more recently created (and has a higher ID number value). In this case, the items with the lower ID number values will be added after the folder is created, so their ID number values will not be preserved. For example, if a list item with an ID value of "12" is moved into a folder, and the folder has an ID value of "25". In this case the ID value for the item will not be preserved because the folder it is located in will not be created until ID 25 is created. So Metalogix Content Matrix will hold onto the item until the folder is created and then add it, but because the item ID has already been passed, its value cannot be preserved, and it will be given a new value by SharePoint after all other items have been added.

oLists containing default data - The general case for this scenario is when a SharePoint list (and not a Document Library) is created and SharePoint automatically adds a number of items (one or multiple) by default into that list. The default items that are created by SharePoint will also automatically be assigned an item ID value by SharePoint. When migrating this type of list their data will be deleted before the source content is migrated. The default added items will have ID values associated with them, and when the items are deleted those ID values will no longer be available, and Metalogix Content Matrix won't be able to track what the values were associated to. This can interfere with the ID value calculations that are made, and throw off the ID values that are being set during migration.
The most common place where users can see default list items created is when an "Announcements" list is created. Announcement list that are created by SharePoint will automatically create one item by default that is the "Welcome" message. However, when migrating with Metalogix Content Matrix and using the override option, users should not see this issue with Announcement lists because Metalogix Content Matrix will delete the list that is created by the site template, and create a new one. When the new list is created Metalogix Content Matrix is able to add the list items directly, and allows for the list item ID value to be set in the process. This is more likely to be an issue with SharePoint lists that have had their template modified to automatically generate a set of default items.

NOTE: When migrating SharePoint Task lists to a CSOM Office 365 connection, it is recommended that the Preserve IDs on items/folders in Lists option is selected. This is to help preserve the Related Items property for items in the Task list. If unchecked there is a small chance that the Related Items property may list incorrect files, because some of these files may be referred to through the Item ID value.

Retrying Failed Document Copies to O365 CSOM Connections


When I try to migrate some of my content into O365 using a SharePoint CSOM or Office 365 Tenant connection type, and this content contains a large Document Library, I see that some of my documents fail to migrate. The logs for the failure indicate that a "HTTP 500 - Internal Server Error" was thrown. What is the cause of this? And how can I fix it?


There is a potential issue when migrating specifically to O365 where users can encounter an "HTTP 500" error. This is caused by a combination of the CSOM/Tenant connection adapter and SharePoint's document upload methods. To help resolve this issue there is a document retry feature that can be configured. This retry feature will attempt to upload the document(s) into the O365 target, and depending on the configured setting, will attempt to retry the upload process if it fails or times-out on the initial try.

The below steps will explain how to enable and configure this retry setting.

NOTE: This retry method is only meant for migrating to O365 targets. If you are migrating to an on-premise target, then this retry feature will not benefit you since it makes use of O365 specific methods.

1.Make sure that the Metalogix Content Matrix client application is closed.

2.In the file system that the Metalogix Content Matrix Console client application is installed on, navigate to the following folder location:


3.In this location there should be an EnvironmentSettings.xml file. Open this file in an editor program. For example, Notepad, etc.

4.There are two variables that will need to be modified in order for the retry method to work. They are:

·CSOMDocumentRetriesNumber - This value determines the number of times that Metalogix Content Matrix will make another attempt to upload/migrate any document(s) that has failed the initial document upload try, when migrating to a O365 CSOM target.

·CSOMDocumentRetriesDelay - This value determines the amount of time, in seconds (s), that Metalogix Content Matrix will wait before starting a document upload retry, and is based on the above ("CSOMDocumentRetriesNumber") variable.

NOTE: The default values for these two variables will be set as "0". Users can set these values as desired, based on what works best for their environment.

5.After the desired values have been entered in the two variables, save and close the file.

6.Restart the Metalogix Content Matrix client application. The changes should now be in Metalogix Content Matrix Console, and used when running any migration to a SharePoint Online target environment.

After these values have been set and the client application has been restarted, any documents that fail on the initial migration attempt we be retried.

IMPORTANT:  If these steps do not resolve the issue and you are using the Import Pipeline for the migration, the error may be pipeline-related.  See "Error, the batch will be resubmitted" Message Displays When Using the Import Pipeline for details.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating