Chat now with support
Chat with Support

Metalogix Content Matrix 8.9 - 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 Configuring Content Matrix for Distributed Migration Frequently Asked Questions About Us

Restricting Available Actions and Suppressing Events

Metalogix Content Matrix provides you with the ability to control what actions are available to the client application through configuring on the SharePoint server. Product behaviors can be restricted along three dimensions:

·Available actions

·Unrestricted users

·Suppressed events

Configuring the behavior of the Metalogix Content Matrix client from target SharePoint servers requires that an XML configuration file be added to the target SharePoint server web application directory. The XML file must be named ServerAdapterConfig.xml and placed in the ML folder directory located within the SharePoint hive (this is the same directory where the Metalogix SharePoint Extensions Web Service files are). Below are some examples of the typical directory location of the ML folder, depending on SharePoint product version and configuration:

·SharePoint 2007: - C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\12\isapi\ML

·SharePoint 2010: - C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\14\isapi\ML

·SharePoint 2013: - C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\15\isapi\ML

·SharePoint 2016: - C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\16\isapi\ML

·SharePoint 2019:-  C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\16\isapi\ML

ServerAdapterConfig.xml File Format

Below is an example of the simple XML format required for ServerAdapterConfig.xml.

   <ServerAdapterConfig>

     <DisabledActions>

       <Action>Metalogix.SharePoint.Actions.Migration.PasteSiteAction</Action>

       <Action>Metalogix.SharePoint.Actions.Migration.PasteSiteCollectionAction</Action>

       <Action>Metalogix.SharePoint.Actions.Migration.PasteSiteLists</Action>

    <Action>Metalogix.SharePoint.Actions.Migration.CopyRoleAssignmentsAction</Action>

    <Action>Metalogix.SharePoint.Actions.Migration.CopyWorkflowAssociationsAction</Action>

    <Action>Metalogix.SharePoint.Actions.Migration.PasteFolderAction</Action>

     </DisabledActions>

     <ExemptUsers>

       <User>METALOGIX\geordie</User>

       <User>METALOGIX\julien</User>

     </ExemptUsers>

     <SuppressEvents>False</SuppressEvents>

   </ServerAdapterConfig>

There are three main sections within the root ServerAdapterConfig section of this XML:

·DisabledActions: This section defines the set of actions that cannot be run on the client.  See Actions That Can Be Disabled on the Server Side for a complete list.

·ExemptUsers: This section defines the set of users by user name who are exempt from any DisabledActions. In other words, a user in the ExemptUsers is not subject to any restrictions imposed on Metalogix Content Matrix clients by the DisableActions section.

·SuppressEvents: This section defines if any of SharePoint's event receivers are suppressed/disabled during a migration and then restarted once the action is complete. The value for this section is set to "True" by default, but can be manually configured if want event suppression to be disabled. Suppression of event receivers allows Metalogix Content Matrix to avoid any potential concurrency issues when migrating (mainly with regards to workflows).

Actions That Can Be Disabled

Many of the SharePoint related actions available in the Metalogix Content Matrix Console can be disabled on the server side. The table below lists the complete set of client actions that can be disabled from the server and provides the format of the action name required in the DisabledActions section of the ServerAdapaterCongifuration.xml file.

NOTE: When an action that is available via the client UI is disabled on the server, it will be visible in client menus but disabled.

Action

Configuration File Format

Change Global Navigation Settings

Metalogix.SharePoint.Actions.Administration.ChangeGlobalNavigationAction

Change Quick Launch

Metalogix.SharePoint.Actions.Administration.ChangeQuickLaunchAction

Create Folder

Metalogix.SharePoint.Actions.Administration.CreateFolderAction

Create List

Metalogix.SharePoint.Actions.Administration.CreateListAction

Create List From XML

Metalogix.SharePoint.Actions.Administration.CreateListFromXMLAction

Create Site

Metalogix.SharePoint.Actions.Administration.CreateSiteAction

Create Site Collection

Metalogix.SharePoint.Actions.Administration.CreateSiteCollection

Create Site Collection in Self-Service Mode

Metalogix.SharePoint.Actions.Administration.CreateSiteCollectionSelfServiceMode

Delete Discussion Item

Metalogix.SharePoint.Actions.Administration.DeleteDiscussionItem

Delete Item

Metalogix.SharePoint.Actions.Administration.DeleteFolder

Delete List

Metalogix.SharePoint.Actions.Administration.DeleteItem

Delete Site

Metalogix.SharePoint.Actions.Administration.DeleteList

Delete Site Collection

Metalogix.SharePoint.Actions.Administration.DeleteSite

Export Doc Items

Metalogix.SharePoint.Actions.Administration.DeleteSiteCollection

Publish Documents and Pages

Metalogix.SharePoint.Actions.Administration.PublishDocumentsandPagesAction

Update Site Collection Settings

Metalogix.SharePoint.Actions.Administration.UpdateSiteCollectionSettingsAction

Add Role Assignments

Metalogix.SharePoint.Actions.Migration.AddRoleAssignmentsAction

Copy Folder Permissions

Metalogix.SharePoint.Actions.Migration.CopyFolderPermissions

Copy Item Alerts

Metalogix.SharePoint.Actions.Migration.CopyItemAlertsAction

Copy List Alerts

Metalogix.SharePoint.Actions.Migration.CopyListAlertsAction

Copy List Permissions

Metalogix.SharePoint.Actions.Migration.CopyListPermissions

Copy List Role Assignments

Metalogix.SharePoint.Actions.Migration.CopyListRoleAssignments

Paste Web Parts

Metalogix.SharePoint.Actions.Migration.CopyWebPartsAction

Paste Master Page Gallery

Metalogix.SharePoint.Actions.Migration.CopyMasterPageGalleryAction

Paste Content Types

Metalogix.SharePoint.Actions.Migration.CopySiteContentTypesAction

Paste All Subsites

Metalogix.SharePoint.Actions.Migration.CopySubSitesAction

Copy Web Alerts

Metalogix.SharePoint.Actions.Migration.CopyWebAlertsAction

Copy Web Permissions

Metalogix.SharePoint.Actions.Migration.CopyWebPermissions

Paste Workflow Associations

Metalogix.SharePoint.Actions.Migration.CopyWorkflowAssociationsAction

Paste All List Items

Metalogix.SharePoint.Actions.Migration.PasteAllListItemsAction

Paste All List Items into Items View

Metalogix.SharePoint.Actions.Migration.PasteAllListItemsIntoItemsViewAction

Paste Audiences

Metalogix.SharePoint.Actions.Migration.PasteAudiencesAction

Paste Default Web Part Page

Metalogix.SharePoint.Actions.Migration.PasteDefaultWebPartPageAction

Paste Duplicate List

Metalogix.SharePoint.Actions.Migration.PasteDuplicateListAction

Paste Duplicate Site

Metalogix.SharePoint.Actions.Migration.PasteDuplicateSiteAction

Paste Folder

Metalogix.SharePoint.Actions.Migration.PasteFolderAction

Paste List

Metalogix.SharePoint.Actions.Migration.PasteListAction

Paste List as Folder

Metalogix.SharePoint.Actions.Migration.PasteListAsFolderAction

Paste List Email Notifications

Metalogix.SharePoint.Actions.Migration.PasteListEmailNotificationAction

Paste List Item

Metalogix.SharePoint.Actions.Migration.PasteListItemAction

Paste List Item into Items View

Metalogix.SharePoint.Actions.Migration.PasteListItemIntoItemsViewAction

Paste My Sites

Metalogix.SharePoint.Actions.Migration.PasteMySitesAction

Paste Navigation

Metalogix.SharePoint.Actions.Migration.PasteNavigationAction

Paste Roles

Metalogix.SharePoint.Actions.Migration.PasteRolesAction

Paste Site

Metalogix.SharePoint.Actions.Migration.PasteSiteAction

Paste Site Collection

Metalogix.SharePoint.Actions.Migration.PasteSiteCollectionAction

Paste Site Collection in Self Service Mode

Metalogix.SharePoint.Actions.Migration.PasteSiteCollectionSelfServiceAction

Paste Site Content

Metalogix.SharePoint.Actions.Migration.PasteSiteContentAction

Paste Site Lists

Metalogix.SharePoint.Actions.Migration.PasteSiteLists

Remove Role Assignments

Metalogix.SharePoint.Actions.Migration.RemoveRoleAssignmentAction

Event Suppression

Metalogix.SharePoint.Actions.Migration.SuppressEvents

Note that many of the above listed actions are used by other actions. When a given action is enabled, but one or more of its sub-action is disabled, the sub-actions will not run. When a user attempts to run an action for which sub-actions are disabled, they will be notified with a dialog similar to the following:

CONTEN~1_img237

Configuration Variable Files

Metalogix Content Matrix uses a set of configuration variable files behind the scenes to help set and manage settings for all of the Metalogix Content Matrix Editions. This section explains what the configuration variable files are, their general behavior, and where to find them.

In older versions of Metalogix Content Matrix Console (V.6.0.0.1 and earlier, including the Migration Manager for SharePoint V3, V4, and V5 framework) the configuration variable files that were used for each user account and product Edition were contained in the EnvironmentSettings.xml file under each user's Profile.

Since then, Environmental Settings have been broken down into the following three files:

·EnvironmentSettings.xml

·UserSettings.xml

·ApplicationSettings.xml

These files are saved in different system locations and contain different settings, which allows some of the environmental settings to be configured for all users and Product Editions. Some settings can be configured for all Product Editions for a single user account, while other settings are limited to individual Product Editions.

NOTE: If the previous incarnation of the EnvironmentSettings.xml file still exists in the old folder location (<Drive>:\Users\<USER>\AppData\Roaming\Metalogix\Metalogix Content Matrix Console - <Product> Edition), the values for the settings will be pulled from this file into the three new configuration variable files.

Any settings that are configured in multiple files will be scoped to the lowest level (either in the "UserSettings.xml" file or the "ApplicationSettings.xml" file), including values that are pulled from the old EnvironmentSettings.xml file.

IMPORTANT:  Make sure the Content Matrix Console is closed when making updates to configuration variable files.

EnvironmentSettings.xml File

This file allows users to configure general settings for all Product Editions and all users. This means that these settings only need to be set in a single file, and they will be configured for all user accounts and all Product Editions on the installed machine. The location of this file depends on the version of Windows:

·Microsoft Vista/Windows 7/Windows 8/Windows 10 based systems:
<Drive>:\ProgramData\Metalogix

·Microsoft Windows XP based systems (Windows 98, Windows Me, Windows 2000, Windows 2003, and Windows XP):
<Drive>:\Documents and Settings\All Users\Application Data\Metalogix

UserSettings.xml File

This file allows users to configure general settings for all Product Editions for a specific user account (the logged in account). This means that these settings will be configured for all Product Editions, but only for the current user account. If another user would like to configure these same settings to work for them, they must be configured manually under the appropriate user account. The location of this file depends on the version of Windows:

·Microsoft Vista/Windows 7/Windows 8/Windows 10 based systems
<Drive>:\Users\<USER>\AppData\Roaming\Metalogix

·Microsoft Windows XP based systems (Windows 98, Windows Me, Windows 2000, Windows 2003, and Windows XP)
<Drive>:\Documents and Settings\<USER>\Application Data\Application Data\Metalogix

ApplicationSettings.xml File

This file allows users to configure settings that are limited to the specific Product Edition of Metalogix Content Matrix Console, for a specific user account (the logged in account). This means that each Product Edition, for every user account, must be configuredindividually. While the "ApplicationSettings.xml" file for each Product Edition can contain some of the same settings, there are some settings that are Edition specific (for example, some settings may only work for eRoom Edition, so they will only be available in eRoom Edition). Any settings that are replicated through various version of the file will only be applied to the specific Edition.

For example, the "AllowCheckResults" setting is available in every "ApplicationSettings.xml" file, but it must be set on an individual Product Edition basis. Setting it for File Share Edition will not configure it for eRoom Edition. The location of this file depends on the version of Windows:

·Microsoft Vista/Windows 7/Windows 8/Windows 10 based systems
<Drive>:\Users\<USER>\AppData\Roaming\Metalogix\Metalogix Content Matrix Console - <Product> Edition

·Microsoft Windows XP based systems (Windows 98, Windows Me, Windows 2000, Windows 2003, and Windows XP)
<Drive>:\Documents and Settings\<USER>\Application Data\Application Data\Metalogix\Metalogix Content Matrix Console - <Product> Edition

Related Documents