Chat now with support
Chat with Support

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

Copy-eRoomContainerAsNestedSiteCollection

·Name - The name of the nested site collection. (Mandatory)

·Path - The managed path in the web application to add the site collection under. (Mandatory)

·URL - The name of the site collection that is part of the URL. The path appended to the URL becomes the relative URL to the site collection. (Mandatory)

·OwnerLogin - The username of the owner. (Mandatory)

·WebApplicationName - The web application name. (Mandatory)

·WebTemplateID - The web template ID. (Mandatory)

·WebTemplateConfig - The web template config. (Mandatory)

·LanguageCode - The language code. (Mandatory)

·ReportLocation - The filepath of the nested contents report to be used to migrate the eRoom container.

·Description - An optional description of the site collection.

·SecondaryOwnerLogin - The username of the owner.

·ContentDatabaseName - The content database name. If not specified, Metalogix Content Matrix will attempt to auto-detect it.

·SetSiteQuota - Set the site quota.

·QuotaID - The quota ID.

·QuotaMaximum - The maximum quota in bytes.

·QuotaWarning - The quota at which the warning will be triggered in bytes.

·PasteContainerOptions - Paste container options (XML).

·MigrationModeOptions - Specifies whether the migration is full or incremental.

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

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

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

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

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

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

·EmailFailureTemplateFilePath - The absolute file path of the HTML template to use for the job compeltion email if the job fails.

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

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

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

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

·Source - The source node for the actions.

·Target - The target node for the actions.

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

Copy-eRoomContainerAsSite

·CollisionOptions - Overwrite, rename, or skip on existing container with same name.

·ContentOptions - Specify how to handle nested contents: do not migrate, migrate only new items, migrate into subsite, migrate into current directory with parent name as prefix.

·WebTemplateID - The web template ID.

·WebTemplateConfig - The web template config.

·LinkCorrectionOptions - Options for Link Correction.

·CorrectName - Enable/disable automatic replacement of invalid SharePoint characters in name.

·CorrectNameCharacter - Specify the replacement character for invalid SharePoint characters in name.

·MigrateCalendars - Migrate calendars.

·CalendarOptions - Calendar options. (XML)

·MigrateDatabases - Migrate databases.

·DatabaseOptions - Database options. (XML)

·MigrateDiscussions - Migrate discussions.

·DiscussionOptions - Discussion options. (XML)

·MigrateDocuments - Migrate documents.

·DocumentOptions - Document options. (XML)

·MigrateSubFolders - Migrate subfolders.

·MigrateInboxes - Migrate inboxes.

·MigrateMail - Migrate mail.

·InboxAndMailOptions - Inbox and mail options. (XML)

·MigrateLinks - Migrate links.

·MigrateNotes - Migrate notes.

·NoteOptions - Note options. (XML)

·MigratePolls - Migrate polls.

·PollOptions - Poll options. (XML)

·MapUsers - Enable/disable user metadata mappings.

·MapPermissions - Enable/disable automated eRoom permissions mapping to best-matching SharePoint role. (Requires -MapUsers)

·MappingsOptions - User/permission mapping options.

·MigrationModeOptions - Specifies whether the migration is full or incremental.

·LinkOptions - Link options. (XML)

·MigrateTreeViewSetting - Enable/disable migration of the Tree View setting.

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

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

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

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

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

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

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

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

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

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

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

·Source - The source node for the actions.

·Target - The target node for the actions.

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

Copy-eRoomContainerAsSiteCollection

·Name - The name of the site collection. (Mandatory)

·Description - The description of the site collection.

·Path - The managed path in the web application to add the site collection under. (Mandatory)

·URL - The name of the site collection that is part of the URL. The Path appended with the URL becomes the relative URL to the site collection. (Mandatory)

·OwnerLogin - The username of the owner. (Mandatory)

·SecondaryOwnerLogin - The username of the owner.

·WebApplicationName - The web application name. (Mandatory)

·ContentDatabaseName - The content database name. If not specified, it will be auto detected.

·WebTemplateID - The web template ID. (Mandatory)

·WebTemplateConfig - The web template config. (Mandatory)

·LanguageCode - The language code. (Mandatory)

·SetSiteQuota - Set the site quota.

·QuotaID - The quota ID.

·QuotaMaximum - The maximum quota (in bytes).

·QuotaWarning - The quota at which the warning will be triggered (in bytes).

·PasteContainerOptions - Paste Container Options (XML).

·MigrationModeOptions - Specifies whether the migration is full or incremental.

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

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

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

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

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

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

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

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

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

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

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

·Source - The source node for the actions.

·Target - The target node for the actions.

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

Copy-eRoomDocument

·CollisionOptions - Overwrite, rename, or skip on existing file with same name.

·LinkCorrectionOptions - Options for Link Correction.

·CorrectName - Enable/disable automatic replacement of invalid SharePoint characters in name.

·CorrectNameCharacter - Specify the replacement character for invalid SharePoint characters in name.

·MapCustomFields - Map Custom eRoom Fields to SharePoint Fields (limited support).

·MigrateVersions - Migrate document versions.

·EnableVersioning - Enabled: migrate versions to all target SharePoint document libraries. Disabled: migrate versions to only SharePoint document libraries that support document versioning. (DEFAULT: True)

·MigrateAllVersions - Migrate all document versions.

·MigrateXVersions - Migrate the latest 'x' document versions.

·NumberOfVersions - Specify the 'x' document versions to migrate.

·MapUsers - Enable/disable user metadata mappings.

·MapPermissions - Enable/disable automated eRoom permissions mapping to best-matching SharePoint role. (Requires -MapUsers)

·MappingsOptions - User/permission mapping options.

·MigrateContentTypes - Apply content types.

·ContentTypes - List of content types to apply.

·MigrationModeOptions - Specifies whether the migration is full or incremental.

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

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

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

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

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

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

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

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

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

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

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

·Source - The source node for the actions.

·Target - The target node for the actions.

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

Related Documents