Sun ONE Portal Server 6.0 Migration Guide: Appendix A Tool Design

Previous Contents Index Next

Sun ONE Portal Server 6.0 Migration Guide

Appendix A     Tool Design

Note All instances of the Sun™ ONE Portal Server 3.0 product refer to what were formerly known as the iPlanet™ Portal Server 3.0, Service Pack 3a and iPlanet™ Portal Server 3.0, Service Pack 4 products.

This appendix includes information, options or parameters, and usage information for the Sun ONE Portal Server 3.0 Data Migration Tool Suite and the Sun™ ONE Compass Server Migration Tools. This appendix contains the following sections:

Sun ONE Portal Server 3.0 Data Migration Tool Suite

Flow of Sun ONE Portal Server 3.0 Data Migration Tool Suite

Sun ONE Compass Server Migration Tools

Sun ONE Portal Server 3.0 Data Migration Tool Suite

This section provides the tool design for the export, conversion, and import tools used to migrate from Sun ONE Portal Server 3.0 to Sun ONE Portal Server 6.0.

Export Tool Design

Synopsis
./exportps [-a] [-p LDAP passphrase] [ExportDir]

Description
The export tool copies the following Sun ONE Portal Server 3.0 components to a directory or a .tar file:

Templates

JSPs

Resource bundles

LDIF dump of the LDAP database

XML exports of domains, roles and components

Options
Table A-1 describes the options available for the exportps command. This two-column table lists the options in the first column and their descriptions in the second column.

Table A-1    Options for the exportps command

Option

Description

-a

Runs all modules without a menu.
To see the export menu, do not use the -a option.

-p LDAP passphrase

Sets the LDAP passphrase in order to avoid the LDAP passphrase prompt. If you do not use the -p LDAP passphrase option, the tool will prompt you for the LDAP passphrase.

ExportDir

Specifies the directory where the information is to be saved. If you do not use the ExportDir option, the tool prompts you for the export directory.

Usage
If you run the exportps command without the ExportDir option, the script exports the data to /tmp/psExport. In addition to the options listed in the Options section, you can also get help and version information by issuing the following commands:

./exportps --help

This command gives the following output:

exportps is used to save an iPlanet Portal Server 3.0

(Service Pack 3a or 4) system to disk

USAGE

exportps [-a] [-p <passphrase>] [<directory>]

OPTIONS

-a Export all modules (no menu)

-p <passphrase> Set LDAP root DN passphrase

<directory> where <directory> is place to save exported data

./exportps --version

This command gives the following output:

Name: Portal Server export utility

Version: 6.0

Product: Portal Server, Hana release

Legal-notices:

Copyright 2002 Sun Microsystems, Inc. All rights reserved.

PROPRIETARY/CONFIDENTIAL. Use of this product is subject to license terms.

Conversion Tool Design

Synopsis
./convertps [-a] [-f] [-i ExportDir] [-o ImportDir]

Description
The results of the convertps command are converted to files to be used by the importps command for loading Sun ONE Portal Server 3.0 customizations into Sun ONE Portal Server 6.0.

Options
Table A-2 describes the options available for the convertps command. This two-column table lists the options in the first column and their descriptions in the second column.

Table A-2    Options for the convertps command

Option

Description

-a

Runs all modules without a menu.
To see the conversion menu, do not use the -a option.

-f

Converts Sun ONE Portal Server 3.0 roles to iPlanet Directory Server Access Management Edition 5.1 roles and places users under the organization. This option retains the multiple role to user assignment similar to Sun ONE Portal Server 3.0, but does not retain the hierarchical role functionality. All roles are created under the organization and are not prioritized. The display profile documents are prioritized and merged accordingly. To see if the roles have been migrated to roles, view the roles under the organization in the admin console.
If you do not use the -f option, the conversion tool converts Sun ONE Portal Server 3.0 roles to iPlanet Directory Server Access Management Edition 5.1 suborganizations and places users under the suborganization. Without the -f option, the conversion tool retains the hierarchical functionality and customizations from Sun ONE Portal Server 3.0. The disadvantage is that it is difficult to move users from one suborganization to another. To see if the roles have been migrated to suborganizations, view the hierarchy in the admin console.

