iPlanet Compass Server, 3.01C
Installation and Migration Guide

This document tells you how to install iPlanet Compass Server. It contains the following sections:

 

Supported Platforms
Please refer to the Release Notes for platform, patch, software and hardware requirements.

 

Installation Overview
iPlanet Compass Server integrates seamlessly with iPlanet Portal Server. You can install Compass Server on an existing Portal Server or on a separate machine. For a high traffic portal, or a portal where Compass Server will be heavily used, we recommend dedicating a machine for Compass Server.

When you install iPlanet Compass Server, you follow these basic steps:

  1. Install and configure iPlanet Portal Server.
  2. Install the iPlanet Compass Server plugin.
  3. Enable the Compass Server plugin.
  4. Configure the Compass Server plugin.
  5. Install and configure the Compass Portal Provider.

 

Installing iPlanet Compass Server
Notes on installing or upgrading Portal Server for use with Compass Server:
  • You must ensure that the Portal Server administration server and all Portal Server instances are turned off during the installation of Compass Server.
  • If you are upgrading from a Compass Server that is running on either iPlanet Web Server or Netscape Enterprise Server, you should install Portal Server and Compass Server in a different root from the existing system. For example, if your existing installation is in /Netscape/SuiteSpot, install your new servers in /iPlanet/Server4/

Whilst installing Portal Server, make note of the following:

  • iPlanet Web Server administration host and port. The default for portal server if you do not customize your settings is http://server.domain.com:8888/ , where server.domain.com refers to the server name and domain name of your organization.
  • iPlanet Portal Server administration username and password.

To install the Compass Server binaries for Solaris:

If downloaded:

  • untar the tar file
  • change directory to 'solaris'
  • run the command:
    pkgadd -d . SUNWipcs
  • Follow the prompts to install the package


If installing from CD-ROM
  • change directory to '[cdrom]/solaris'
  • run the command:
    pkgadd -d . SUNWipcs
  • Follow the prompts to install the package
NOTE: We recommend you answer 'Yes' to installing the XPDF package.


Once the installation has completed, access the iWS administration panel:
The default location is http://your_server:8888


Create a new Web Server instance for which you will be enabling the Compass Server plugin:
  • Select Add Server and complete the information, including a unique port number and server identifier (e.g. compass).
  • Follow the link to 'Configure more options' in your server.
  • Select the Preferences/Compass Admin tab
  • click on the 'Compass Server Setup' button.
  • Follow the steps in the wizard to complete the basic configuration.

Once you have enabled the Compass Server plugin, you can access Compass Administration via the Preferences/Compass Admin tab in the Web Server Manager.


To configure and add information to Compass Server, please refer to the online documentation at at http://www.iplanet.com/docs, which also includes a Quick Start Guide.

 

Installing the iPlanet Compass Server Portal Provider
The Compass Server Portal Provider allows the integration of Compass Server into the Portal Server. It provides the end user interface for a channel within the Portal and controls basic Administration information.

Before you begin
You should have iPlanet Portal Server already installed.
a) From the plugins/compass/samples/portal directory where you installed Compass, run the install script. You will be prompted for:

  • the installation path. Enter the Portal Server installation path, by default /opt
  • the Compass Server instance. Enter the full server, domain and port for your Compass Server, eg, http://compass.iplanet.com:1234
  • the domain to which to add the Compass Server provider.

b) If you have multiple Portal Servers, you will need to copy the Compass Portal Provider installation files to each Portal Server machine and repeat a) for each Portal Server.

The Compass Search channel is installed as a default provider. This means that it will automatically be available to users who have not modified their profile. If users have modified their profile, they can add the Compass Provider channel to their portal desktop by clicking on the Content link and checking the Compass Search checkbox.

Adding categories to the Compass Provider
If you have configured Compass Server to use categories, you can customize your Portal Provider to add nominated categories to the Portal channel for Compass Server. Categories from any level of your category tree (or taxonomy) can be added to the channel.

From the Portal Administration:

  1. Choose to Manage Domains/Select Domain
  2. Click on the Applications/Desktop branch
  3. Select the iwtCompassProvider and click on Edit Channel
  4. Here you can add or remove categories in the Compass Provider. Categories take the form of:
    Category1:Subcategory2:Child3
    Note that the top level of a taxonomy - the root node, or taxonomy name - should not be included here.

Multiple Domain Configuration
The Compass Portal provider is installed as a default provider. If your Portal has multiple domains, and inheritance is turned on, then this same Compass Server can be made available to all domains in the Portal Server. If you wish to have separate Compass Servers for different domains within the Portal Server, follow the instructions below:

