Main -> Documentation -> Product Updates -> Upgrading to Open SiteSearch 4.1.1

Upgrading to Open SiteSearch 4.1.1

 

Table of Contents

Introduction
Requirements
Document Conventions
Determining Your Upgrade Path
Applying 4.1.1 Bug Fixes to an Existing SiteSearch Environment (WebZ-only sites)
Upgrading from Version 4.1.0/4.1.0a to a Complete 4.1.1 Environment
     – WebZ Upgrade Procedure
     – Database Builder Upgrade Procedure
Appendices

Introduction

This document provides instructions for integrating customizations from an existing SiteSearch 4.1.1 environment into the Open SiteSearch 4.1.0/4.1.0a software on UNIX or Windows NT systems.

WARNING: If you have customized your SiteSearch environment, you must follow one of the upgrade procedures described in this document. DO NOT install the 4.1.1 software package into your existing environment. You will lose all of your changes by installing version 4.1.1 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.1.0 or 4.1.0a environment.
  • <TempDir_root> refers to the directory where you install the Open SiteSearch 4.1.1 software.
  • <NewWebZ_root> refers to a directory with a copy of your existing 4.1.0 environment. You integrate changes from version 4.1.1 into <NewWebZ_root>, while allowing patrons to access the <WebZ_root> environment during the upgrade.
  • <fullpath to JDK> is the full path to your Java Development Kit (JDK) installation.
  • 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.

Determining Your Upgrade Path

Ask yourself the following questions to determine how to proceed with upgrading your existing SiteSearch environment. While it is quicker to install only the bug fixes, you lose the opportunity to take advantage of the new features available in version 4.1.1 by installing only the bug fixes.

1. Are you using OCLC Database Builder?

  • Yes. Go to Question 3.
  • No. Go to Question 2.

2. Do you want to install bug fixes only or bug fixes and enhancements? OCLC recommends that you upgrade to a complete 4.1.1 environment.

3. Have you customized SiteSearch in ANY way?

Applying 4.1.1 Bug Fixes to an Existing SiteSearch Environment (for WebZ-only Sites)

For WebZ-only environments, the following procedure describes how to integrate 4.1.1 bug fixes into an existing 4.1.0/4.1.0a environment with the SS4_1_1.jar file. This procedure will not work for environments that include Database Builder.

By completing the steps below, you receive only the bug fixes made to the SiteSearch software in the 4.1.1 release. To integrate the complete 4.1.1 software package with an existing environment, see Upgrading from Version 4.1.0/4.1.1 to a Complete 4.1.1 Environment.

1. Have you downloaded any patches or bug fixes containing Java class files from the SiteSearch FTP site?

  • Yes. Delete these class files before proceeding to step 2.
  • No. Go directly to step 2.

2. Back up your existing environment in a separate directory.

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

3. Create a temporary directory (<TempDir_root>) and install the SiteSearch 4.1.1 WebZ component in this directory.

4. Copy the SS4_1_1.jar file from the <TempDir_root>/classes/lib directory into the <WebZ_root>/classes/lib directory. There should now be two .jar files in the <WebZ_root>/classes/lib directory, SS4_1_0.jar and SS4_1_1.jar.

5. Edit your CLASSPATH environment variable to read the SS4_1_1.jar file.

An example of the required CLASSPATH statements follows.

.:<fullpath to JDK>/lib/classes.zip:<WebZ_root>/classes/: \
<WebZ_root>/classes/lib/SS4_1_1.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.

