Navigation: Saving or Running a Migration Job > Submitting a Distributed Migration Job > Managing the Distributed Migration Job Queue |
If Metalogix Content Matrix has been configured for Distributed Migration, you can manage the Distributed Migration job queue from any machine that is connected to the Distributed Database.
To open the Manage Queue dialog:
From the Metalogix Content Matrix Console ribbon Connection tab, select Manage Queue.
NOTE: If the Manage Queue button appears disabled, the Content Matrix Console is not connected to use a configured Distribution Database.
The Manage Queue dialog displays a list of migration Jobs, called the Distributed Migration Job list. The information presented in the various columns are as follows:
Column |
Description |
---|---|
Job ID |
The unique identifier of the job. |
Job Name |
The name of the job. |
Created |
The date and time the job was saved (and not when the job was queued). |
Source Url |
The source of the migration content. |
Target Url |
The target of the migration content. |
Created On |
The name of the Agent where the job is running. The value is blank when the job is queued. |
Status |
Recent state of the job. The status values could be one of the following values: ·Queued - the migration job is ready to start. ·Running - a migration is in progress. ·Failed - the job has encountered a fault condition. ·Done - the migration has completed. |
You can select a job from the list by clicking anywhere on the row. A row selector icon and the highlighted row indicates the selected row.
Navigation: Saving or Running a Migration Job > Submitting a Distributed Migration Job > Deleting a Distributed Migration Job |
1.From the Manage Queue dialog, select the job that you want to delete from the Distributed Migration Job list. The row selector icon and the highlighted row indicates the selected row.
NOTE: Only jobs with a status of Queued or Done can be deleted. Deleting a job from the queue will not remove or delete any of the logging information that has already been sent to the main Job list for the Agent Database.
2.Click Delete Job.
(If the button is disabled, check that the selected job has a status that is either Queued or Done.)
A dialog will display asking you to confirm the deletion.
Navigation: Saving or Running a Migration Job > Creating and Running a PowerShell Script from the Jobs List |
In order to create a PowerShell (PS) script for Content Matrix, a job list (or batch file) must first exist in the Job List section of the Content Matrix Console. Once created, it can be run from the PowerShell console or scheduled to run as a Windows Scheduled task.
NOTE: It is recommended that the connections to the source and target environments have the Remember my password check-box selected. This is to ensure that the PowerShell scripts will be able to establish a connection to both the source and target environments when they are being run. If a password is required and this check-box is not set, the migration will fail. However, users can manually enter this value into the PowerShell script itself if the option was not checked when the script was first generated.
To create a PowerShell script:
1.In Job List, and select the job (or jobs) that you want to run in PowerShell.
2.Click the Generate PowerShell Script button in the Job List tool bar, or right-click on one of the items and select Generate PowerShell Script from the context menu.
3.From the drop-down, choose the appropriate option. Use the information in the following table for guidance.
If you want to generate a PowerShell script for scheduling |
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 Local 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.
|
Once the PS script generation type is selected, Content Matrix Console will generate a PS script for the select Job, which will be written to a Microsoft Notepad file. If multiple jobs are selected they will all be written to the same file.
4.Choose File > Save As... and select any desired save location for the PowerShell script. Give the file any name you want, but change the file type to .PS1.
The PowerShell (PS) script itself contains five sections. They are:
·Section 1 - This first section at the top (starting with an "if" statement) runs a check in the PowerShell console to make sure that the Metalogix snap-ins have been added. If they are not found then it will add them to that instance of the PS console.
·Section 2 - Load Configuration settings - This section will find and load all of the Metalogix Content Matrix client application configuration settings into the PowerShell script. These are the client application's environmental settings and not the migration/action settings.
·Section 3 - Load source - This section will load all of the data for the source environment connection.
·Section 4 - Load target - Similar to the previous section, this will load target environment's connection information.
·Section 5 - Run the action - Last is the "Run the action" section. This last section will contain all of the other data for the migration, such as the type of migration (i.e. a site migration, list migration, item migration, etc.) and all of the settings and configurations for the migration/action that is being run. This includes things like settings for versions, content types, permissions, etc.
Navigation: Saving or Running a Migration Job > Creating and Running a PowerShell Script from the Jobs List > Running a PowerShell Script |
Once a PowerShell script has been created, you can run it from the PowerShell console.
To run the PowerShell script:
NOTES:
· If you have more than one edition of Content Matrix, only one edition can be run per PowerShell session.
·If Content Matrix settings or a connection to a Distributed Database is changed, in order to apply new settings all PowerShell sessions must be restarted.
To add the PowerShell cmdlets for the application framework:
1.Open a Powershell ISE or PowerShell console session.
2.Add the PowerShell snap-ins by pasting in the following text:
if ( $PsVersionTable.PSVersion.Major -lt 3 ) { Write-Host "Windows PowerShell Version 3.0 or later needs to be installed in order to run Content Matrix PowerShell scripts."; exit; }
if ( (Get-PSSnapin -Name Metalogix.System.Commands -ErrorAction SilentlyContinue) -eq $null ) { add-pssnapin Metalogix.System.Commands | out-null }
if ( (Get-PSSnapin -Name Metalogix.SharePoint.Commands -ErrorAction SilentlyContinue) -eq $null ) { add-pssnapin Metalogix.SharePoint.Commands | out-null }
if (Get-Command Set-MetalogixJobPrerequisites -ErrorAction SilentlyContinue){ Set-MetalogixJobPrerequisites -Value "Content Matrix Console - SharePoint Edition" }
2.Set the directory to the location where the PowerShell script is located.
3.Enter the name and extension of the PowerShell Script (at its specified location), and the script will run.
In the case that you are running a script from the same directory you would use the format: .\[ScriptName].ps1. So if your PowerShell scrip was named "ResourceScript.ps1" then you would enter: .\ResourceScript.ps1 into the window, and the script would run.
If the script is in a different directory, you would enter the location of that directory relative to your current location, followed by the script name. For example, if your prompt is at the "C:\" drive and your PowerShell script, named "ResourceScript.ps1" is on the desktop you would enter: C:\Users\[User]\Desktop\ResourceScript.ps1, and the script would run.
NOTE: In some cases the Execution Policy may prevent you from running a PowerShell script. In this case you will likely see the 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, running the command: set-executionpolicy RemoteSigned should change the existing script policy to allow you to run these scripts for your location. It is advised that you check with your System Administrators before doing this to ensure that no Company Policies are being broken by this action. If this is an action you need to take, you should only need to run this command once.
The migration will begin, and any warnings and/or errors that are encountered in running the script will be displayed in the PowerShell window.
© 2024 Quest Software Inc. ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center