Main -> Documentation -> Product Updates -> Upgrading from SiteSearch 4.2.0 to SiteSearch 4.2.0a

Upgrading from SiteSearch 4.2.0 to SiteSearch 4.2.0a


Contents

Introduction
Requirements
Document Conventions
Applying 4.2.0 Bug Fixes to an Existing SiteSearch 4.2.0 Environment
Appendix

Introduction

This document provides instructions for applying the SiteSearch 4.2.0a bug fixes and adding the source code to an existing SiteSearch 4.2.0 environment on UNIX or Windows NT systems.

WARNING: If you have customized your SiteSearch environment, you must follow the upgrade procedures described in this document. DO NOT install the 4.2.0a patch tar file into your existing environment. You may lose some of your changes by installing these 4.2.0a bug fixes on top of an existing environment.

Requirements

Before completing the instructions in this document, you must:

Document Conventions

  • <WebZ_root> refers to your existing Open SiteSearch 4.2.0 production environment.
  • <WebZTest_root> refers to the directory of your existing 4.2.0 test environment.
  • <patchdir> refers to the directory where you move the SiteSearch 4.2.0a tar file. You integrate changes from <patchdir> into the <WebZTest_root> environment, while allowing patrons to access the <WebZ_root> environment during the upgrade.
  • When a procedure step refers to editing a file, use the text editor of your choice to edit the file. Then save and close the file.
  • In path names, forward slashes ("/") separate directories. For Windows NT, change the forward slashes to backslashes ("\").

Applying 4.2.0a Bug Fixes to an Existing SiteSearch 4.2.0 Environment

The following procedure describes how to integrate 4.2.0a bug fixes into an existing 4.2.0 environment using the SiteSearch4_2_0aPatch.tar file.

Review the Description of the Open SiteSearch 4.2.0a Release and then apply the SiteSearch4_2_0aPatch.tar file as described below.

The upgrade involves:

  • Making a copy of your existing SiteSearch 4.2.0 environment in a new directory.
  • Extracting 4.2.0a tar files into a new directory, <patchdir>.
  • Making changes to some of the files as listed below.
  • Applying changes you made to your 4.2.0 environment by comparing the files you customized to those in <patchdir> and updating files in <patchdir> accordingly.
  • Copying customized versions of your files to directories in <patchdir> for storing customized files.
  • Moving files (customized or not) into your SiteSearch 4.2.0 environment.
  • Verifying that the SiteSearch 4.2.0a environment operates properly.

The tar file contains bug fixes as well as all of the SiteSearch java source files. The tar file is available on the secure ftp server.

This is a password protected site accessible to system administrators only.

  Host: sitesearch.oclc.org
  Directory: Sitesearch/4.2.0a/fixes/
  Files:

SiteSearch4_2_0aPatch.tar; README

Follow these steps to apply the SiteSearch 4.2.0a bug fixes.

1. Back up your existing test environment (<WebZTest_root>) into a separate directory.

  • Stop the Web server, the WebZ system, the Record Builder application (if applicable), and, if you are providing user authorization through the WebZ interface, the SQL server.
  • Copy the <WebZTest_root> environment into a backup directory. This backup directory is a safeguard only; you do not use it in this procedure.

2. Create a temporary directory (<patchdir>) and download the SiteSearch 4.2.0a tar file into this directory.

3. From the <patchdir> directory, enter the following command to extract the files:

tar -xvf SiteSearch4_2_0aPatch.tar

The files are arranged in the same directories as those in the default SiteSearch directory structure.

Note:  

The tar file has an option (-w) which forces a prompt before overwriting an existing file with an extracted file. This is the recommended option when extracting files in an installed environment.

tar -xvwf SiteSearch_example.tar

4. Use the UNIX grep utility to find the .ini files in the <patchdir>/ini directory where the installation replacements have NOT been done for the following variables.

grep SITESEARCHROOT *
Change SITESEARCHROOT to your <WebZTest_root> directory.
grep _FSEP_ *
For UNIX change _FSEP_ to a forward slash ("/"). For Windows NT change _FSEP_ to a backslash ("\").
grep HOST *

Change HOST1 or HOST2 to the name of the corresponding host environment.

grep PLAT_EXT *

Change PLAT_EXT to the name of the platform extension.

grep UIVERSION *

Change UIVERSION to obiv1, obiv2, rbv0 (for Record Builder) or your site specific directory.

grep DOCUMENTROOT *

Change DOCUMENTROOT to your <WebZTest_root>/htdocs/UIVERSION directory (see above).

grep CGIBIN *

Change CGIBIN to your <WebZTest_root>/cgi-bin directory.

5. Use the UNIX grep utility to find the files in the <patchdir>/dbbuilder directory where the installation replacements have NOT been done for the following variables.

grep SITESEARCHROOT *
Change SITESEARCHROOT to your <WebZTest_root> directory.
grep _FSEP_ *
For UNIX change _FSEP_ to a forward slash ("/"). For Windows NT change _FSEP_ to a backslash ("\").

6. Are you on a Solaris platform?

  mysql/lib.sol/mysql
      to 
  mysql/lib/mysql

         Go to step 7.

  • No. Go to step 7.
    		•

    7. There are two SS*.jar files in the <patchdir>/classes/lib directory, the SS4_2_0a.jar and SS4_2_0afull.jar. Edit your CLASSPATH environment variable as needed to read the SS4_2_0a.jar file or the SS4_2_0afull.jar file.

    An example of the required CLASSPATH statements follows.

    .:<fullpath to JDK>/lib/classes.zip:<WebZ_root>/classes/: \
    <WebZ_root>/classes/lib/pears.jar: \
    <WebZ_root>/    classes/lib/SS4_2_0a.jar: \
    <WebZ_root>/classes/lib/mail.jar: \
    <WebZ_root>/classes/lib/activation.jar

    Note:

    (1) In the example, backslash ("\") characters are included for readability only. Do NOT add them to the CLASSPATH variable.

    (2) Edit the CLASSPATH variable so that its entries appear exactly in the order shown in the examples.

    (3) Windows NT administrators need to set the CLASSPATH manually for this upgrade, even though you do not need to do this in a first-time installation. Use the syntax below except for substituting backslashes ("\") for forward slashes ("/") to separate file names.

    (4) For more information about setting the CLASSPATH variable, see Configuring the CLASSPATH Variable for UNIX or Configuring the CLASSPATH Variable for NT in Installing and Configuring the Open SiteSearch Suite.

    UNIX Administrators: After you edit your CLASSPATH variable, log out of your UNIX session and log back in to activate the new settings.

    8. Edit the ssmgr.hostname file (in the <WebZTest_root>/scripts directory), where hostname is the name of the host system where your existing Open SiteSearch environment is installed, in a text editor. You must change the following item, which is above "DO NOT edit below this line" statement, to reflect the 4.2.0a version of the software.

    # What version of SiteSearch is installed
    SSVERSION=4_2_0a

    9. Edit the ssadmin (and ssadmin_rb files, if applicable) in the <WebZTest_root>/scripts directory in a text editor. Change the item shown to reflect the 4.2.0a version of the software: 

    SSVERSION=4_2_0a

    10. Use a text editor to edit the SSVERSION line (as you did for ssadmin in Step 9) in the following files in <WebZTest_root>/scripts:

    • ber2marc
    • ber2txt
    • bounce
    • mysql
    • ssadminbatch
    • zclient

    11. Have you customized any of the Java classes, HTML pages, or other files listed in the Bug Fix Files section of the Appendix for the Upgrade to SiteSearch 4.2.0a in any way?

    • Yes. Go to step 12.
    • No. Go to step 13.

    12. Use the UNIX diff utility to determine the differences between your customized Java classes or files and the 4.2.0a bug fix files and modify the files accordingly in your <patchdir> directory.

    13. Copy the SiteSearch 4.2.0a Java classes and files associated with the bug fixes from the <patchdir> directory to your <WebZTest_root> environment. If a directory does not exist in <WebZTest_root>, you will need to create it. Recompile any class you modified in step 12 in the <WebZTest_root> environment. Copying the source code files to your <WebZTest_root> environment is optional.
    14. Create a new directory, such as <420jar>, in the <WebZTest_root>/classes/lib directory. Move the SS4_2_0.jar and SS4_2_0full.jar to the new <420jar> directory so that only the current SS4_2_0a.jar and SS4_2_0afull.jar remain in the <WebZTest_root>/classes/lib directory.
    15. Restart the Web server, SQL server (if necessary), WebZ system, and the Record Builder application (if applicable) in <WebZTest_root>. Click here for more information for UNIX; click here for more information for Windows NT.

    16. Test the <WebZTest_root> environment. Start a new WebZ user session in a Web browser, and perform several searches. Make sure to check all of the WebZ functionality through the interface, such as:

    Test the Record Builder application (if applicable) in the <WebZTest_root> environment. Start the Web server, SQL server (if necessary), and Record Builder. Start a new Record Builder user session in a Web browser. Make sure to check all of the Record Builder functionality through the interface, such as:

    Test the Database Builder application (if applicable) in the <WebZTest_root> environment using SSDOT.

    Debug any problems that have been introduced with this integration using the Troubleshooting the WebZ System document.

    17. Follow the same steps to upgrade your production <WebZ_root> environment to SiteSearch 4.2.0a. Remember to make the following changes specific to your <WebZ_root> environment.

    • Change <WebZTest_root> to <WebZ_root>.
    • Change SITESEARCHROOT to your <WebZ_root> directory in steps 4 and 5.

    Return to Contents

    Appendix

    The document Appendix for the Upgrade to SiteSearch 4.2.0a contains the appendix referenced in this procedure.

    See Also

    Description of the Open SiteSearch 4.2.0a Release
    [Home] [Documentation] [Support] [Search]

    Last Modified: