Main -> Documentation -> Product Updates -> Installing and Configuring the Open SiteSearch Suite 4.0.0a Patch

Installing and Configuring the Open SiteSearch Suite 4.0.0a Patch

This document contains instructions on how to install and configure the Open SiteSearch suite 4.0.0a patch only release. Refer to Description of the Open SiteSearch 4.0.0a Patch for a detailed list of the bug fixes, enhancements, and new functionality that is available with this software.

Before you begin . . .

You must have the Open SiteSearch suite, Version 4.0.0, installed and have already begun to customize the environment to use this patch. If you are a new licensee or if you have installed 4.0.0 but have NOT made modifications to your environment, you should install the complete Open SiteSearch suite, Version 4.0.0a package instead of this patch release. Contact SiteSearch Support at to obtain a complete 4.0.0a installation. Refer to Installing and Configuring the Open SiteSearch Suite for instructions about the installation procedures for the complete 4.0.0a package.

4.0.0a Patch Installation Overview

To install this patch, you will create a temporary directory and install the patch in this directory. Next, you will copy the patch files located in the temporary directory into your existing SiteSearch 4.0.0 environment. This process requires an understanding of how to copy files and directories and how to use the diff utility for Unix.

Read and complete the instructions in the following sections to install and configure the 4.0.0a patch:

Installation Requirements

  • Your host system must use one of the following Unix operating systems:
    • DEC Alpha DIGITAL UNIX, version 4.0.0 (+ patch kits for releases A, B, and C - refer to http://www.digital.com/java/faq/faq_du.html for more information)

      Hewlett Packard HP-UX, version 10.20+

      IBM AiX, version 4.1+

      SGI IRIX, version 5.3+

      Sun Solaris, version 2.5.1+

  • To use the InstallShield Graphical User Interface (GUI) installers, you must have an X server, version X11 Release 5 or higher, running on your desktop. The X server must be capable of communicating with the X Window System on the host system where the Open SiteSearch suite is installed.
  • Note:

    The desktop that you are working on and the host system may be one in the same.

    If you are working on a PC desktop, you will need a PC X server, such as Exceed, X-WinPro, or SuperX, to communicate with your host system.

    If you do not have X server software or access to a host system that has the X Window System, you can use the Perl script installers as an alternative.

    Note:

    If you use InstallShield, make sure that your Unix environment DISPLAY variable is configured to display the X Windows System on your desktop.

  • You must have the Unix CLASSPATH environment variable configured properly. The CLASSPATH variable defines which directories the JDK searches to locate Java classes. By configuring the CLASSPATH variable correctly, you will be able to install the SiteSearch suite using InstallShield, add new Java classes to the software, and modify existing classes in the WebZ class packages.
  • To ensure that the CLASSPATH variable is configured correctly, type "env" and press Enter at the Unix command prompt. The output from this command should match the following:

    .:<fullSystemRoot>/classes/: \
    <fullSystemRoot>/classes/lib/SS4_0_0.jar: \
    <fullpath to JDK>/lib/classes.zip

    where <fullSystemRoot> is the full path to the <WebZ_root> directory, and <fullpath to JDK> is the location of your JDK installation. The backslash ("\") characters are included for readability and should NOT be added to the CLASSPATH setting.

  • You must have the following 4.0.0a patch only installation files based on the SiteSearch components that you have licensed:
    • For the InstallShield installation:

      WebZ Extensions - WebSvrInstaller_4_0_0ap.class

      WebZ - WebZInstaller_4_0_0ap.class

      Database Builder - DbBuilderInstaller_4_0_0ap.class

      Imaging Support Package - ISPInstaller_4_0_0ap.class

      For the Perl installation:

      WebZ Extensions - ss4_0_0ap.webserver.tar.Z and WebSvrInstaller_4_0_0ap.sh

      WebZ - ss4_0_0ap.webz.tar.Z and WebZInstaller_4_0_0ap.sh

      Database Builder - ss4_0_0ap.dbbuilder.tar.Z and DbBuilderInstaller_4_0_0ap.sh

      Imaging Support Package - ss4_0_0ap.isp.tar.Z and ISPInstaller_4_0_0ap.sh

Preparing for the Installation

Before you begin to install the SiteSearch 4.0.0a patch, you must know the following information regarding your existing SiteSearch 4.0.0 environment.

    Host operating system - the operating system where the SiteSearch suite 4.0.0 software is installed.

    Web Server - the type of Web server, Apache or Netscape, that you are using to connect to the WebZ component.

    Web Server Document Root Directory - the full path name of the directory that contains the Web server and WebZ HTML and image files.

    Web Server CGI-BIN Directory - the full path name of the directory contains Common Gateway Interface (CGI) scripts used for the Web server and WebZ operations.

    WebZ Installation Root Directory - the full path name of the WebZ 4.0.0 environment.

    Web Server Host Name - the name of the host system for the Web server.

    Host Name IP Address - the Internet Protocol (IP) address of the host system where the SiteSearch 4.0.0 software is installed.

    Web Server Port - the port number of the host system that the Web server is connected to for patrons to access WebZ.

    Process Username - the user name of the SiteSearch suite system administrator.

    Process Groupname - the name of the Unix group that has file permissions to the files and directories contained in Web server root directory.

    Server Admin Email - the electronic mail (e-mail) address of the SiteSearch suite system administrator.

    Netscape Root Directory - the full path name of the directory on the host system where the Netscape server is installed. This prompt only appears if you selected Netscape as your Web server.

    JDK Location - the full path name of the Java Development Kit (JDK) on the host system.

    miniSQL Host Name - the name of the host system that the Hughes Technology Mini Structured Query Languages (mSQL) server will run on to provide user authentication to the WebZ Out-of-the-Box Interface (OBI).

    miniSQL Port - the port number of the host system that the mSQL server will run on to provide user authentication to the WebZ OBI. The port number must be greater than 1024.

    miniSQL Process Username - the user name of the mSQL system administrator.

    miniSQL Server Admin Email - the e-mail address of the mSQL system administrator.

    SSDOT Environment Name - a specific environment name for the Database Builder SSDOT program. This name is displayed in the SSDOT menus to distinguish between multiple copies of the program. This prompt only appears in the Database Builder installation.

    Directory of Perl Interpreter - the full path name of the Perl interpreter on the host system. This prompt appears in the Database Builder, Imaging Support Package, and Perl script installations.

Installing the Open SiteSearch Suite 4.0.0a Patch

Read the installation instructions described below before installing the SiteSearch 4.0.0a patch software.

Conventions

  • <WebZ_root> refers to the location of your SiteSearch 4.0.0 environment, including all of the components that you have licensed (WebZ, Database Builder, and Imaging Support Package).
  • <TempDir_root> refers to the location of the installed SiteSearch 4.0.0a patch files.

1. Create a temporary directory for the SiteSearch suite 4.0.0a patch installation. Do NOT run the patch installers in your <WebZ_root> directory. Copy the installation files into this temporary directory. This temporary directory will now be referred to as the <TempDir_root> directory.

Note:

It is recommended that you install all of the SiteSearch suite 4.0.0a patch components into the same directory.

2. In the <TempDir_root> directory, install the 4.0.0a patch for each of the SiteSearch components that you have licensed. Follow the instructions below to start the InstallShield or Perl installers.

  • To install a patch using InstallShield, type "java classname" at the X Windows command prompt, where classname is the name of the Java class without the file extension, and press Enter. For example, to start the InstallShield WebZ Extension patch installation, type "java WebSvrInstaller_4_0_0ap" and press Enter. Notice that the file extension .class is not specified in this command.
  • To install a patch using the Perl script installer, type "filename" at the Unix command prompt, where filename is the name of the installation Perl script file (.sh), and press Enter. For example, to start the Perl script WebZ Extension patch installation, type "WebSvrInstaller_4_0_0ap.sh" and press Enter.

3. Complete the installation for each component that you have licensed.

Warning:

Specify the <WebZ_root> 4.0.0 environment for the system configuration information required for each installation. By default, the installer will automatically set the target installation directory to <TempDir_root>. You MUST change the <TempDir_root> values to the <WebZ_root> directory to allow the new patch files to work with the 4.0.0 environment. The program will still install the patch files in the <TempDir_root> directory. If you do not specify the <WebZ_root> directory as the target location, the patch files will NOT work with the SiteSearch 4.0.0 software.

4. Refer to the Converting Your SiteSearch 4.0.0 Environment to SiteSearch 4.0.0a section below.

Converting Your SiteSearch 4.0.0 Environment to SiteSearch 4.0.0a

Follow the instructions below to integrate the SiteSearch 4.0.0a patch in the <TempDir_root> directory into your <WebZ_root> 4.0.0 environment.

Important Note: It is strongly recommended that you make a backup copy of all 4.0.0 files before replacing or deleting these files with new 4.0.0a patch files.

1. Complete the following step based on the Web server you are using to access the WebZ system:

  • If you installed the Netscape WebZ Extension, copy the <TempDir_root>/ini/WebSvrExt.ini configuration file into the <WebZ_root>/ini directory.
  • If you installed the Apache WebZ Extension, move to the <WebZ_root>/ini directory and rename the ApacheExt.ini file to WebSvrExt.ini.

2. Stop the Web server, WebZ, and, if you are using the WebZ Access component, the mSQL server.

3. Copy the following new files and directories from the <TempDir_root> directory in the 4.0.0a environment specified below into the corresponding directory in the <WebZ_root> 4.0.0 environment.

For example, the <TempDir_root>/httpd/apache/lib/<platform>/Makefile file listed below should be copied into the <WebZ_root>/httpd/apache/lib/<platform>/ directory, and the <TempDir_root>/httpd/netscape directory should be copied into the <WebZ_root>/httpd directory.

WebZ Extension (Apache Only)

    <TempDir_root>/httpd/apache/lib/<platform>/Makefile

WebZ Extension (Netscape Only)

    <TempDir_root>/httpd/netscape (Copy the entire directory and its contents.)

WebZ

    <TempDir_root>/classes/ORG/oclc/fmts/FLDLST.class

    <TempDir_root>/msql/bin/accessdb.dump (This file was formerly located in the <WebZ_root>/msql/msqldb/accessdb/ directory.)

    <TempDir_root>/msql/templates (Copy the entire directory and its contents.)

4. Copy the following updated files and directories from the <TempDir_root> directory in the 4.0.0a environment into the directory specified below in your 4.0.0 WebZ environment.

Important Note: The files and directories listed below are binary executable files, API HTML files, and the source code Jar file. Make sure to copy entire directories ONLY when specified below. Otherwise, just copy the individual files listed.

WebZ Extension (Apache Only)

    <TempDir_root>/httpd/apache/bin/<platform>/httpd

    <TempDir_root>/httpd/apache/lib/<platform>/libWebZ.a

    <TempDir_root>/httpd/apache/scripts/apache

    <TempDir_root>/httpd/apache/src/Makefile.webz

    <TempDir_root>/httpd/apache/src/getini.c

    <TempDir_root>/httpd/apache/src/mod_webz.c

WebZ

    <TempDir_root>/classes/lib/SS4_0_0a.jar (This file should replace the SS4_0_0.jar file.)

    <TempDir_root>/htdocs/help/api/AllNames.html

    <TempDir_root>/htdocs/help/api/ORG.oclc.access.AccessConnectInfo.html

    <TempDir_root>/htdocs/help/api/ORG.oclc.ber.BerConnect.html

    <TempDir_root>/htdocs/help/api/ORG.oclc.ber.BerString.html

    <TempDir_root>/htdocs/help/api/ORG.oclc.ber.DataDir.html

    <TempDir_root>/htdocs/help/api/ORG.oclc.fmts.FormatBerUtil.html

    <TempDir_root>/htdocs/help/api/ORG.oclc.obi.util.Topics.html

    <TempDir_root>/htdocs/help/api/ORG.oclc.opserve.opsmanager.OpsManager.html

    <TempDir_root>/htdocs/help/api/ORG.oclc.util.IniFile.html

    <TempDir_root>/htdocs/help/api/ORG.oclc.util.Util.html

    <TempDir_root>/htdocs/help/api/ORG.oclc.webz.WebZUserHistory.html

    <TempDir_root>/htdocs/help/api/ORG.oclc.webz.ZUserData.html

    <TempDir_root>/htdocs/help/api/ORG.oclc.zbase.access.ZBaseAccessClient.html

    <TempDir_root>/htdocs/help/api/packages.html

    <TempDir_root>/msql/bin/msqlconvert

    <TempDir_root>/msql/bin/msqlexport

    <TempDir_root>/msql/bin/msqlimport

    <TempDir_root>/scripts (Copy the entire directory and its content. Two new files were added to this directory, ssadminbatch and ssmgr.template.)

Database Builder

    <TempDir_root>/dbbuilder/bin/dumpbdam

    <TempDir_root>/dbbuilder/bin/dumpdbdesc

    <TempDir_root>/dbbuilder/bin/dumpnip

    <TempDir_root>/dbbuilder/bin/indxloop

    <TempDir_root>/dbbuilder/bin/initdb

    <TempDir_root>/dbbuilder/bin/newtsize

    <TempDir_root>/dbbuilder/bin/pippin

    <TempDir_root>/dbbuilder/bin/pipreorg

    <TempDir_root>/dbbuilder/bin/rome

    <TempDir_root>/dbbuilder/bin/sortnip

    <TempDir_root>/dbbuilder/bin/valindex

    <TempDir_root>/dbbuilder/bin/romemerg

    <TempDir_root>/dbbuilder/bin/testmem

    <TempDir_root>/dbbuilder/bin/vallists

    <TempDir_root>/dbbuilder/ssdot/exes/scansttn2ber

    <TempDir_root>/dbbuilder/ssdot/exes/ssdot

Imaging Support Package

    <TempDir_root>/dbbuilder/ssimage/scripts/ssimage_bld.sh.orig

    <TempDir_root>/dbbuilder/ssimage/setupinstall.sh

    <TempDir_root>/dbbuilder/ssimage/ssimage_bld.sh

5. Review the list of modified files below that are included in the WebZ Extension, WebZ, Database Builder, and Imaging Support Package 4.0.0a patch. Locate the same files in the corresponding <WebZ_root> directory and identify which files you have made modifications to since the initial installation.

WebZ Extension (Apache Only)

    <TempDir_root>/httpd/apache/conf/srm.conf

WebZ

    <TempDir_root>/classes/ORG/oclc/fmts/ber2marc.class

    <TempDir_root>/classes/ORG/oclc/fmts/ber2marc.java

    <TempDir_root>/classes/ORG/oclc/fmts/FormatBerUtil.class

    <TempDir_root>/classes/ORG/oclc/fmts/FormatBerUtil.java

    <TempDir_root>/classes/ORG/oclc/fmts/MarcBuilder.class

    <TempDir_root>/classes/ORG/oclc/fmts/MarcBuilder.java

    <TempDir_root>/classes/ORG/oclc/fmts/MARCDIRECTORY.class

    <TempDir_root>/classes/ORG/oclc/fmts/MARCFIXED8.class

    <TempDir_root>/classes/ORG/oclc/fmts/MARCLEADER.class

    <TempDir_root>/classes/ORG/oclc/fmts/MarcNode.class

    <TempDir_root>/classes/ORG/oclc/obi/util/Topics.class

    <TempDir_root>/classes/ORG/oclc/obi/util/Topics.java

    <TempDir_root>/classes/ORG/oclc/tools/ProConvert.class

    <TempDir_root>/classes/ORG/oclc/tools/ProConvert.java

    <TempDir_root>/classes/ORG/oclc/tools/Table.class

    <TempDir_root>/classes/ORG/oclc/tools/Table.java

    <TempDir_root>/classes/ORG/oclc/tools/Table$ColType.class

    <TempDir_root>/htdocs/html/homeframe.html

    <TempDir_root>/htdocs/html/imageframe.html

    <TempDir_root>/htdocs/html/toolbar.html

    <TempDir_root>/ini/SSAdmin.ini

    <TempDir_root>/ini/dbs/PartitionedDb.ini

    <TempDir_root>/ini/interface/defaultStyle.ini

    <TempDir_root>/ini/interface/redStyle.ini

    <TempDir_root>/ini/servers/Access.ini

6. Copy any unchanged files from the 4.0.0a list in step 5 above into the corresponding <WebZ_root> directory. If you are unsure whether or not you have made changes to a file, do NOT copy the file over yet. Complete the additional steps below to verify if any changes have been made to the file.

Note:

Make sure to copy entire directories ONLY when specified above. Otherwise, just copy the individual files listed.

7. Use the Unix diff utility to compare the remaining patch files in the <TempDir_root> directory with existing modified files in the <WebZ_root> directory.

The following is an excerpt from the Unix man pages containing a description of the diff utility:

     The diff utility will compare the contents of file1 and
file2 and write to standard output a list of changes neces-
sary to convert file1 into file2. This list should be
minimal. No output will be produced if the files are ident-
ical.

The normal output contains lines of these forms:

n1 a n3,n4
n1,n2 d n3
n1,n2 c n3,n4

where n1 and n2 represent lines file1 and n3 and n4
represent lines in file2 These lines resemble ed(1) commands
to convert file1 to file2. By exchanging a for d and read-
ing backward, file2 can be converted to file1. As in ed,
identical pairs, where n1=n2 or n3=n4, are abbreviated as a
single number.

Following each of these lines come all the lines that are
affected in the first file flagged by `<', then all the
lines that are affected in the second file flagged by `>'.

Example

For example, if you have changed FormatBerUtil.class, you would issue the following command to compare the differences between the existing 4.0.0 file and the new 4.0.0a file:

diff <TempDir_root>/classes/ORG/oclc/fmts/FormatBerUtil.class 
<WebZ_root>/classes/ORG/oclc/fmts/FormatBerUtil.class

For more information about diff, review the Unix man pages by typing "man diff" at your Unix command prompt and pressing Enter.

Important Note: SiteSearch Support has an additional tool to assist you when determining the differences between your 4.0.0 existing files and the new 4.0.0a patch files. This tool is a shell script that automates the diff utility. To obtain a copy of this tool, contact SiteSearch Support at .

8. After you have identified the changes between an existing 4.0.0 file and a new 4.0.0a patch file, edit the new file to implement the changes that you had made in the existing file.

9. Make a backup copy the existing 4.0.0 file in the <WebZ_root> directory that will be replaced with the edited 4.0.0a patch file.

10. Copy the new 4.0.0a file with your change(s) from the <TempDir_root> directory to the corresponding <WebZ_root> directory, overwriting the previous version of this file.

11. Repeat steps 7, 8, 9, and 10 until all 4.0.0a patch files listed in step 5 have been copied into the <WebZ_root> directory.

12. Edit the Java CLASSPATH settings.

The CLASSPATH environment variable defines which directories the JDK searches to locate Java classes. By modifying the CLASSPATH variable, you will be able to add new Java classes to the software and modify existing classes in the WebZ class packages using the new Jar file, SS4_0_0a.jar, included in the 4.0.0a patch. Edit the CLASSPATH variable as follows:

.:<fullSystemRoot>/classes/: \
<fullSystemRoot>/classes/lib/SS4_0_0a.jar: \
<fullpath to JDK>/lib/classes.zip

where <fullSystemRoot> is the full path to the <WebZ_root> directory, and <fullpath to JDK> is the location of your JDK installation. The backslash ("\") characters are included for readability and should NOT be added to the CLASSPATH setting.

Notice that the only change between the CLASSPATH setting for SiteSearch 4.0.0 and SiteSearch 4.0.0a is the name of the Jar file included on the second line of the example above. The Jar file was configured for "SS4_0_0.jar" but should be changed to "SS4_0_0a.jar".

After you have edited the CLASSPATH variable, logout of your Unix session and log back in to activate the new settings.

13. Start the Web server, WebZ, and, if necessary, the msql server. Perform several searches to ensure that the system is functioning correctly and that you have not lost any of your changes.

14. After you have configured the patch, test the installation, making sure that the modifications you made to the 4.0.0 software are still apparent in your updated 4.0.0a environment.

See Also

Testing the Installation of the Open SiteSearch Suite
Description of the Open SiteSearch 4.0.0a Patch
Installing and Configuring the Open SiteSearch Suite
Operating the WebZ System


[Main][Documentation][Technical Reference][Glossary][Search]