Installing Database Builder (Version 4.1.2a)

Main -> Documentation -> Getting Started -> Installing and Configuring the Open SiteSearch Suite -> Installing Database Builder (Version 4.1.2a)

Installing Database Builder (Version 4.1.2a)

Contents

Introduction
Requirements
Document Conventions
Installation Methods
UNIX Installation Procedure
Windows NT Installation Procedure

Introduction

This document explains how to install version 4.1.2a of the SiteSearch Database Builder. SiteSearch 4.1.2a includes all the new features, software enhancements, and bug fixes included in SiteSearch 4.1.2, as well as additional enhancements and bug fixes.

The Open SiteSearch Database Builder installation process installs the database utility programs, the SiteSearch Database Operations Tool (SSDOT), the Record Builder application, and a local test database (localERIC) on your host system.

See Installing Database Builder (Version 4.1.0/4.1.1) and Installing Database Builder (Version 4.0.x) for installing previous versions of Database Builder.

Requirements

Before completing this installation, review the information in the Installing and Configuring the Open SiteSearch Suite and OCLC SiteSearch Suite System Requirements documents to ensure that you meet the system requirements and have all of the information that you need to install Database Builder successfully.

If you have not already installed the Web server/WebZ Extension and the WebZ software, OCLC recommends that you do so before you install the Database Builder software.

Return to Contents

Document Conventions

<WebZ_root> refers to the location of your WebZ environment.
<WebServer_root> refers to the location of your Web server.
Items or commands you must type appear in single quotes, like this: "apache". Type them without the quotes.

Return to Contents

Record Builder and Web Servers

The Database Builder installation includes Record Builder, Record Builder is an end-user application built on WebZ technology that harnesses Database Builder's administrative utilities to allow the creation, modification, and maintenance of Newton searchable databases for local collections of such things as images, sound files, Web sites, and data. The Database Builder installation automatically installs Record Builder, but its use is optional.

For UNIX, the Database Builder installation asks you to specify the Web server port for Record Builder. If you are using the Apache Web server provided as part of the WebZ/Web Server Extension installation for UNIX systems, or a Netscape Web server, specify a different port for Record Builder's Web server than the one you selected for WebZ.