6. Edit the ssmgr.hostname file (in the <WebZ_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.1.1 version of the software.

# What version of SiteSearch is installed
SSVERSION=4_1_1

7. Edit the ssadmin file (in the <WebZ_root>/scripts directory) in a text editor. Change the item shown in to reflect the 4.1.1 version of the software: 

SSVERSION=4_1_1

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

  • ber2marc
  • ber2txt
  • bounce
  • ssadminbatch
  • zclient

9. Test the <WebZ_root> environment. Start the Web server, SQL server (if necessary), and the WebZ system. 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:

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

Upgrading from Version 4.1.0/4.1.0a to a Complete 4.1.1 Environment

The following procedures describe how to integrate changes in version 4.1.1 into to your existing 4.1.0/4.1.0a environment. Follow the instructions below carefully to preserve the changes you have made to the SiteSearch software. Print these instructions and use them as a checklist for upgrading your environment. See Description of the Open SiteSearch 4.1.1 Release for a description of the software upgrades included in version 4.1.1.

The upgrade involves:

  • Making a copy of your existing 4.1.0/4.1.0a environment in a new directory, <NewWebZ_root>.
  • Installing the 4.1.1 software in another directory, <TempDir_root>.
  • Applying the changes in version 4.1.1 to <NewWebZ_root> by:
    • Copying files from <TempDir_root> to <NewWebZ_root>.
    • Editing configuration files in <NewWebZ_root>.
    • Editing existing files in <NewWebZ_root> to make them identical to their <TempDir_root> counterparts.

There are two procedures in this section, one for WebZ and one for Database Builder. If your environment includes Database Builder, you must complete the WebZ upgrade before you begin the Database Builder upgrade.

Important: Perform and test these instructions in a test environment before implementing your customized 4.1.1 software in a production environment.

WebZ Upgrade Procedure

1. Make a copy of your existing 4.1.0 environment in a new directory (<NewWebZ_root>).

  • Stop the Web server, the WebZ system, and, if you are providing user authorization through the WebZ interface, the SQL server in your <WebZ_root> environment.
  • Copy the <WebZ_root> environment into the <NewWebZ_root> directory.
  • Restart the Web server, SQL server, and WebZ system in <WebZ_root>.

You will work in the <NewWebZ_root> directory during this procedure, while still providing patron access to the <WebZ_root> environment until you complete the upgrade.

Note:  

<NewWebZ_root> becomes your new <WebZ_root> environment after you complete these upgrade instructions.

2. Create a new directory (<TempDir_root>) for installing the 4.1.1 software.

3. Install all the version 4.1.1 SiteSearch components you have licensed in <TempDir_root>. See Installing and Configuring the Open SiteSearch Suite for an overview of the installation process and the links in that document for installation instructions for each SiteSearch component.
4. Copy the SS4_1_1.jar file from the <TempDir_root>/classes/lib directory into the <NewWebZ_root>/classes/lib directory. There should now be two .jar files in the <NewWebZ_root>/classes/lib directory, SS4_1_0.jar and SS4_1_1.jar.

5. Edit your CLASSPATH environment variable for the 4.1.1 environment. Your CLASSPATH must contain the following information:

        .: <fullpath to JDK>/lib/classes.zip:\
        <NewWebZ_root>/classes/:\
        <NewWebZ_root>/classes/lib/SS4_1_1.jar:\
        <NewWebZ_root>/classes/lib/mail.jar:\
        <NewWebZ_root>/classes/lib/activation.jar
Note:

(1) In the example above, 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 example.

(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.

6. Edit the ssmgr.hostname file (in the <NewWebZ_root>/scripts directory), where hostname is the name of the host system where your existing Open SiteSearch environment is installed, in a text editor. Change the values of the ROOTDIR and SSVERSION variables at the top of the file to reflect the 4.1.1 version of the software, as follows:

# Where SiteSearch is installed
ROOTDIR=<NewWebZ_root>

# What version of SiteSearch is installed
SSVERSION=4_1_1

7. Edit the ssadmin file (in the <NewWebZ_root>/scripts directory) in a text editor. Change the values of the ROOTDIR, CLASSES, and SSVERSION variables to reflect the 4.1.1 version of the software, as shown below:

ROOTDIR=<NewWebZ_root>
JAVAHOME=<fullpath to JDK> 
CLASSES=<NewWebZ_root> 
SSVERSION=4_1_1

8. Use a text editor to edit the ROOTDIR, CLASSES, and SSVERSION variables (as you did for ssadmin in Step 7) in the following files in <NewWebZ_root>/scripts:

  • ber2marc
  • ber2txt
  • bounce (has only ROOTDIR and SSVERSION variables)
  • ssadminbatch
  • zclient

9. Are you running SiteSearch in a UNIX environment?

  • Yes. Are you using the Apache Web server?
    • Yes. Go to step 10 to upgrade Apache from version 1.3.6 to version 1.3.11. Although the Apache upgrade is optional, OCLC recommends it.
    • No. Make any modifications necessary to the Netscape Web server to run the SiteSearch 4.1.1 environment in <NewWebZ_root>. Then go to step 13.
  • No.
    • Make any any modifications necessary to your Web server to run the SiteSearch 4.1.1 test environment in <NewWebZ_root>.
    • Are you using the WebZ Access component and a corresponding SQL database?
      • Yes. Make sure that the SQL database can run the Access database for the <NewWebZ_root> environment without interfering with the Access database in your production environment. Then go to step 18.
      • No. Go to step 19.
10. Copy the <TempDir_root>/httpd/apache_1.3.11 directory, its subdirectories, and the contents of these subdirectories to the <NewWebZ_root>/httpd directory.

11. Edit <NewWebZ_root>/httpd/apache_1.3.11/httpd.conf:

  • Modify the variables with path references in <NewWebZ_root>/httpd/apache_1.3.11/httpd.conf so that they refer to <NewWebZ_root> instead of <TempDir_root>. Appendix A lists these variables.
  • Select a different Web server port for testing the <NewWebZ_root> environment than the one used for the 4.1.0 production environment and modify the Port variable in httpd.conf accordingly.

12. Edit the HTTPDROOTDIR line in the apache script in <NewWebZ_root>/scripts/ so that it refers to the apache_1.3.11 directory in <NewWebZ_root>, like this:

# Where SiteSearch is installed
HTTPDROOTDIR=<NewWebZ_root>/httpd/apache_1.3.11

13. Are you using mSQL as part of your WebZ Access component?

14. Remove the following files from <NewWebZ_root>/msql/bin/:

  • msqlconvert
  • msqlexport
  • msqlimport

15. Copy the mSQL files listed in Appendix B from <TempDir_root> to <NewWebZ_root>.

16. Edit these two lines in the [general] section of <NewWebZ_root>/msql/msql.conf:

Inst_Dir  = <NewWebZ_root>/msql
TCP_Port  = mSQL_port

Use a different mSQL port than the one you are using in your 4.1.0 production environment.

17. Edit the ROOTDIR line in the msql script in the <NewWebZ_root>/scripts directory so that it refers to <NewWebZ_root>, like this:

# Where SiteSearch is installed
ROOTDIR=<NewWebZ_root>

18. Change the value of the URL variable in the [JDBC] section of <NewWebZ_root>/ini/AccessServer.ini so that it contains the SQL port number you are using to test the <NewWebZ_root> environment. For mSQL, you changed this port in step 16 and the syntax of the variable is as follows:

[JDBC]
SQLDriver=com.imaginary.sql.msql.MsqlDriver
URL=jdbc:msql://bongo:mSQL_port/accessdb

19. Change the path from <WebZ_root> to <NewWebZ_root> in the configuration (.ini) files listed in Appendix C. Appendix C lists the variables in each .ini file for which you need to modify the path.

20. If <NewWebZ_root>/ini/databases.ini contains these lines, delete them:

db* = dbs/ERES.ini
db* = dbs/CARC.ini

21. Delete <NewWebZ_root>/ini/dbs/CARC.ini and <NewWebZ_root>/ini/dbs/ERES.ini if they exist.

22. Make the changes to <NewWebZ_root>/ini/servers/IllService.ini shown in Appendix D.

23. Other than MarcCatalogIllRules.ini, have you modified any of the formatting configuration files shown in Appendix B under /ini/format/obiv1 in your 4.1.0 environment?

  • Yes. Add the line shown in blue bold print to the [isoill] display specification just above the rule*=IllBibVerification line, as shown: 
    ...
rule* = ILLBibLCCN
rule* = ILLBibVerification
  • No. Copy <TempDir_root> version of each of these formatting configuration files to <NewWebZ_root>/ini/format/obiv1, thus overwriting the existing files.

24. Have you modified the <WebZ_root>/ini/format/obiv1/MarcCatalogIllRules.ini file in your 4.1.0 environment?

  • Yes. Add the [ILLBibLCCN] section to <NewWebZ_root>/ini/format/obiv1/MarcCatalogIllRules.ini, as follows: 
[ILLBibLCCN]
displayname = LCCN
illEntity = BibLCCN
field* = 10/1
class = ORG.oclc.fmts.rules.AddILLData
  • No. Copy <TempDir_root>/ini/format/obiv1/MarcCatalogIllRules.ini to <NewWebZ_root>/ini/format/obiv1, thus overwriting the existing file.

25. Have you modified <WebZ_root>/htdocs/obiv1/html/blankillform.html in your 4.1.0 environment?

  • Yes. Edit <NewWebZ_root>/htdocs/obiv1/html/blankillform.html to change the SIZE and MAXLENGTH parameters of the Copyright Compliance field from 3 to 6. Change: 
    <th align="left">&StyleTable.fonts.illFormLabel; \
    <B>Copyright Compliance:</b></th><td align="left"> \
    <INPUT NAME="CopyrightCompliance" \
    value="&tempCopyrightCompliance"; \
    SIZE=3 MAXLENGTH=3    ></font></td>

    to this:

    <th align="left">&StyleTable.fonts.illFormLabel; \
    <B>Copyright Compliance:</b></th><td align="left"> \
    <INPUT NAME="CopyrightCompliance" \ 
    value="&tempCopyrightCompliance;" \
    SIZE=6 MAXLENGTH=6></font></td>
  • No. Copy <TempDir_root>/htdocs/obiv1/html/blankillform.ill to <NewWebZ_root>, thus overwriting the existing version of this file.

26. Have you modified <WebZ_root>/htdocs/obiv1/html/dblist.html in your 4.1.0 environment?

  • Yes. Edit <NewWebZ_root>/htdocs/obiv1/html/dblist.html. Add the valign="top" statements shown in bold blue print below: 
    <BODY 
     bgcolor="&StyleTable.colors.bgcolor;"
     text="&StyleTable.colors.text;"
      link="&StyleTable.colors.link;"
      vlink="&StyleTable.colors.vlink;"
      alink="&StyleTable.colors.alink;">
      <p>&nbsp;
      <table>
        <tr>
          <td align="left" valign="top">
          <TABLE align="left">
        <TR>
          <TD valign="top">
  • No. Copy <TempDir_root>/htdocs/obiv1/html/dblist.html to <NewWebZ_root>, thus overwriting the existing version of this file.

27. Review the Java classes modified in SiteSearch 4.1.1, as listed in Appendix B. Have you modified any of these classes in any way in your 4.1.0 environment?

  • Yes. For each file you have modified:
    • Use the UNIX diff utility (or another utility that can identify the differences between two files) to identify the differences between the 4.1.1 version in <TempDir_root> and the customized 4.1.0 file in <NewWebZ_root>.
    • Edit the customized class in <NewWebZ_root> accordingly.
    • Recompile the customized class.

For the files you did not modify, overwrite the <NewWebZ_root> version of each file in Appendix B that you did not customize (and its corresponding .class file ) with its <TempDir_root> counterpart. Remember to copy the files where source code is not provided (MARCDIRECTORY.class, MARCFIXED8.class, and MARCLEADER.class) as well.

  • No. Overwrite the <NewWebZ_root> version of each file (and its corresponding Class file) in Appendix B with its <TempDir_root> counterpart. Remember to copy the files where source code is not provided (MARCDIRECTORY.class, MARCFIXED8.class, and MARCLEADER.class) as well.
28. Copy the 4.1.1 API (Javadoc) from <TempDir_root>/htdocs/obiv1/help to <NewWebZ_root>/htdocs/obiv1/help.

29. Test the <NewWebZ_root> environment. Start the Web server, SQL server (if necessary), and the WebZ system. 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:

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

30. When you are satisfied that the <NewWebZ_root> environment is functioning properly, make it your new production environment.

WebZ-only sites: Change the Web server port and SQL database port in <NewWebZ_root> to the ports that you use in the production environment. Recall that you modified these ports so that you could upgrade and test the <NewWebZ_root> environment without interfering with your production environment.

  • In a UNIX environment with the Apache Web server, change the Web server port in <NewWebZ_root>/httpd/apache_1.3.11/conf/httpd.conf.
  • In a UNIX environment where you are using mSQL, change the mSQL port in <NewWebZ_root>/msql/msql.conf (TCP_Port variable in the [general] section) and <NewWebZ_root>/ini/AccessServer.ini (URL variable in the [JDBC] section).
  • For other Web servers or SQL databases, see the appropriate documentation for port changes or other modifications necessary to make <NewWebZ_root> your new production environment.
Sites with both WebZ and Database Builder: Change only the Web server port until after you complete the Database Builder upgrade procedure.

31. Are you using Database Builder?

 

Database Builder Upgrade Procedure

This procedure applies only to SiteSearch environments that include Database Builder.

Assumptions:  

(1) You have completed the WebZ upgrade procedure before you start this procedure.

(2) You have not modified the Record Builder interface or its underlying Java classes..

1. Shut down the Record Builder application (click here for the UNIX shutdown procedure; click here for the Windows NT shutdown procedure).

2. Overwrite the <NewWebZ_root> version of each of the database utilities modified in SiteSearch 4.1.1 (as listed in Appendix E) with its <TempDir_root> counterpart.
3. Follow the procedure outlined in Moving the SSDOT Environment to modify the <NewWebZ_root>/dbbuilder/ssdot/exes/ssdot.ini file. Change all references from <WebZ_root> to <NewWebZ_root> in ssdot.ini.

4. Edit the <NewWebZ_root>/dbbuilder/ssdot/ssdot file (the startup command for SSDOT), so that it refers to ssdot-script.pl in <NewWebZ_root>:

#!/bin/sh
exec /usr/local/bin/perl  \ 
<NewWebZ_root>/dbbuilder/ssdot/exes/ssdot-script.pl $*
5. Start the SSDOT program, located in <NewWebZ_root>/dbbuilder/ssdot. Type "l" and press Enter to list the registered databases within the 4.1.1 SSDOT environment. Verify that all of your local databases are recognized in the 4.1.1 environment. Exit SSDOT.

6. Edit the <NewWebZ_root>/dbbuilder/ssdot/info/db_name.reg file (where db_name is the database's name) for each local database. Change all path references to <WebZ_root> to <NewWebZ_root>.

Note:  

The rest of this procedure pertains to upgrading Database Builder's Record Builder application. If you do not use or are not planning to use Record Builder, these steps are optional. However, OCLC recommends that all sites upgrade Record Builder to version 4.1.1 so that you have the most recent version available if you subsequently plan to use it.

7. Edit the ssadmin_rb file (in the <NewWebZ_root>/scripts directory). Change the values of the ROOTDIR, CLASSES, and SSVERSION variables to reflect the 4.1.1 version of the software, as shown below:

ROOTDIR=<NewWebZ_root>
JAVAHOME=<fullpath to JDK> 
CLASSES=<NewWebZ_root> 
SSVERSION=4_1_1

8. Are you running SiteSearch in a UNIX environment?

  • Yes. Are you using the Apache Web server?
    • Yes. Go to step 9.
    • No. Make any modifications necessary to the Netscape Web server to run the Record Builder application in the SiteSearch 4.1.1 test environment in <NewWebZ_root>. Then go to step 11.
  • No.
    • Make any any modifications necessary to your Web server to run the Record Builder application in the SiteSearch 4.1.1 test environment in <NewWebZ_root>.
    • Are you using the WebZ Access component for Record Builder and a corresponding SQL database?
      • Yes. Make sure that the SQL database can run the Access database for Record Builder in the <NewWebZ_root> environment without interfering with the Access database in your production environment.

        Copy <TempDir_root>/accessdb/rbv0/rbdb.sql (the sample SQL database file) to <NewWebZ_root>.

        Then go to step 13.

9. Edit <NewWebZ_root>/httpd/apache_1.3.11/httpd_rb.conf.

  • Modify the variables with path references in <NewWebZ_root>/httpd/apache_1.3.11/httpd_rb.conf so that they refer to <NewWebZ_root> instead of <TempDir_root>. Appendix A lists these variables.
  • Select a different Web server port for testing Record Builder in the <NewWebZ_root> environment than the one used for the 4.1.0 production environment. Modify the Port variable in httpd_rb.conf accordingly.

10. Edit the HTTPDROOTDIR line in the apache_rb script in <NewWebZ_root>/scripts/ so that it refers to the apache_1.3.11 directory in <NewWebZ_root>, like this:

# Where SiteSearch is installed
HTTPDROOTDIR=<NewWebZ_root>/httpd/apache_1.3.11

11. Are you using mSQL as part of your Record Builder Access component?

  • Yes. Copy these files from <TempDir_root> to the appropriate directories in <NewWebZ_root>:
    • /msql/rbdb.dump
    • /scripts/msql_rb

    Then go to step 12.

  • No. Go to step 14.

12. Edit the ROOTDIR line in the msql_rb script in <NewWebZ_root>/scripts/ so that it refers to <NewWebZ_root>, like this:

# Where SiteSearch is installed
ROOTDIR=<NewWebZ_root>

13. Change the value of the URL variable in the [JDBC] section of <NewWebZ_root>/ini/AccessServer_rb.ini so that it contains the SQL port number you are using to test the <NewWebZ_root> environment. For mSQL, you changed this port in step 16 of the WebZ upgrade and the syntax of the variable is as follows:

[JDBC]
SQLDriver=com.imaginary.sql.msql.MsqlDriver
URL=jdbc:msql://bongo:mSQL_port/accessdb
14. Change the path from <WebZ_root> to <NewWebZ_root> in the Record Builder configuration (.ini) files listed in Appendix C (the files that end with "_rb.ini"). Appendix C lists the variables in each .ini file for which you need to modify the path.

15. Edit <NewWebZ_root>/ini/ZBaseServer_rb.ini. Change the value of the inifile variable in the [AccessServer] section from Access.ini to Access_rb.ini, as follows:

[AccessServer]
inifile        = Access_rb.ini

16. Copy each of the new and modified Java classes for Record Builder listed in Appendix E from <TempDir_root> to the appropriate location in <NewWebZ_root>.
17. Copy each of the new and modified HTML and image files listed in Appendix E from <TempDir_root> to the appropriate location in <NewWebZ_root>.
18. Follow the procedure outlined in Removing a Registered Database in SSDOT to remove registration information for the ARCH, ERES, dc, and save databases from SSDOT in <NewWebZ_root>.

19. Remove all files associated with the ARCH and ERES databases in <NewWebZ_root>:

  • <NewWebZ_root>/dbbuilder/dbs/arch directory (and all subdirectories)
  • <NewWebZ_root>/dbbuilder/dbs/eres directory (and all subdirectories)
  • <NewWebZ_root>/htdocs/dbdata/arch directory
  • <NewWebZ_root>/htdocs/dbdata/eres directory
  • <NewWebZ_root>/ini/dbs/localARCH.ini, localARCH_rb.ini, localERES.ini, and localERES_rb.ini

20. Copy all the files associated with the dc and save databases in <TempDir_root> (see Appendix E) to the analogous directories in <NewWebZ_root>, thus overwriting the existing files in <NewWebZ_root>. Then copy <TempDir_root>/ini/dbs/localdc_rb.ini and <TempDir_root>/ini/dbs localSave_rb.ini to <NewWebZ_root>/ini/dbs.

21. Copy all the files associated with the new sample databases (parks and scores) from <NewWebZ_root> to the analogous directories in <TempDir_root>:

  • <NewWebZ_root>/dbbuilder/dbs/parks directory (and all subdirectories)
  • <NewWebZ_root>/dbbuilder/dbs/scores directory (and all subdirectories)
  • <NewWebZ_root>/htdocs/dbdata/parks directory (and all subdirectories)
  • <NewWebZ_root>/htdocs/dbdata/scores directory
  • <NewWebZ_root>/ini/dbs/localparks_rb.ini and localscores_rb.ini
22. Start the SSDOT program, located in <NewWebZ_root>/dbbuilder/ssdot. Register the parks, scores, and save databases in SSDOT.

23. What operating platform are you using to run SiteSearch?

  • UNIX. Create a symbolic link to the <NewWebZ_root>/htdocs/dbdata directory in the <NewWebZ_root>/htdocs/obiv1 and <NewWebZ_root>/htdocs/rbv0 directories:
    • Change directories to <NewWebZ_root>/htdocs/dbdata.
    • Enter the following commands: 
    ln -s ../dbdata <NewWebZ_root>/htdocs/obiv1
ln -s ../dbdata <NewWebZ_root>/htdocs/rbv0
  • Windows NT. Create a shortcut to the <NewWebZ_root>/htdocs/dbdata directory in the <NewWebZ_root>/htdocs/obiv1 and <NewWebZ_root>/htdocs/rbv0 directories:

24. Edit <TempDir_root>/ini/databases_rb.ini, as follows:

  • Add these lines: 
    db* = dbs/localparks_rb.ini
db* = dbs/localscores_rb.ini
  • Remove these lines: 
    db* = dbs/localERES_rb.ini
db* = dbs/localARCH_rb.ini

25. Have you modified any of the Record Builder formatting configuration files (/ini/format/rbv0) or interface style configuration files (/ini/interface/rbv0) files listed in Appendix E in your <WebZ_root> environment?

  • Yes. For each file you have modified:
    • Use the UNIX diff utility (or another utility that can identify the differences between two files) to identify the differences between the 4.1.1 version in <TempDir_root> and the customized 4.1.0 file in <NewWebZ_root>.
    • Edit the file in <NewWebZ_root> accordingly.

For the files you did not modify, overwrite the <NewWebZ_root> version of each the formatting configuration and interface style configuration files in Appendix E that you did not customize with its <TempDir_root> counterpart.

26. Test the Record Builder application in the <NewWebZ_root> environment. Start the Web server, SQL server (if necessary), and Record Builder (click here for the UNIX startup procedure; click here for the Windows NT startup procedure). 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:

  • adding, modifying, and deleting records
  • browsing for records
  • user authorization

27. When you are satisfied that the Record Builder application in the <NewWebZ_root> environment is functioning properly, make it your production version. Change the Web server port and SQL database port in <NewWebZ_root> to the ports that you use in the production environment. Recall that you modified these ports so that you could upgrade and test the <NewWebZ_root> environment without interfering with your production environment.

  • In a UNIX environment with the Apache Web server, change the Web server port in <NewWebZ_root>/httpd/apache_1.3.11/conf/httpd_rb.conf.
  • In a UNIX environment where you are using mSQL, change the mSQL port in <NewWebZ_root>/msql/msql.conf (TCP_Port variable in the [general] section) and <NewWebZ_root>/ini/AccessServer.ini (URL variable in the [JDBC] section), and <NewWebZ_root>/ini/AccessServer_rb.ini (URL variable in the [JDBC] section).
  • For other Web servers or SQL databases, see the appropriate documentation for port changes or other modifications necessary to make the Record Builder application in <NewWebZ_root> your new production version of this application.

Appendices

The document Appendices for the SiteSearch 4.1.1 Upgrade contains each appendix referenced in these procedures. Each appendix includes links to the procedure steps in this document that refer to it.

See Also

Installing the WebZ (Web Server) Extension (Version 4.1.x)
Installing WebZ (Version 4.1.x)
Installing Database Builder (Version 4.1.x)
Description of the Open SiteSearch 4.1.1 Release
Appendices for the Open SiteSearch 4.1.1 Upgrade

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

Last Modified: