Run the migration tasks

1: Introduction

2: Using the migration tasks

3: Using the include and exclude parameters

 

1: Introduction

This section guides you through running the migration tasks for WebSphere Portal V5.1. The tasks that you run vary depending on how previous versions (such as WebSphere Portal V4.x or 5.0.x) are configured. It is possible to install WebSphere Portal V5.1 on a machine that contains a previous version of WebSphere Portal. However, when both versions are installed on the same machine, resource limitations might prohibit them from running at the same time. If you do not have the resources to run both versions on the same machine, skip starting WebSphere Portal V5.1 and perform the migration tasks through two distinct steps - export and import.

  • Export steps must be completed while the previous version is running.

  • Import steps must be accomplished by stopping the previous version, starting V5.1, and then importing the data.

Notes:

  • Run a previous version of WebSphere Portal and WebSphere Portal V5.1 at the same time does not mean that both versions are located on the same physical machine. You can have both versions installed on the same machine or on different machines, and have them running or not running at the same time. For example, you could have WebSphere Portal V4.x installed on one physical machine and WebSphere Portal V5.1 installed on another, and still choose the "both systems running" scenario.

  • Note the following information:

    • When text in this section states that both WebSphere Portal versions are running, this means that both the previous and new version of WebSphere Portal are up and running.

    • When text in this section states that only one WebSphere Portal version running, this means that the previous version of the server must be running in order to do the export steps and the 5.1 Portal must be running in order to execute the import steps.

The following table displays all of the migration tasks. The first row shows the two possible WebSphere Portal setup scenarios that were discussed in the previous paragraph; the second row lists the three tasks that run other tasks behind the scenes; the third row lists the tasks that are run by the tasks in the second row.

Both WebSphere Portal versions running Only one WebSphere Portal version running
migrate-all export-all import-all
export-all

import-all

export-user-groups-ac

export-virtual-resources (v5 source only)

export-credential-slots-segments

export-clients

export-notes-portlets

export-wsrp-portlets

export-places

export-pages (v5 source only)

export-user-customizations

migrate-wmm

import-user-groups-ac

import-virtual-resources (v5 source only)

import-credential-slots-segments

import-clients

import-notes-portlets

import-wsrp-portlets

import-places (v4 source only)

import-pages (v5 source only)

import-user-customizations

optimize-roles (v4 source only)

You can also choose to run the migration tasks that are listed in the third row one at a time or by running the migrate-all or import-all and export-all tasks, which run all the other tasks without breaks.

For more information, see the Migration tasks reference.

 

2: Using the migration tasks

The WebSphere Portal migration package provides two primary script files that you can use to invoke the migration tasks:

  • Windows: WPmigrate.bat

  • UNIX: WPmigrate.sh

You can run these scripts from the <wp51_root>/migration directory, where <wp51_root> is the directory in which WebSphere Portal V5.1 is installed.

The syntax for invoking a migration task is as follows:

  • Windows: WPmigrate.bat <task_name> -D <property>=<value>

  • UNIX: ./WPmigrate.sh <task_name> -D <property>=<value>
where:

  • <task_name> indicates the migration task that you want to run

  • <property> indicates a specific property that will be used by the task

  • <value> indicates the value of a specific property that will be used by the task

For example, to invoke the migration task that exports a place named SuperPlace from an existing WebSphere Portal V4.x or V5.0 system and saves the exported data to a file called SuperPlaceOut.xml, you would enter the following command on one line:

  • Windows: WPmigrate.bat export-places -DincludePlaces=SuperPlace -DfilenamePlaces=SuperPlaceOut.xml

  • UNIX: ./WPmigrate.sh export-places -DincludePlaces=SuperPlace -DfilenamePlaces=SuperPlaceOut.xml

For more information on the migration tasks, refer to the Migration tasks reference. For more information on the migration properties, refer to the Migration properties reference.

 

3: Using the include and exclude parameters

Many of the migration tasks provide parameters that begin with the words "include" and "exclude." For example, the migrate-places task provides the parameters includePlaces and excludePlaces. The optional include and exclude parameters offer a flexible way to limit the scope of migration for the tasks that support them. The include and exclude parameters take a comma-separated list of case-sensitive values. A wildcard character (*) can also be used within each value. If an exact match is found using the include parameter, the exclude parameter is ignored. See the following examples for clarification.

Example 1: These commands will migrate all places that are defined in a previous version of WebSphere Portal

  • Windows: WPmigrate.bat migrate-places

  • UNIX: ./WPmigrate.sh migrate-places

Example 2: These commands will migrate a place named My Place.

  • Windows: WPmigrate.bat migrate-places -DincludePlaces="My Place"

  • UNIX: ./WPmigrate.sh migrate-places -DincludePlaces="My Place"

Example 3: These commands will migrate all places except for the place named My Place.

  • Windows: WPmigrate.bat migrate-places -DexcludePlaces="My Place"

  • UNIX: ./WPmigrate.sh migrate-places -DexcludePlaces="My Place"

Example 4: These commands will migrate two places named My Place and My Test Place.

  • Windows: WPmigrate.bat migrate-places -DincludePlaces="My Place,My Test Place"

  • UNIX: Unix: ./WPmigrate.sh migrate-places -DincludePlaces="My Place,My Test Place"

Example 5: These commands will migrate all places that have names beginning with the letters "My".

  • Windows: WPmigrate.bat migrate-places -DincludePlaces="My*"

  • UNIX: ./WPmigrate.sh migrate-places -DincludePlaces="My*"

Example 6: These commands will migrate all places that have names beginning with the letters "My" except for the place named My Test Place.

  • Windows: WPmigrate.bat migrate-places -DincludePlaces="My*" -DexcludePlaces="My Test Place"

  • UNIX: ./WPmigrate.sh migrate-places -DincludePlaces="My*" -DexcludePlaces="My Test Place"

Example 7: These commands will migrate all places that have names beginning with the words "test" and "My Test Place". Note that even though the exclude parameter indicates that all places beginning with the words "My" should be excluded, the place called My Test Place will be migrated since the include parameter does not include the wildcard character (*) when specifying "My Test Place".

  • Windows: WPmigrate.bat migrate-places -DincludePlaces="test*,My Test Place" -DexcludePlaces="My*"

  • UNIX: ./WPmigrate.sh migrate-places -DincludePlaces="test*,My Test Place" -DexcludePlaces="My*"

Example 8: These commands will migrate all of the pages from a v5x source server with the exception of "wps.Page1".

  • Windows: WPmigrate.bat migrate-pages -DexcludePages="wps.Page1"

  • UNIX: ./WPmigrate.sh migrate-pages -DexcludePages="wps.Page1"

 

Next steps

You have completed this procedure. Continue to the next step by choosing one of the following topics:

 

WebSphere is a trademark of the IBM Corporation in the United States, other countries, or both.

 

IBM is a trademark of the IBM Corporation in the United States, other countries, or both.