From the Portal Administration:

  1. Choose to Manage Domains/Select Domain
  2. Click on the Applications/Desktop branch
  3. Select the iwtCompassProvider and click on Edit Channel
  4. Here you can change the Compass Server URL, which takes the form:
    http://compass.iplanet.com:1234

If you have inheritance turned off, then the Compass provider may not be displayed from 3 above. If this is the case, and you have already installed the Compass Server provider, you can manually add the provider to this domain as follows:

  1. Choose to Manage Domains/Select Domain
  2. Click on the Applications/Desktop branch
  3. Select Add Channel
  4. For the channel name, enter exactly (this is case sensitive):
    iwtCompassProvider
  5. For the Provider class name, add exactly (this is case sensitive)
    com.iplanet.portalserver.providers.compass.CompassProvider
  6. Click on the Add button to install the Compass Provider
  7. Check the Compass Server URL is correct per the steps above.

Finally, you may have different template directories specified for each domain. The template directory is specified under the Desktop Profile for each domain. If you have different template directories for different domains, you will need to copy the Compass templates to each directory. The Compass template files are installed in the template directory of the domain you selected when you initially installed the Compass Server provider. Simply copy these files to the same relative path under the template directory for each domain.

 

Migrating from a pre 3.01B Compass Server
If you are using an earlier version of Compass Server 3.x, you can follow the steps for migrating from 3.01B below, but be sure to backup your data before you begin.

If you are migrating from an earlier version of Compass or Catalog server, please contact iPlanet support for specific directions.

 

Migrating from Compass Server 3.01B

  1. We recommend you backup your existing Compass Server installation before beginning your migration.


  2. Turn off Compass Server

  3. Turn off your old compass server. You will also need to ensure that the database daemons (db_* processes) are off.

    For your old Compass Server, from the compass-nick directory, enter the command:
    ../bin/compass/bin/minidba stop_daemon db

  4. Installing Directory Server / LDAP

  5. If you currently use the LDAP Local Database for server access control or the My Compass subsystem, or if you intend to use LDAP for your new Compass installation, you will need access to an external iPlanet Directory Server or another LDAP compliant server.

    We highly recommend that you use iPlanet Directory Server 4.x. The LDAP server does not have to be installed on the same machine as the Compass server, nor does it have to run on the same platform.

    You can quickly check if you currently use local LDAP. In General Administration:
    - The Global Settings/Configure Directory Service will show if the Local Database option is selected. If not, you already have an LDAP server that can be used by Compass, and you can move on to the next step.
    - Under Users & Groups/Manage Users, do a search to Find user "*". If any users are listed and you are using the LDAP local database, then you will need to install an LDAP compliant server.

    Note that the URL for iPlanet Directory Server, using the example above is:
    ldap://natoma.iplanet.com:389/o=iplanet.com
    and you can use the Administration username cn=Directory Manager
    and password as set above.

  6. iPlanet Web Server and iPlanet Portal Server

  7. You will need iPlanet Web Server and iPlanet Portal server installed before you can install iPlanet Compass Server. We highly recommend that you install the latest versions before you begin the Compass Server install. Latest versions can be downloaded from the iPlanet web site. iPlanet Web Server must be installed on the same machine as iPlanet Compass Server

    See the above instructions for installing these products.

  8. Install Compass Server

  9. See the above instructions to install iPlanet Compass Server.

  10. Turn off Compass Server

  11. To continue migration, your new Compass Servers must be turned off. Note that the database daemons (db_* processes) are no longer separate processes, so you only need to turn off the Compass Servers from the Compass Administration.

  12. Copy configuration files

  13. If you wish to copy your old settings to your new Compass Server, you should copy the following configuration files from your old compass-nick/config directory to your new https-nick/config directory:
    File Description
    filterrules.conf Robot starting points and filter rules
    filter.conf Robot configuration
    classification.conf Robot classification rules
    alias.conf Provides schema conversion for attributes
    taxonomy.rdm Taxonomy, ie, the hierarchy of categories in Compass
    schema.rdm Compass database schema
    gv.conf* My Compass configuration
    gv_dynamic.conf* My Compass dynamic configuration
    *these files may not exist in your old Compass Server instance and are only relevant if you intend to install the Personalized Knowledge Services add on component.

    IMPORTANT NOTE: If you replace these files, remember to Apply the changes when you access the new Compass Server's Administration. Failure to do so will result in these changes being lost when furture admin modifications are applied.

  14. Move the existing Compass Database (optional)

  15. If you wish to maintain the current data in your Compass database, you can move the database to your new Compass Server.

    Note: You must ensure that the Compass Server is off, the robot is off and the database daemons (old server only) are off for both your old Compass Server and new Compass Server before performing this step.

    - In your new Compass Server delete the db directory and all files and subdirectories from https-nick/db
    - Move the old compass-nick/db directory and all subdirectories to the new https-nick directory. We recommend moving rather than copying your Compass Database to conserve free disk space.
    - If your old database was partitioned, then any existing partitions with absolute paths will continue to be used in place. Existing partitions with relative paths that lie within the db directory will have been moved along with the db directory and will continue to be accessible, however, relative partitions that do not lie under the db directory (ie, those which have paths beginning with ../) may need to be manually moved so as to be accessible relative to the new db directory.
    - In your new Compass instance, move/rename the https-nick/db/verity/collections directory to https-nick/db/collections.
    - In your new Compass instance, move the https-nick/db/verity/dblist.ini and dblist.ini.backup files into the https-nick/db directory. The https-nick/db/verity directory will now be empty. Remove this directory.
    - Edit the dblist.ini file in your new Compass Server's https-nick/db directory. Change:

    • the first occurrence of the NS-idx-path parameter:

    • NS-idx-path=d:/netscape/SuiteSpot/compass-nick/db/verity/collections/compass
      to point to the absolute path of the new Compass Server's index directory, eg:
      NS-idx-path=d:/Netscape/Server4/https-nick/db/collections/compass
    • the second occurrence of the NS-idx-path parameter:

    • NS-idx-path=d:/Netscape/SuiteSpot/compass-nick/db/verity/collections/taxonomy
      to point to the absolute path of the new Compass Server's index directory, eg:
      NS-idx-path=d:/Netscape/Server4/https-nick/db/collections/taxonomy

    This updates the configuration information for the database. If you have difficuly with this process, it is also possible to reindex the database from admin to recreate the search engine index colection (the collections subdirectory).

  16. Templates (optional)

  17. The Compass Server templates have a new look and feel while maintaining consistency with the old templates. If you have modified the Compass Server templates in your old Compass Server, you can safely copy them to the new Compass Server. To do this:
    - Copy the files in the old Compass Server's compass-nick/templates directory to the new Compass Server's https-nick/templates directory.
    - In your new Compass Server Administration, go to the End User/Search page and select the same template as you had selected in your old Compass Server.

    We highly recommend that you inspect the new default templates in case you can take advantage of some of the improvements in your own templates.

  18. Robot Security Settings

  19. If your robot accesses sites that use SSL, you need to reconfigure the new server with these settings.

    Configuring SSL settings is explained in the Compass Server Administration Guide. From the Robots/Crawling tab, click on the Help button and follow the link to Roboting SSL sites.

    You can safely copy your old Compass Server's certificate and key databases (cert7.db and key3.db respectively) from the old compass-nick/config directory to the new Compass Server's https-nick/config directory. Note that if you have configured a password on your certificate database, you will need to modify your https-nick/config/process.conf file. Refer to the Help mentioned above for the steps to complete this task. We recommend that you leave the SSL certificate database password empty if you will be using My Compass via the Personalized Knowledge Services add on component and have configured your Compass server to require certificate based client authentication, or if you wish to import data from other Compass servers configured for certificate based authentication. This limitation will be removed in future releases.

  20. Scheduling Common Tasks

  21. You can now configure the scheduling in the new Compass Server. In Compass you can schedule:
    Server Manager
    Compass Admin Tab
    Description
    Robot/Start Robot start
    Robot/Stop Robot stop
    Database/Import Import Agents from other Compass Servers
    My Compass/Schedule Generation of My Compass personalized newsletters (only if you install the Personalized Knowledge Services add on component)
    Reports/Archive Log Rotation


  22. Turn on the server

  23. The server may take some time to respond, as it will perform an integrity check on startup.

Your migration is now complete. If you have multiple Compass Server instances on your old Compass Server, simply add new instances to your new Web Server, upgrade the Web Server instance to Compass and repeat steps 5 to 11 above.

 

Go back to the top! No one wants to uninstall Compass! Uninstalling Compass Server
Compass Server requires a manual uninstall procedure. To revert an installation of iPlanet Web Server to its original condition, perform the following:
  • Turn the Compass Servers off. Instructions for this are included here.
  • Remove the Compass Server instances. From the Web Server Administration, choose to Remove Server for the Web Server instances that you have upgraded to Compass.
  • For Solaris: Use pkgrm SUNWipcs to uninstall the Compass Server package.
  • For Windows NT: Remove the Compass plugin directory. By default, this is the iPlanet/Server4/plugins/compass directory. Reinstall iPlanet Web Server. Compass updates some files during installation, so it is necessary to reinstall Web Server to revert these files to their originals.
  • If necessary, recreate the Web Server instance(s) that you removed from above.

 


© Copyright © 2001 Sun Microsystems, Inc. Some preexisting portions Copyright © 2001 Netscape Communications Corp. All rights reserved.