For Windows NT, you specify the Web server port for Record Builder when you configure the Web server (Netscape or Microsoft Internet Intermation Server (IIS). It should be a different port than the one you selected for WebZ. If you are using IIS as your Web server, it is not possible to run WebZ and Record Builder simultaneously on a single machine. Your options are to:

Use Netscape as your Web server, which will allow you to run WebZ and Record Builder simultaneously on the same machine
Use IIS as the Web server for a WebZ-only environment and Netscape as the Web server for a Record Builder-only environment or a WebZ/Record Builder environment
Use Netscape as the Web server for a WebZ-only environment and IIS as the Web server for a Record Builder-only environment
Use IIS as the Web server for a WebZ-only environment on one machine and IIS as the Web server for a Record Builder-only environment on another machine

Return to Contents

Installation Methods

There are two installation methods for Database Builder, one for UNIX users and the other for Windows NT users:

UNIX installation. The UNIX installer uses a Perl script.
Windows NT installation. The Windows NT installer is an InstallShield installation with a graphical user interface.

Return to Contents

UNIX Installation Procedure

Before you install the Database Builder software, read the instructions below. You should have the following installation files:

ss4_1_2a.dbbuilder.tar.Z
DbBuilderInstaller_4_1_2a.sh

Time Required for Installation

Plan on about 10 to 15 minutes to install Database Builder using the Perl script. The specific time required depends on the speed of your processor and the system load at the time you perform the installation.

Directions

Follow the instructions below to install Database Builder using Perl scripts.

Note:

Install Database Builder under the same user name (user account) that you used to install the WebZ Extension and WebZ. To conform to good UNIX system administration practices, we recommend that you do not use root as the user name.

1. Copy the ss4_1_2a.dbbuilder.tar.Z and DbBuilderInstaller_4_1_2a.sh files into the <WebZ_root> directory.

2. Type "DbBuilderInstaller_4.1.2a.sh" at the command prompt in the <WebZ_root> directory and press Enter to execute the installation scripts.

3. You see the following prompt:

*********************************************************
Installing the Open SiteSearch Database Builder - 4_1_2a.
*********************************************************
Do you want to continue? [y]

Press Enter or type "y".

4. You receive a series of prompts asking you for information needed to complete the installation. Accept the default value that appears by pressing Enter at the prompt (a bracketed value appears after most prompts; this is the default). If there is no default or the default value is incorrect, type the necessary information and press Enter. Definitions of each prompt, in the order in which they appear, follow.

Prompt	Description	Example
Directory of Perl interpreter	Full path name of the Perl interpreter on the host system.	/usr/local/bin/perl
DbBuilder Installation Directory	Full path name of the directory where you wish to install Database Builder.	/sitesearch/ss_prod
WebZ Installation Directory	Full path name of the <WebZ_root> directory	/sitesearch/ss_prod
Operating System	Operating system of your host environment. Enter the value for your operating system from those shown: "aix" (AiX) "osf1" (DIGITAL UNIX) "linux" (LINUX) "irix" (IRIX) "sol" (Solaris)	sol
SSDOT Environment	Specific environment name for the Database Builder SSDOT program. This name appears in SSDOT menus to distinguish between multiple copies of SSDOT. This is useful if, for example, each institution in a consortium wishes to have a separate copy of SSDOT for the local databases it maintains. This allows you to determine which environment you are working in while running the SSDOT program.	SiteSearch SSDOT
Web Server	Web server type for Record Builder (Apache or Netscape). Enter the value for your operating system from those shown. This is normally the same Web server you use for WebZ.	apache
JDK Location	Full path name of the Java Development Kit (JDK) on the host system.	/usr/local/java/java1.2.2
User Interface Version	User interface version for Record Builder. For SiteSearch 4.1.2a, this must be the default, rbv0.	rbv0
Web Server Document Root Directory	Full path name of the directory that contains the Web server HTML files for the Record Builder interface. This should be a different directory than the Web Server Document Root Directory for the WebZ interface, although it should normally be a directory underneath <WebZ_root>/htdocs and is typically <WebZ_root>/htdocs/rbv0.	<WebZ_root>/htdocs/rbv0
Web Server CGI-BIN Directory	Full path name of the directory that contains any Common Gateway Interface (CGI) scripts used for the Web server and Record Builder operations. This is usually the same directory you defined as the Web Server CGI-BIN directory during the WebZ/Web Server Extension installation.	<WebServer_root>/cgi-bin
Host Name	Name of the host system of the Web server you are using for Record Builder.	dolphin.anywhere.edu
Host Name IP Address	Internet Protocol (IP) address of the host system for Record Builder's Web server.	123.174.200.32
Web Server Port	Port number where you intend to run your Web server for the Record Builder application on the host system. This MUST be a different port than the one you specified during the Web Server/WebZ Extension installation.	10085
MySQL Port	Port number of the host system that the MySQL server runs on to provide user authentication to Record Builder. The port number must be the same port you assigned as the port number for the MySQL port during the WebZ Installation and must be greater than 1024.	1115
MySQL Process Username	User name of the MySQL system administrator.	jsmith
Process Groupname	Name of the UNIX group that has file permissions to the files and directories in the <WebServer_root> directory.	referenc
MySQL Server Admin Email	Electronic mail (e-mail) address of the MySQL system administrator.	jsmith@anywhere.edu
SQLDriver Class	Fully qualified class name of the MySQL driver. The default is org.gjt.mm.mysql.Driver, which is located in the mysql_comp.jar file in the <WebZ_root>/msql/classes/lib directory.	org.gjt.mm.mysql.Driver

5. A verification screen appears. Check this screen to ensure that the information you entered is correct. An example of the verification screen is shown below.

      Directory of Perl Interpreter: /usr/local/bin/perl
DbBuilder/RB Installation Directory: <WebZ_root>
  Web Server Installation Directory: <WebServer_root>/httpd/apache_1.3.11
             WebZ Installation Root: <WebZ_root>
                       JDK Location: /usr/local/java/java1.2.2
       Web Server CGI-BIN Directory: <WebServer_root>/cgi-bin
             User Interface Version: rbv0
Web Server Document Root Directory: <WebServer_root>/htdocs/rbv0
        Web Server Process Username: jsmith
                   Web Server Group: referenc
               Host Name IP Address: 123.174.200.32
                    Web Server Port: 10085
                    Web Server Type: apache
                   Operating System: sol
                         MySQL Port: 1115
             MySQL Process Username: jsmith
           MySQL Server Admin Email: jsmith@anywhere.edu
                SQLDriver Classname: org.gjt.mm.mysql.Driver
             SSDOT Environment Name: <WebZ_root>/dbbuilder/ssdot

Is this correct? [y]

6. Is everything on the verification screen correct?

Yes. Continue the installation by pressing Enter.
No. Type "n" and press Enter to cycle through the prompts again. Edit any value that you need to change. When the verification screen appears again, press Enter to continue with the installation.

7. While the installation proceeds, you see a number of messages. If you see the following messages, ignore them. They do not affect successful completion of the installation.

files: *lARCH.ini
orig str: 'SITESEARCHROOT' change str: '<WebZ_root>'
find: **lARCH.ini : No such file or directory

Successful completion of name change.
files: *lARCH.ini.
orig str: '_FSEP_' change str: '/'
find: **lARCH.ini : No such file or directory.

Successful completion of name change.
files: *lERES.ini
orig str: 'SITESEARCHROOT' change str: <WebZ_root>'
find: **lERES.ini : No such file or directory.

Successful completion of name change.
files: *lERES.ini
orig.str: '_FSEP_' change str: '/'
find: **lERES.ini : No such file or directory

If no messages appear for a little while, do not be concerned. This part of the installation usually takes between 5 and 10 minutes.

8. When the installation script finishes, you see a message similar to the following:

-----------------------------------------
Database Builder install script Finished!
To use your localERIC database add it to 
The SiteSearch databases.ini
-----------------------------------------

creating ./config.status

Note:

Some UNIX platforms return an error message stating that the installer was unable to update the cache. However, this does not affect the installation. If you receive this message, ignore it.

9. Add the local version of the localERIC test database to your WebZ Out-of-the-Box Interface (OBI).

Open the databases.ini configuration file, located in the <WebZ_root>/ini directory, in a text editor.
Go to the [ZBaseDBs] section in the databases.ini file, and replace ERIC.ini with localERIC.ini, using the following syntax:

     dB* = dbs/localERIC.ini

Save and close the databases.ini file.

10. Check your Database Builder license for the basis of your licensing agreement. Is your Database Builder license based on the number of simultaneous users?

Yes. Verify the number of simultaneous users for which you are licensed. Go to step 11.
No. Go to step 13.

11. Open the OpServe_rb.ini configuration file (located in <WebZ_root>/ini/) with a text editor.

12. Specify the number of simultaneous Database Builder users in your license by editing the MaxSimultaneousUsers variable in the [RecordBuilderLicense] section of OpServe_rb.ini. Then save and close this file.

Note:

When the maximum number of Record Builder user sessions is already running, OpServe will not route the next user session to the appropriate JaSSI. The patron and/or staff member who tries to start a new session receives a message that the system is unavailable.

13. Is your operating system Solaris?

Yes. Are you using JDK 1.3?

Yes. Verify that the text in dark bold blue print has been added to the two places shown below in the jassi section of your ssmgr.hostname file in <WebZ_root>/scripts:

jassi)
if [ $# -eq 1 ]
  then
   java -Dfile.encoding=ISO-8859-1 ORG.oclc.jassi.JaSSI \
     $ROOTDIR/ini/JaSSIServer.ini &
else
   java -Dfile.encoding=ISO-8859-1 ORG.oclc.jassi.JaSSI \
     $ROOTDIR/ini/$ININAME &
fi
;;

Note:

The backslashes (\) are included for readability. DO NOT add them to ssmgr.hostname.

No. Go to step 14.

No. Go to step 14.

14. Are you planning to use Record Builder?

Yes. Go to step 15.
No. Go to step 18.

15. Set the startup and maximum sizes of the memory allocation pool for the JaSSIRB server. Open <WebZ_root>/scripts/ssmgr.hostname (where hostname is the name of the system where you installed your SiteSearch environment. Edit the jassi section of this file as follows

Add -Xms8m -Xmx200m, as shown in dark bold blue text:

jassi)
 if [ $# -eq 1 ] 
  then
   Java -Xms8m -Xmx200m ORG.oclc.jassi.JaSSI \
      $ROOTDIR/ini/JaSSIServer.ini &
  else
   Java -Xms8m -Xmx200m ORG.oclc.jassi.JaSSI $ROOTDIR/ini/$ININAME & 
 fi

Notes:

(1) The example uses backslashes (\) only for readability. Do not include them in your file.
(2) You may wish to refine these values based on your system configuration and your experience running Record Builder.

16. Edit the following variables in the [servername] section of <WebZ_root>/ini/JaSSIServer_rb.ini so that they read as follows:

Low UsedMemory = 20000
MedUsedMemory  = 30000
HighUsedMemory = 40000

17. If you wish to use the sample databases provided with Record Builder, register these databases with SSDOT. Use each database's top-level directory (under <WebZ_root>/dbbuilder/dbs) as the database's name in SSDOT.

18. If you are using Netscape as your Web server, configure Netscape to use the WebZ extension with Record Builder.

19. Test your WebZ and, if applicable, Record Builder, installations now.

Return to Contents

Windows NT Installation Procedure

Before you install the Database Builder software, read the instructions below. Make sure that you have the DbBuilderInstaller4_1_2a.exe installation file..

Time Required for Installation

Plan on up to 30 minutes to install Database Builder using the Windows NT installer. The specific time required depends on the speed of your processor and the system load at the time you perform the installation.

Directions

1. To start the installation, double-click the DbBuilderInstaller4_1_2a.exe file.

2. The installer searches for your Java Development Kit (JDK). After it finds the JDK, it displays a Welcome screen.

3. Click Next> at the bottom of the Welcome screen.

4. Specify the full path to the directory where you installed WebZ and the WebZ extension. If you wish, click the Browse button to locate this directory instead of entering the path in the text box. Click Next> to continue.

5. Enter information about the server where you are installing Database Builder:

Prompt	Description	Example
Server's Host Name	Full name of the server that will host SiteSearch, including Database Builder.	bongo.dev.oclc.org
Server's IP Address	Internet Protocol (IP) address of the SiteSearch host system.	132.174.211.231
Record Builder Web Server Type	Web server used for Record Builder. Select Netscape or Microsoft IIS (Internet Information Server) from the drop-down list. See Record Builder and Web servers for more information.	Netscape

Note:

The installer automatically detects the host name and the IP address of the server where you are running the installer.

Click Next> to continue.

6. Verify that the location of the following components is correct. Except for the Perl location, you should not normally need to change these values. The installer creates any subdirectories needed for these components under these top-level directories.

Prompt	Description	Example
Perl Interpreter Location	Full path to the Perl interpreter.	D:\Program Files\Perl\bin\perl
SQL Driver Class Name	The fully qualified class name of the SQL driver.	sun.jdbc.odbc.JdbcOdbcDriver

Click Next> to continue.

7. Enter information about your SQL server. Record Builder for Windows NT supports Microsoft SQL server as the relational database management system for Record Builder's access control database, as part of the SiteSearch Access component. While the installers use this information, you do not have to use the Access component to operate WebZ.

Prompt	Description	Example
SQL Driver Class Name	The fully qualified class name of the SQL driver.	sun.jdbc.odbc.JdbdOdbcDriver

Click Next> to continue.

8. Select a Typical or Custom installation by clicking the appropriate radio button:

Typical – installs Database Builder executables, SSDOT, Record Builder, and the Record Builder sample databases.
Custom – allows you to select which components to install. Select this option if you would like to install Record Builder without its sample databases.

Click Next> to continue.

9. The installer displays a confirmation screen, which includes the <WebZ_root> directory, the components that will be installed, and the amount of disk space required for the installation. Click:

Next> to begin installing files.
Back> to modify the list of components to be installed.

10. While the installation proceeds, you can follow its progress by reading the messages displayed and the progress bar.

11. When the installer completes, click Finish to end the installation.

12. Check your Database Builder license for the basis of your licensing agreement. Is your Database Builder license based on the number of simultaneous users?

Yes. Verify the number of simultaneous users for which you are licensed. Go to step 13.
No. Go to step 14.

13. Specify the number of simultaneous Record Builder users in your license:

Open the OpServe.ini configuration file (located in <WebZ_root>\ini\) with a text editor.
Edit the MaxSimultaneousUsers variable in the [RecordBuilderLicense] section.
Save and close OpServe.ini.

Note:

When the maximum number of Record Builder user sessions is already running, OpServe will not route the next user session to the appropriate JaSSI. The staff member who tries to start a new session receives a message that the system is unavailable.

14. Are you planning to use Record Builder?

Yes. Go to step 15.
No. Go to step 16.

15. Set the startup and maximum sizes of the memory allocation pool for the JaSSIRB server. Open the <WebZ_root>\scripts\ssmgr.bat file. Edit the jassi section of this file as follows:

Add -Xms8m -Xmx200m to the second line and -Xms45m and -Xmx55m to the third line, as shown in dark bold blue text:

:jassi
        echo "Starting JaSSI"
        if "%2"=="" javaw -Xms8m -Xmx200m -DCOMPILER=NONE
           ORG.oclc.jassi.JaSSI "%ROOTDIR%\\ini\\JaSSIServer.ini"
        if "%2"=="JaSSIServer_rb.ini" javaw -Xms45m -Xmx55m
           -DCOMPILER=NONE ORG.oclc.jassi.JaSSI
           "%ROOTDIR%\\ini\\JaSSIServer_rb.ini"
        GOTO END

Notes:

(1) Keep the statements that begin with "if" on one line. The example uses indents only for readability.
(2) You may wish to refine these values based on your system configuration and your experience running Record Builder.

16. Edit the following variables in the [servername] section of <WebZ_root>\ini\JaSSIServer_rb.ini so that they read as follows:

LowUsedMemory = 45000
MedUsedMemory = 50000
HighUsedMemory = 55000

17. Edit the StartThreshold and StopThreshold variables in the [JaSSI] and [JaSSIRB] sections of <WebZ_root>\ini\OpServe_rb.ini so that they read as follows:

StartThreshold = 4.0
StopThreshold = 2.25

18. Configure your Web server to use the WebZ extension with Record Builder.

For the Netscape Web server, see the Record Builder procedure in Configuring Netscape to Use the WebZ Extension.
For the IIS Web server, see the Record Builder procedure for SiteSearch 4.1.2a in Configuring Microsoft Internet Information Server (IIS) to Use the WebZ Extension.

19. Test your WebZ and Record Builder installations now.

Return to Contents

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

Last Modified: