Sun Java logo     Previous      Contents      Index      Next     

Sun logo
Sun Java System Portal Server 6 2004Q2 Migration Guide 

Chapter 8
Migrating Sun™ ONE Compass Server


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, iPlanet™ Portal Server 3.0, Service Pack 4 products, and iPlanet™ Portal Server 3.0, Service Pack 5 products.


Sun™ ONE Portal Server 6.2 includes an integrated Search Engine that provides the functionality that Sun™ ONE Compass Server provided for Sun ONE Portal Server 3.0. Sun ONE Compass Server migration uses a separate set of tools from the Sun ONE Portal Server 3.0 Data Migration Tool Suite. The Sun ONE Compass Server migration tools include an export tool and an import tool that migrate Sun™ ONE Compass Server 3.01C, Service Pack 1 or later to Sun ONE Portal Server 6.2. Unlike the Sun ONE Portal Server 3.0 Data Migration Tool Suite, the Sun ONE Compass Server migration tools do not include a conversion tool because the conversion step is not necessary for Sun ONE Compass Server migration.

This chapter discusses migration from Sun ONE Compass Server 3.01C, Service Pack 1 or later to Sun ONE Portal Server 6.2. If you are running an earlier version of Sun ONE Compass Server, you must upgrade to Sun ONE Compass Server 3.01C, Service Pack 1 or later in order to migrate Sun ONE Compass Server to Sun ONE Portal Server 6.2. The Sun ONE Compass Server migration tools are BaseDir/SUNWips/migration/compass/export.pl and BaseDir/SUNWips/migration/compass/import.pl.

This chapter contains the following sections:


What You Need to Know Before Beginning the Sun ONE Compass Server Migration Process

Use the following information to help plan the Sun ONE Compass Server migration process.


Migrating the Personal Interest Profile (PIP)

If you plan to migrate the Personal Interest Profile (PIP) to the new iPlanet Portal Server 6.2 subscription service, read the following additional steps. Some planning is required before the migration process.

The user entries in the old system do not necessarily reside in the same directory server as the new iPlanet Portal Server 6.2. Therefore, the user entries might not be the same after the migration. The administrator planning the migration should plan the mapping in advance. The import process for the PIP is a separate step to reflect this requirement. This is especially true for Sun ONE Compass Server 3.01b where user entries are possibly stored in the local LDAP database which is no longer supported.

To ease this transition, the export.pl tool includes parameters to look up the new entries in the Sun ONE Directory Server where iPlanet Portal Server 6.2 is used. For example:

./export.pl [-h hostname] [-p port] [-D bind_dn] [-w passphrase] [-b base_dn]

Table 8-1 describes the parameters used with the Sun ONE Compass Server export tool. This two-column table lists the parameters in the first column and their descriptions in the second column.

Table 8-1  Parmeters Used With Compass Server Export Tool

Parameter

Description

-h hostname

Specifies the host name.

-p port

Specifies the port.

-D bind_dn

Specifies the admin ID in the directory server.

-w passphrase

Specifies the passphrase.

-b base_dn

Specifies the Sun ONE Portal Server install base.

The migration program will get the old user id from the existing system. Then it uses above information, if supplied, which is in the directory server used by the Sun ONE Portal Server 6.2, and tries to map the old user id to the new user id.

The lookup assumes the uid is the same before and after migration. This implies that user entries are migrated to the new Sun ONE Directory Server and set up as Portal users. See Sun ONE Directory Server, Sun ONE Identity Server, and Sun ONE Portal Server documentation for this process.

For entries without the same uid, or if you do not use the lookup feature, you might need to inspect the generated PKMigrated.ldif file manually and resolve the mapping before importing it.

The migration is not expecting the user entries in the Directory Server with the MySubscription service. Therefore add the corresponding objectClasses. In the case that users already have this service assigned, the following line should be removed in the PKMigrated.ldif file:

add: objectClass

objectClass: sunPortalPKSubscriptionsPerson


Using the Sun ONE Compass Server Export Tool

You use the Sun ONE Compass Server export tool to export data from Sun ONE Compass Server 3.01C, Service Pack 1 or later to the Sun ONE Portal Server 6.2 system. You can run the Sun ONE Compass Server export tool once for each instance of Sun ONE Web Server containing the Sun ONE Compass Server 3.01C, Service Pack 1 or later plug-in or you can run the export tool once for the Sun ONE Web Server installation, which will pick up and export all Sun ONE Compass Server 3.01C, Service Pack 1 or later instances within Sun ONE Web Server.

To Run the Sun ONE Compass Server Export Tool

  1. On the Sun ONE Portal Server 6.2 system, change to the Sun ONE Compass Server export tool directory:
  2. cd BaseDir/SUNWps/migration/compass/

  3. Run the export.pl script:
  4. perl ./export.pl [-o ExportDir] [-i Target_InstanceDir]

    or

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

    Table 8-2 describes the parameters used with the Sun ONE Compass Server export tool. This two-column table lists the parameters in the first column and their descriptions in the second column.

    Table 8-2  Parameters used with the Sun ONE Compass Server export tool

    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.

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

  5. The system displays messages similar to the following:
  6. Exporting instance https-<instance>...

    Exporting database...

    Dump --> tmp/migration60.soif OK

    Export Config files...

    Exporting instance https-<instance>

    Exporting database...

    Dump --> tmp/migration60.soif OK

    Export Config files...

    Exporting instance https-<instance>

    Exporting database...

    Dump --> tmp/migration60.soif OK

    Export Config files...

    Number of instance(s) exported: 3

You only need to run the Sun ONE Compass Server export tool once for all Sun ONE Compass Server 3.01C, Service Pack 1 or later instances for each Sun ONE Web Server installation. For stand-alone installations of Sun ONE Web Server, you can simply copy over the Sun ONE Compass Server export tool. The Sun ONE Compass Server export tool does not use the default directories of the Sun ONE Portal Server 3.0 Data Migration Tool Suite because of the potential large size of the document files.

The Sun ONE Compass Server export tool can take two input parameters, one for the Sun ONE Web Server installation directory and one for the export directory. The Sun ONE Compass Server export tool dumps all documents into /tmp/migration60.soif for each Sun ONE Compass Server 3.01C, Service Pack 1 or later instance. The default character set for the data SOIF file generated by the Sun ONE Compass Server export tool is ISO-8859-1. Other character sets require manual changes in the data file. The default character set for Sun ONE Portal Server 6.2 is UTF-8.

The Sun ONE Compass Server export tool saves the host name of the Sun ONE Compass Server 3.01C, Service Pack 1 or later, CSID, and other information in /tmp/migration60.info for each Sun ONE Compass Server 3.01C, Service Pack 1 or later instance and uses this information to create new corresponding instances for the Search Engine. You can modify this by hand prior to running the Sun ONE Compass Server import tool to fine tune the new setup.


Note

Although the file names generated by the export tool are named with a 6.0 naming convention, the exported data can be used on a Portal Server 6.2 implementation as it is compatible with both Sun ONE Portal Server 6.0, 6.1, and 6.2 releases.


Table 8-3 shows manual options for fine tuning exported data prior to running the import tool. This two-column table lists the options in the first column and their descriptions in the second column.

Table 8-3  Options for Fine Tuning Exported Data 

Option

Descriptions

DoMigrate

Specifies whether or not to import this instance

OldServerRoot

Enables the import tool to identify the old Sun ONE Compass Server 3.01C, Service Pack 1 or later configuration

OldCharSet (optional)

The Sun ONE Compass Server 3.01C, Service Pack 1 or later instance's character set. It is normally ISO-8859-1, but it may be a different. This option enables the import tool to convert the data to UTF-8 correctly.

NewServerPort (optional)

Reserved for future use

NewServerUser (optional)

Reserved for future use

NewServerID (optional)

Reserved for future use

NewServerHost (optional)

Reserved for future use


Using the Sun ONE Compass Server Import Tool

In order to import the exported data from Sun ONE Compass Server 3.01C, Service Pack 1 or later into the Sun ONE Portal Server 6.2 system, you run the Sun ONE Compass Server import tool which uploads Sun ONE Compass Server 3.01C, Service Pack 1 or later data to the Sun ONE Portal Server 6.2 system.


Note

Stop the iPlanet Portal Server before running the import.pl script. Due to schema changes the search database can get corrupted if the Portal Server is not stopped before running the import.pl script.


To Run the Sun ONE Compass Server Import Tool

  1. On the Sun ONE Portal Server 6.2 system, change to the directory containing the Sun ONE Compass Server import tool:
  2. cd BaseDir/SUNWps/migration/compass

  3. Run the import.pl script:
  4. perl ./import.pl [-o Target_InstanceDir] [-i Source_InstanceDir] [-p Portal_InstallDir]

    or

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

    An example might look like:

    perl ./import.pl -o /var/opt/SUNWps/https-instance/portal -i /nfs/ExportDir/https-old-instance -p /opt

    or

    ./import.pl -o /var/opt/SUNWps/https-instance/portal -i /nfs/ExportDir/https-old-instance -p /opt

    Table 8-4 describes the parameters used with the Sun ONE Compass Server import tool. This two-column table lists the parameters in the first column and their descriptions in the second column.

    Table 8-4  Parameters used with the Sun ONE Compass Server import tool

    Parameter

    Description

    -o Target_InstanceDir

    Specifies the directory of the Sun ONE Portal Server 6.2 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.2 installation.

  5. The system displays the following message:
  6. Migration Completed



Previous      Contents      Index      Next     


Copyright 2004 Sun Microsystems, Inc. All rights reserved.