Migration Properties

This topic describes the properties that are used by migration tasks during WebSphere Portal migration. Note that the specific properties that are required for migration can vary depending on how you are deploying WebSphere Portal and its related components. Refer to the installation instructions for each component for information on which properties set.

The properties files mig_core.properties and mig_wmm.properties are located in the <wp5_root>/migration directory. The following additional files are also required for migration.

  • The <wpprev_root>/wps.properties file supplies version information about your WebSphere Portal environment to various migration tasks. This file must be accessible via either a mapped drive or by copying the file to the migration directory of the 5.1 server.

  • The <wp_root>/config/wpconfig.properties file supplies configuration information about your WebSphere Portal V5.1 environment to various migration tasks. If you are running migration tasks from a directory other than <wp5_root>/migration, copy this file to the migration directory manually.

Notes on setting values in properties files:

  • Do not enclose values in quotation marks.

  • When specifying path information, always use forward slashes (/) to separate elements in the path, instead of back slashes (\), even if you are installing in a Windows environment.

  • Long file names can be used in Windows environments.

Notes on loading sequence of properties by migration tasks:

  • After a property is set during task startup, its value cannot be overridden. The precedence order for setting properties is as follows, from highest precedence to lowest precedence:

    • Properties set on the command line when the migration task is launched (using the -D<property>=<value> option, where <property> indicates a specific property that will be used by the task, and <value> indicates the value of a specific property that will be used by the task)

    • If available, properties set in the file pointed to by the parentProperties parameter
      • Properties set in the mig_core.properties and mig_wmm.properties files

    • If available, properties set in the file pointed to by the childProperties parameter

    • Properties set in the mig_driver.xml file

Password considerations:

    For security reasons, not store passwords in the wpconfig.properties file. It is recommended that you edit the wpconfig.properties prior to running a configuration task, inserting the passwords needed for that task. Then, after the task has run, delete all passwords from the wpconfig.properties file. For more information, see Delete passwords.

    Alternatively, you can specify the password on the command line using the following syntax:

      WPSconfig.{sh|bat} task_name -Dpassword_property_key= password_value

    As with other properties, each password property must have the -D prefix and be set equal to (=) a value. If you have multiple properties in a single command, use a space character between each -Dproperty=value setting.

Migration requires that you edit a properties file with values that are unique to your environment. For detailed information on working with properties files, see Configuration properties reference.

Core migration properties
Property Value
PrevWpsHostName

Description: The fully qualified host.name of the previous Portal. This property is required.

Value type: Host name

Example: yourhost.domain.com

Default Value: None

PrevWpsPort

Description: The port number that is assigned to the previous Portal. This property is required.

Value type: Numeric text string

Example: 80

Default Value: None

PrevWpsContextRoot

Description: The base URI for the previous Portal. This property is required.

Value type: Path name

Example: wps is the context root of <hostname>/wps/portal

Default Value: None

PrevWpsDefaultHome

Description: The default home for the previous Portal. This property is required.

Value type: Path name

Example: portal is the default home of <hostname>/wps/portal

Default Value: None

PrevPortalAdminId

Description: The previous Portal administrator user ID. This property is required.

Value type: Alphanumeric text string

Example: wpsadmin

Default Value: None

PrevPortalAdminPwd

Description: The previous Portal administrator password for the administrator user ID. This property is required.

Value type: Alphanumeric text string

Default Value: None

ScriptPath

Description: The name of the path, including subdirectories, to search for the WebSphere Portal V4.x XML configuration interface file to be converted. Supply a value for this property only if you are planning to use the task migrate-xmlaccess-scripts.

Value type: Path name

Default Value: None

ScriptSrc

Description: The file name of the WebSphere Portal V4.x XML configuration interface file to be migrated. Supply a value for this property only if you are planning to use the task migrate-xmlaccess-scripts.

Value type: XML file name

Default Value: None

ScriptDest

Description: The file name of the migrated WebSphere Portal XML configuration interface file. Supply a value for this property only if you are planning to use the task migrate-xmlaccess-scripts.

Value type: XML file name

Default Value: None

PrevWpsInstallLocation

Description: The location of the previous WPS Install root directory, if accessible. If this value is left blank, a wps.properties file from the the previous Portal system to be migrated should be copied to the migration directory.

Value type: Path name

Example: /usr/WebSphere/PortalServer

Default Value: None

appsPath

Description: The path where portlet application WAR files reside. This path will be used to update existing location of WAR files in previous versions of WebSphere Portal export so that the portlet applications are installed during the import step and should be accessible from the WebSphere Portal version to which you are migrating.

Value type: Path name

Example: <win platform> C:/WebSphere/PortalServer/install/<unix> /opt/WebSphere/PortalServer/install

Default Value: //localhost/$server_root$/installableApps

This translates to <wp5_Install_Root>/installableApps

If you want to use the default, leave the appsPath commented out below and copy the WAR files for your upgraded portlets to <wp5_Install_Root>/installableApps. This directory has the sample applications supplied by WebSphere Portal 5.0, so if you had these samples deployed on the previous Portal, do not overwrite the existing files. This will allow migration to automatically pickup newer versions of samples shipped with WebSphere Portal 5.0.

deployPages

Description: This property determines if all pages used by places would also be migrated or exported. Set to true to export all pages.

Value type: true, false

Default Value: true

deployApps

Description: This property determines if all portlet applications used by pages would also be migrated or exported. Set to true to export all portlet applications.

Value type: true, false

Default Value: true

configThemesSkins

Description: This property determines if configuration information for all themes and skins used on the exported pages would also be migrated/exported. Set to true to migrate/export all themes and skins configuration information.

Value type: true, false

Default Value: true

useEditor

Description: Specifies which role should be used for users who possess EDIT and DELEGATE permissions. True signifies that the Editor role should be used; false signifies that the Privileged User role should be used. If the Editor role is selected for users having EDIT and DELEGATE permissions, these users will not be able to see the implicitly derived pages (user customizations) after migration.

Value type: true, false

Default Value: false

convertAccessControl

Description: This property determines whether access control form Pages, Places, Portlet Application, and Portlets WP4 will be migrated. False indicates that the access control will not be migrated. V5.0.2.0 users who set this value to false should upgrade to V5.0.2.1.

Value type: true, false

Default Value: true

omitExternalAccessControl

Description: Determines whether the migration process will automatically migrate access control that was externalized in WebSphere Portal V4.x. If this value is set to true, the migration process does not migrate access control for resources that were externalized in WebSphere Portal V4.x. hen the value is set to false, the access control information is migrated. Additionally, if the value is set to false and you are using V5.0.2.0, upgrade to V5.0.2.1.

Value type: true,false

Default Value: true

includeClients

Description: Comma-separated names of clients to be included in the task processing.

For important information on using this property, see the migrate-clients section in the Migration Tasks topic.

Value type: Comma-separated list of objectids.

Default Value: None

excludeClients

Description: Comma-separated names of clients to be excluded from the task processing.

For important information on using this property, see the migrate-clients section in the Migration Tasks topic.

Value type: Comma-separated list of objectids.

Default Value: None

includePlaces

Description: Comma-separated names of places to be included in the task processing.

Value type: Comma-separated list of file names.

Default Value: None

excludePlaces

Description: Comma-separated names of places to be excluded in the task processing.

Value type: Comma-separated list of file names.

Default Value: None

includePages

Description: Comma-separated names of pages to be included in the task processing. When migrating from V5.0, specify each pages uniquename attribute instead of the page name.

For important information on using this property, see the migrate-pages section in the Migration Tasks topic.

Value type: Comma-separated list of file names.

Default Value: None

When you use filtering to include pages on a V5.0 source server, you must include all pages underneath a container page. To do this without specifying every page, create uniquenames for the pages on the old server, as in this example: 

Container Page -- wps.Page1
Child Page 1 -- wps.Page1.child1 -> child of this page  wps.Page1.child1.grandchild1
Child Page 2 -- wps.Page1.child2

You can then specify wps.Page1.* on the includePages and migrate all of the pages underneath the container page.

excludePages

Description: Comma-separated names of pages to be excluded from the task processing. When migrating from V5.0, specify each pages uniquename attribute instead of the page name.

For important information on using this property, see the migrate-pages section in the Migration Tasks topic.

Value type: Comma-separated list of file names.

Default Value: None

When you use filtering to exclude pages on a V5.0 source server, you must exclude all pages underneath a container page. To do this without specifying every page, create uniquenames for the pages on the old server, as in this example: 

Container Page -- wps.Page1
Child Page 1 -- wps.Page1.child1 -> child of this page  wps.Page1.child1.grandchild1
Child Page 2 -- wps.Page1.child2