-i ExportDir

Specifies the input directory for the conversion. The input directory is the directory which contains the exported data created by the export tool. The conversion tool searches for export data in /tmp/psExport unless you specify a different input directory using the -i ExportDir option.
If you specify a directory which does not contain data exported with the export tool, the conversion tool notifies you that the directory does not have export data and prompts you to enter a valid export directory.

-o ImportDir

Specifies the output directory for the conversion tool. The output directory is the directory used by the import tool.
If you choose an import directory which already contains converted data, the conversion tool notifies you that modifying an existing migration may render import data unusable and prompts you to delete the import directory.

Usage
If you run the convertps command without the -i ExportDir and -o ImportDir options, the conversion tool will check for the /tmp/ipsExport directory. If the tool finds valid exported data, it will store the converted data in /tmp/psImport. In addition to the options listed in the Options section, you can also get help and version information by issuing the following commands:

./convertps --help

This command gives the following output:

convertps is used to migrate iPlanet Portal Server 3.0

(Service Pack 3a or 4) data to files that can be uploaded into

a Portal Server 6.0 system

OPTIONS

-a Convert all modules (no menu)

-f Converts roles to roles, instead of roles to sub-organizations

-i <directory> where <directory> is iPS export directory

-o <directory> where <directory> is place to save migrated files

for future upload using importps

./convertps --version

This command gives the following output:

Name: Portal Server conversion utility

Version: 6.0

Product: Portal Server, Hana release

Legal-notices:

Copyright 2002 Sun Microsystems, Inc. All rights reserved.

PROPRIETARY/CONFIDENTIAL. Use of this product is subject to license terms.

Import Tool Design

Synopsis
./importps [-a] [-k] [-m] [ImportDir]

Description
The import tool imports into the Sun ONE Portal Server 6.0 system the data converted with the conversion tool.

Options
Table A-3 describes the options available for the importps command. This two-column table lists the options in the first column and their descriptions in the second column.

Table A-3    Options for the importps command

Option

Description

-a

Runs all modules without a menu.
To see the import menu, do not use the -a option.

-k

Specifies that the tool does not overwrite existing users.
When you run importps without the -k option, if it encounters a conflict with an existing user, it will delete the existing user and import the new user entry defined in ImportDir/ldap/user.ldif.
If you run importps -k, if it encounters a conflict with an existing user, it leaves the existing user and places the rejected user entry in ImportDir/ldap/rejected_users.ldif.
If the user has a display profile document in the ImportDir/dp/user/ directory, the display profile file may change. The -k option does not affect importing user display profile documents. The -k option only affects whether an existing LDAP user's LDIF record is updated. The updates to the LDIF record include everything except display profile updates.

-m

Merges display profile documents.
When you run importps without the -m option, it overwrites any existing display profile documents it finds. This means that the root suffix, organization, suborganization, and user level display profile documents, if they exist, are overwritten.
If you run importps -m, when the tool encounters a conflict with an existing display profile document it will merge it.

ImportDir

Specifies the directory where the converted data is located. If the directory does not exist or if the directory does not contain valid converted data, the import tool prompts you to enter a directory containing the converted data to be imported. If you do not specify an import directory, the import tool will search /tmp/psImport.

Usage
If you run the importps command without the ImportDir option, the script looks in /tmp/psImport for converted data. In addition to the options listed in the Options section, you can also get help and version information by issuing the following commands:

./importps --help

This command gives the following output:

importps is used to upload converted iPlanet Portal Server

3.0 (Service Pack 3a or 4) customizations into Portal Server 6.0

USAGE

importps [-a] [-k] [-m] [<directory>]

OPTIONS

-a Import all modules (no menu)

-k Do not overwrite existing users

-m Merge display profile documents

<directory> where <directory> is location of converted data

./importps --version

Name: Portal Server import utility

Version: 6.0

Product: Portal Server, Hana release

Legal-notices:

Copyright 2002 Sun Microsystems, Inc. All rights reserved.

PROPRIETARY/CONFIDENTIAL. Use of this product is subject to license terms.

Flow of Sun ONE Portal Server 3.0 Data Migration Tool Suite

Export Tool
The export tool adds to ExportDir/templates.tar:

/etc/opt/SUNWips/desktop/

changed files in /etc/opt/SUNWips/auth/

BaseDir/SUNWips/locale/

BaseDir/SUNWips/public_html except for admin, launch.html, netlet, banner.html, index.html, netfile, netmail, and third_party

files with fully-qualified path names listed in BaseDir/SUNWps/migration/modules/desktop/migrate_files.txt

Conversion Tool
The conversion tool:

extracts ExportDir/templates.tar into /tmp/.temp_desktop/exportData/

does the conversion of templates, JSPs, and resource bundles in /tmp/.temp_desktop/exportData/

saves converted data in /tmp/.temp_desktop/importData/

adds to ImportDir/desktop.tar the contents of /tmp/.temp_desktop/importData/desktop/

adds to ImportDir/locale.tar the contents of /tmp/.temp_desktop/importData/locale/

adds to ImportDir/auth.tar the contents of /tmp/.temp_desktop/importData/auth/

adds to ImportDir/public_html.tar the contents of /tmp/.temp_desktop/importData/public_html/

removes the directory /tmp/.temp_desktop/

automatically extracts the files and directories added by migrate_files.txt as long as they are fully qualified pathnames.

Import Tool
The import tool:

extracts ImportDir/desktop.tar into /etc/opt/SUNWps/desktop/

extracts ImportDir/auth.tar into BaseDir/SUNWam/web-apps/services/WEB-INF/config/auth/default/

extracts ImportDir/locale.tar into BaseDir/SUNWps/web-src/WEB-INF/classes

extracts ImportDir/public_html.tar into BaseDir/SUNWam/public_html

Sun ONE Compass Server Migration Tools

This section provides the tool design for the export and import tools used to migrate Sun™ ONE Compass Server 3.01C, Service Pack 1 or later to Sun ONE Portal Server 6.0.

Sun ONE Compass Server Export Tool Design

Synopsis
perl./export.pl [-o ExportDir] [-i Target_InstanceDir]

Description
The Sun ONE Compass Server export tool exports data from Sun ONE Compass Server 3.01C, Service Pack 1 and later to the Sun ONE Portal Server 6.0 system.

Parameters
Table A-4 shows the parameters and their descriptions for the export.pl script.

Table A-4    Parameters and descriptions for the export.pl script

Parameter

Description

-o Exportdir

Specifies the directory where the exported data is to be saved.

-i Target_InstanceDir

Specifies the directory for the target instance to be exported.

Usage
If you do not specify any parameters, the Sun ONE Compass Server export tool will export all instances to the current directory.

Sun ONE Compass Server Import Tool Design

Synopsis
perl./import.pl [-o Target_InstanceDir] [-i Source_InstanceDir] [-p Portal_InstallDir]

Description
The Sun ONE Compass Server import tool imports the Sun ONE Compass Server 3.01C, Service Pack 1 or later data exported with the export.pl script into Sun ONE Portal Server 6.0.

Parameters
Table A-5 shows the parameters and their descriptions for the export.pl script.

Table A-5    Parameters and descriptions for the import.pl script

Parameter

Description

-o Target_InstanceDir

Specifies the directory of the Sun ONE Portal Server 6.0 Search root.

-i Source_InstanceDir

Specifies the directory of the Sun ONE Compass Server 3.01C, Service Pack 1 or later instance.

-p Portal_InstallDir

Specifies the directory of the Sun ONE Portal Server 6.0 installation.

Option	Description
-a	Runs all modules without a menu. To see the export menu, do not use the -a option.
-p LDAP passphrase	Sets the LDAP passphrase in order to avoid the LDAP passphrase prompt. If you do not use the -p LDAP passphrase option, the tool will prompt you for the LDAP passphrase.
ExportDir	Specifies the directory where the information is to be saved. If you do not use the ExportDir option, the tool prompts you for the export directory.

Option	Description
-a	Runs all modules without a menu. To see the conversion menu, do not use the -a option.
-f	Converts Sun ONE Portal Server 3.0 roles to iPlanet Directory Server Access Management Edition 5.1 roles and places users under the organization. This option retains the multiple role to user assignment similar to Sun ONE Portal Server 3.0, but does not retain the hierarchical role functionality. All roles are created under the organization and are not prioritized. The display profile documents are prioritized and merged accordingly. To see if the roles have been migrated to roles, view the roles under the organization in the admin console. If you do not use the -f option, the conversion tool converts Sun ONE Portal Server 3.0 roles to iPlanet Directory Server Access Management Edition 5.1 suborganizations and places users under the suborganization. Without the -f option, the conversion tool retains the hierarchical functionality and customizations from Sun ONE Portal Server 3.0. The disadvantage is that it is difficult to move users from one suborganization to another. To see if the roles have been migrated to suborganizations, view the hierarchy in the admin console.
-i ExportDir	Specifies the input directory for the conversion. The input directory is the directory which contains the exported data created by the export tool. The conversion tool searches for export data in /tmp/psExport unless you specify a different input directory using the -i ExportDir option. If you specify a directory which does not contain data exported with the export tool, the conversion tool notifies you that the directory does not have export data and prompts you to enter a valid export directory.
-o ImportDir	Specifies the output directory for the conversion tool. The output directory is the directory used by the import tool. If you choose an import directory which already contains converted data, the conversion tool notifies you that modifying an existing migration may render import data unusable and prompts you to delete the import directory.

Option	Description
-a	Runs all modules without a menu. To see the import menu, do not use the -a option.
-k	Specifies that the tool does not overwrite existing users. When you run importps without the -k option, if it encounters a conflict with an existing user, it will delete the existing user and import the new user entry defined in ImportDir/ldap/user.ldif. If you run importps -k, if it encounters a conflict with an existing user, it leaves the existing user and places the rejected user entry in ImportDir/ldap/rejected_users.ldif. If the user has a display profile document in the ImportDir/dp/user/ directory, the display profile file may change. The -k option does not affect importing user display profile documents. The -k option only affects whether an existing LDAP user's LDIF record is updated. The updates to the LDIF record include everything except display profile updates.
-m	Merges display profile documents. When you run importps without the -m option, it overwrites any existing display profile documents it finds. This means that the root suffix, organization, suborganization, and user level display profile documents, if they exist, are overwritten. If you run importps -m, when the tool encounters a conflict with an existing display profile document it will merge it.
ImportDir	Specifies the directory where the converted data is located. If the directory does not exist or if the directory does not contain valid converted data, the import tool prompts you to enter a directory containing the converted data to be imported. If you do not specify an import directory, the import tool will search /tmp/psImport.

Parameter	Description
-o Exportdir	Specifies the directory where the exported data is to be saved.
-i Target_InstanceDir	Specifies the directory for the target instance to be exported.

Parameter	Description
-o Target_InstanceDir	Specifies the directory of the Sun ONE Portal Server 6.0 Search root.
-i Source_InstanceDir	Specifies the directory of the Sun ONE Compass Server 3.01C, Service Pack 1 or later instance.
-p Portal_InstallDir	Specifies the directory of the Sun ONE Portal Server 6.0 installation.

Previous Contents Index Next
Copyright 2002 Sun Microsystems, Inc. All rights reserved.

Last Updated September 25, 2002