Chat now with support
Chat with Support

Metalogix Content Matrix 8.8 - SharePoint Edition User Guide

Introduction Entering the License Key Content Matrix Console End User Interface Enabling Advanced Mode Connecting to SharePoint 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 2010/2013/2016 Document IDs Changing a Job Configuration for Multiple Files SharePoint 2003 Version Migration Limitations SharePoint 2013 and 2016 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 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

Using PowerShell to Create Custom Transformations

When you select the Add Transformer > Invoke PowerShell script option for an Available Definition, you can use custom PowerShell scripts to create your own transformations beyond the built-in capabilities of the Metalogix Content Matrix.

NOTE:  For prerequisites to using PowerShell with Metalogix Content Matrix, see Configuring PowerShell for Use with Metalogix Content Matrix.

Specify when you want the script to run by selecting one of the following options:

Begin Transformation – The transformation script will run before the migration of the affected objects, allowing you to read and make changes to objects on the source before objects themselves migrate.  

Transform – The transformation script will run while the migration of the affected object(s) is in progress.  For example, the user mapping between source and target would be run using the Transform option.

End Transformation – The transformation script will run after the migration of affected object(s), allowing you to read and make changes to objects on the target.  

EXAMPLE:  The following Transformer consists of two scripts for disabling and re-enabling the Required setting for a column list.

·The first script entered into the Begin Transformation tab sets the setting of any columns that are Required to false before copying begins.

Configure PowerShell Transformer

·The second script, entered into the End Transformations tab, sets the setting back to true after item migration has completed.

CONTEN~1_img135

Saving or Running a Migration Action

When you finish configuring a migration action, you can run it immediately or save a copy of the settings to a job file, which displays in the Job List section.  You can then:

· run a migration directly from the Jobs List section

OR

·schedule the job to run at a specified time, either as a Windows Scheduled Task or straight from PowerShell.

OR

·If the Console is configured as the Controller (Host) machine for Distributed Migration, submit a Distributed Migration job.

You can also save the job configuration as a template so that you can preserve and reuse settings for future migration jobs.

When the migration starts, a status dialog box will appear. The migration logs can be viewed (in progress or after the migration is finished) by clicking [Details>>]. The Status section of the status box will list a live count for the number of successes, warnings, failures, etc. for the migration. The Progress section of this dialog will list any completions and the type of completion (Sites, lists, items, users, groups, etc.). A Migration Completed message will appear when finished. Click Close to exit the status dialog.

Saving a Job Configuration as a Template

You can create job configuration templates for a set of selected settings which can be saved and reused, including any options that are not normally preserved using the Preserve Configuration Options option (in the ribbon Settings menu).

These templates can also be moved to another machine and used with a separate install of Metalogix Content Matrix Console (provided that it is the same Edition of Metalogix Content Matrix, and the same version number or greater).

To save a job configuration template:

1.After initiating a migration, complete the Configure (Object) Copying Options with the settings that you want to include in the template.

Sve Job Configuration dialog

2.Click [Save Job Configuration].

Here you can set the display name for the job template. This is not the actual file name, but it is the name that Metalogix Content Matrix will use to list the template.

NOTE: In most cases, when a job template is saved by Metalogix Content Matrix it will be saved to the following location:

<Drive>:\Users\<User>\AppData\Roaming\Metalogix\Metalogix Content Matrix Console - <Product> Edition

However, it is highly recommended that you do not interact with this system location. If you are trying to save a job template so it can be exported to another system the template can be exported from the Manage Job Configurations dialog.

3.Enter the desired display name value and click [OK] to continue.

Once the save is complete, you will be returned to the Configure <Object> Copying Options dialog where the migration can either be Run or Saved.

The saved job templates will now be visible in the Manage Job Configurations dialog.

NOTE: If you are looking to save a job template and move it to another system for use, this should be done using the Export option in the Manage Job Configurations window. Additionally, if you are trying to Import a job template from another system, this must also be done from either the Manage Job Configurations dialog or it can be imported when applying a template.

Applying a Job Template

Any job templates that have been imported or saved, and are available in the Manage Job Configurations dialog can be applied to another migration of the same type. For example, if migrating at the site level, you would not be able to use a job template that is created for a migration at the list level. It would only be able to use a template that migrates at the site level.

The source and target connection types do not apply directly to a job template, so it does not matter if the connection types for the new migration are the same as the connection types for the job template. If the connection types are different than any options that are not applicable for the connection types that are being used will not be available, but all other options will be set.

1.After initiating a migration, click [Open Existing Job Configuration] in the bottom left corner of the Configure <Object> Copying Options dialog to display the Select Job Configuration to Apply dialog.

NOTE:  Any options you have specified directly in the dialog will be overwritten once a job template is applied.

Select Job Configuration to Apply dialog

The  dialog lists all of the job templates that are currently available for the migration type (i.e. a site, list, item, etc. migration), as well as only the templates for the specific Edition of Metalogix Content Matrix that is being used.

2.Select the desired job template and click [OK].

You will be prompted to confirm your action before continuing.  Remember that if you choose to apply the template, any other settings that you entered directly in the Configure <Object> Copying Options  will be lost.

The Configure <Object> Copying Options dialog will now reflect all of the template options. Any additional configuration options can be set or modified, and the migration can continue as normal.

Related Documents