You can then specify wps.Page1.* on the excludePages and exclude all of the pages underneath the container page.

includeThemes

Description: Comma-separated names of themes to be included in the task processing. When migrating from V5.0, specify each themes uniquename attribute instead of the page name.

For important information on using this property, see the migrate-themes-skins-configs section in the Migration Tasks topic.

Value type: Comma-separated list of file names.

Default Value: None

excludeThemes

Description: Comma-separated names of themes to be excluded from the task processing. When migrating from V5.0, specify each themes uniquename attribute instead of the page name.

For important information on using this property, see the migrate-themes-skins-configs section in the Migration Tasks topic.

Value type: Comma-separated list of file names.

Default Value: None

includeApps

Description: Comma-separated names of portlet applications to be included in the task processing. When migrating from V5.0, specify each web-apps uniquename attribute instead of the page name.

For important information on using this property, see the migrate-apps section in the Migration Tasks topic.

Value type: Comma-separated list of file names.

Default Value: None

excludeApps

Description: Comma-separated names of portlet applications to be excluded from the task processing. When migrating from V5.0, specify each web-apps uniquename attribute instead of the page name.

For important information on using this property, see the migrate-apps section in the Migration Tasks topic.

Value type: Comma-separated list of file names.

Default Value: None

filenameUserGroupsAcOut

Value type: XML file name

Default Value: usergroupacout.xml

filenameCredentialSlotsSegments

Description: File name to use when exporting credential vault slots from previous versions of WebSphere Portal and importing them to WebSphere Portal V5.1.

Value type: XML file name

Default Value: credentialslotssegmentsout.xml

filenameClients

Description: File name to use during export from previous versions of WebSphere Portal and import to WebSphere Portal V5.1.

Value type: XML file name

Default Value: clientsout.xml

filenameNotesPortlets

Description: File name to use during export from previous versions of WebSphere Portal and import to WebSphere Portal V5.1.

Value type: XML file name

Default Value: notesportletsout.xml

filenamePlaces

Description: File name to use during export from previous versions of WebSphere Portal and import to WebSphere Portal V5.1.

Value type: XML file name

Default Value: placesout.xml

filenameUserPages

Description: File name to use during export from previous versions of WebSphere Portal and import to WebSphere Portal V5.1.

Value type: XML file name

Default Value: userpagesout.xml

filenameThemes

Description: File name to use during export from previous versions of WebSphere Portal and import to WebSphere Portal V5.1.

Value type: XML file name

Default Value: themesout.xml

filenameApps

Description: File name to use during export from previous versions of WebSphere Portal and import to WebSphere Portal V5.1.

Value type: XML file name

Default Value: appsout.xml

filenamePortletsConfigs

Description: File name to use during export from previous versions of WebSphere Portal and import to WebSphere Portal V5.1.

Value type: XML file name

Default Value: portletsconfigsout.xml

filenamePages

Description: File name to use during export from previous versions of WebSphere Portal and import to WebSphere Portal V5.1.

Value type: XML file name

Default Value: pagesout.xml

pathUpgradedThemesSkins

Description: The file system path that contains the upgraded themes and skins to be copied to WebSphere Portal V5.1 system. If provided, the migrate-themes-skins-configs and import-themes-skins-configs tasks will copy necessary files from subdirectory themes and skins under the path pointed to by the pathUpgradedThemesSkins parameter.

Value type: System path name

Example: /usr/wp5_dev

This example assumes that your upgraded themes and skins are in /usr/wp5_dev/themes and /usr/wp5_dev/skins

Default Value: None

 

 

Member Manager migration properties
Property Value
WmsDbName

Description: The WebSphere Member Services database name.

Value type: Database name

Example: wms

Default Value: wmsdb

WmsDbUrl

Description: The WebSphere Member Services database JDBC URL. If this database is on a remote database server, it must be cataloged locally.

Value type: Alphanumeric URL

Example: jdbc:db2:wms

The following values can be specified:

  • DB2: jdbc:db2:wms4

  • DB2/zOS: jdbc:db2:WMS4

  • Oracle: jdbc:oracle:thin:@linsuse2:1521:ora901

  • SQL Server: jdbc:microsoft:sqlserver://wps19:1433;DatabaseName=wms4

Default Value: None

WmsDbUser

Description: The user ID of the WebSphere Member Services database user.

Value type: Alphanumeric text string

Example: db2inst1

Default Value: None

WmsDbPassword

Description: The password for the WebSphere Member Services database user ID.

Value type: Alphanumeric text string

Example: db2inst1

Default Value: None

WmmConfigType

Description: The user registry type for Member Manager.

Value type: Numeric - 1, 2, 3 (DB=1, LDAP+LA=2, DB(Dev mode)=3)

Default Value: None

WmmUuid

Description: The repository unique identifier. This value can be found in the file wmm.xml as "UUID" in the <WP5>/shared/app/wmm directory.

Value type: Alphanumeric text string

Default Value: None

DbAdminUser

Description: This property is required for UNIX/Linux platforms only: Specifies the user with administrative privileges to the database server.

Value type: Alphanumeric text string

Default Value: None

Db2Home

Description: This property is required for DB2 Only: Root installation directory of DB2

Value type: Alphanumeric text string

Examples:

  • Windows: c:/ibm/sqllib

  • UNIX: /home/db2inst1/sqllib

Default Value: None

WmmDbOwner

Description: This property is required for SQL server only: The user that owns the Member Manager schema

Value type: Alphanumeric text string

Default Value: dbo

LdapHasUuid

Description: This property indicates whether or not the LDAP server has a unique user ID.

Value type: true, false

Default Value: None

LdapUuidName

Description: The name of the attribute in the LDAP server storing the unique user ID. If you do not have an existing attribute in LDAP to store a unique user ID (LdapHasUuid must be set to false in this case), manually create it and link it to the LDAP auxiliary object. Also, after creating the auxiliary object class, assign the attribute unique user ID that was created above to the object class.

Value type: Alphanumeric text string

Example: Create an attribute called ibm-appUUID

Default Value: None

LdapAuxiliaryClassName

Description: This property is required only if WmmConfigType=2 and LdapHasUuid=false. Creates an auxiliary object class in the LDAP server and specifies the name of the auxiliary object class.

Value type: Alphanumeric text string

Example: ibm-appUUIDAux

Default Value: None

wps4DbLibrary

Description: This property is required only if WmmConfigType=3: The directory and name of the zip file containing the db.driver class.

Value type: Alphanumeric database URL

Example: The following values can be specified:

  • DB2: <SQLLIB>/java/db2java.zip

  • DB2/zOS: <SQLLIB>/java/db2java.zip

  • Oracle: <Oracle>/jdbc/lib/classes12.zip

  • SQL Server:

    <SQLServerJDBC>/lib/mssqlserver.jar;<SQLServerJDBC>/lib/msbase.jar; <SQLServerJDBC>/lib/msutil.jar

Default Value: None

wps4DbDriver

Description: This property is required only if WmmConfigType=3: The WebSphere Portal JDBC driver class name used to access the database over JDBC (also known as the JDBC provider).

Value type: Alphanumeric database name

Example: COM.ibm.db2.jdbc.net.DB2Driver

The following values can be specified:

  • DB2: COM.ibm.db2.jdbc.net.DB2Driver

  • DB2/zOS: COM.ibm.db2.jdbc.app.DB2Driver

  • Oracle: oracle.jdbc.driver.OracleDriver

  • SQL Server:com.microsoft.jdbc.sqlserver.SQLServerDriver

Default Value: None

wps4DbUrl

Description: This property is required only if WmmConfigType=3: The WebSphere Portal V4.x database JDBC URL.

Value type: Alphanumeric database URL

Example: jdbc:db2:wps4 The following values can be specified:

  • DB2: jdbc:db2:WPS4

  • DB2/zOS: jdbc:db2:WPS4

  • Oracle: jdbc:oracle:thin:@wps19:1521:wps4

  • SQL Server:jdbc:microsoft:sqlserver://wps19:1433;DatabaseName=wps4

Default Value: None

wps4DbUser

Description: This property is required only if WmmConfigType=3: The WebSphere Portal 4.x database user.

Value type: Alphanumeric text string

Default Value: None

wps4DbPassword

Description: Required only if WmmConfigType=3: The WebSphere Portal V5.1 database password.

Value type: Alphanumeric text string

Default Value: None

wmmTraceEnabled

Description: This optional property determines whether tracing is enabled.

Value type: true, false

Default Value: false

wmmReportSqlError

Description: This property determines whether SQL error tracing is enabled.

Value type: true, false

Default Value: false

See also