Chat now with support
Chat with Support

Metalogix Content Matrix 9.2 - 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

Get-NestedContentsUrlLengthReport

This is the same as Get-NestedContentsReport, with the following exceptions:

·No Recursive property.

·Additional property: SiteCollectionURL - The Site Collection URL that the report will be generated with respect to. (Mandatory)

·The Target parameter is Mandatory.

Get-PreMigrationCheck

·CheckName: Check name for illegal SharePoint character.

·CheckSize: Check documents size does not exceed maximum file size.

·CheckUnsupported: Check for unsupported eRoom content types.

·CheckURLAsDocLib: Check URL length when pasting as document library.

·CheckURLAsSite: Check URL length when pasting as site.

·ContentOptions:Content Options e.g. Include SubFolders, Include Database, Include Documents etc.

·CsvFileName: Output csv report file name.

·EmailFailureTemplateFilePath: The absolute file path of the html template to use for the job completion email when the job fails.

·EmailPassword: A password to use for the specified user when connecting to the specified email server. If no user name is set, default credentials will be used.

·EmailServer: An email server to use for sending job completion emails.

·EmailSubject: A custom subject for the job completion email.

·EmailSuccessTemplateFilePath: The absolute file path of the html template to use for the job completion email when the job is successful.

·EmailUserName: A user name to use when connecting to the specified email server. If not set, default credentials will be used.

·FromEmailAddress: The email address of the mailbox from which the job completion emails will be sent.

·CCEmailAddress - A semicolon delimited list of email addresses to CC on the job completion email.

·BCCEmailAddress - A semicolon delimited list of email addresses to BCC on the job completion email.

·JobDatabase - The connection string of a jobs database to use for logging. If the connection string is invalid, an exception is thrown. If both 'JobFile' and 'JobDatabase' parameters are specified, then the 'JobDatabase' parameter will take precedence and the job will only be written to the job database.

·JobFile - The name of a job file to use for logging. If the file does not exist, it will be created.

·OutputCsv: Save output report files to output folder or not.

·OutputFolder: Specify path of output report files.

·Quiet - If set, the operation will not report progress to the PowerShell console.

·Source - The source node for the actions.

·Target - The target node for the actions.

·TargetLocation: Target SiteCollection/Site/Document library location based on which URL length calculated.

·TargetURL: URL of SiteCollection/Site.

·ToEmailAddress: A semicolon delimited list of email addresses to which the job completion email will be sent.

·Transformers: The collection of data transformers which the action needs to run. Note that if the passed-in value for this parameter does not include transformers which are considered mandatory, they will be added automatically.

New-eRoomConnection

·ServerURL - The URL of the eRoom server to connect to. (Mandatory)

·ServerXmlURL - The URL of the eRoom server to connect to. (Mandatory)

·User - A user to connect as, in DOMAIN\Login format. (Mandatory)

·Password - The password for the user provided. (Mandatory)

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.

2.Either:

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

OR

§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.

CONTEN~1_img140

 

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.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating