Main -> Documentation -> Getting Started -> Installing and Configuring the Open SiteSearch Suite -> Installing Database Builder (Version 4.0.x)

Installing Database Builder (Version 4.0.x)

Table of Contents

Introduction
Requirements
Document Conventions
Installation Methods
Java Installation Procedure (UNIX and NT)
Perl Installation Procedure (UNIX)


Introduction

This document explains how to install the SiteSearch Database Builder. The Open SiteSearch Database Builder installation process installs the database utility programs, the SiteSearch Database Operations Tool (SSDOT), and a local test database (localERIC) on your host system.


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.


Document Conventions

  • <WebZ_root> refers to the location of your WebZ environment.
  • <version> refers to the SiteSearch version you are installing.
  • Items or commands you must type appear in single quotes, like this: "java DbBuilderInstaller_<version>". Type them without the quotes.

For Example

  • Your root directory (<WebZ_root>) might be /web/netscape/ss_prod. For NT administrators, your root directory might be j:\web\netscape\ss_prod.
  • Your DbBuilderInstaller_<version>.class file might be DbBuilderInstaller _4_0_2.class
  • The Windows NT batch file might be DbBuilderInstaller_4_0_2.bat.


Installation Methods

You can install the WebZ software using one of two methods, the Java Installation Procedure (UNIX and NT) (a graphical user interface), or the Perl Installation Procedure (UNIX).(a command line interface).


Java Installation Procedure (UNIX and NT)

Before you install the Database Builder software, configure your system environment variables. Read the instructions below, and make sure that you have the following installation files:

  • DbBuilderInstaller_<version>.bat (NT)
  • DbBuilderInstaller_<version>.class (UNIX and NT)

Time Required for Installation

Plan on about 20 minutes to install Database Builder using the Java installer. The specific time required depends on the speed of your processor and the system load at the time you perform the installation.

A Note to UNIX Administrators

The following instructions assume that you have configured your UNIX DISPLAY variable for your desktop display and started an X server session and terminal emulator window with a connection to the system hosting the Database Builder installation.

Directions

Follow the instructions below to install Database Builder using the Java installer.

1. Move to the <WebZ_root> directory.

2. Copy the files to your <WebZ_root> directory.

  • UNIX: Copy the DbBuilderInstaller_<version>.class file into your <WebZ_root> directory.
  • NT: Copy the DbBuilderInstaller_<version>.class file and the DbBuilderInstaller_<version>.bat file into your <WebZ_root> directory.

3. Start the installation process.

  • UNIX: Type "java DbBuilderInstaller_<version>" and press Enter while you are in the <WebZ_root> directory.
  • NT: Double-click the DbBuilderInstaller_<version>.bat file.

4. The installation program extracts the compressed Java class file and begins the installation. The Welcome screen appears.

5. Click Next on the Welcome screen to move to the System Configuration Information screen.

7. Click Next to continue installing Database Builder.

8. While the installation proceeds, you can follow its progress by reading the messages displayed. You will see the following messages, in this order:

    Extracting files...

    Configuring installation files. This may take several minutes, please wait...

    Moving DbBuilderExes, please wait...

    Cleaning up temporary files, please wait...

This part of the installation usually takes about 15 minutes.

9. When the installer completes its tasks, you see a screen that lists the files and directories extracted during the installation.

Note:

The number of extracted files and directories varies, and depends on your operating system.

10. Click Finish to end the installation.

11. 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:
  •      dbn = dbs/localERIC.ini

    where n is the appropriate number in the database list.

  • Save and close the databases.ini file.
12. Test the installation of your SiteSearch software.


Perl Installation Procedure (UNIX)

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

Time Required for Installation

Plan on about 10 to 15 minutes to install Database Builder using Perl scripts. 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.

1. Copy the ss<version>.dbbuilder.tar.Z and DbBuilderInstaller_<version>.sh files into the <WebZ_root> directory.

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

3. You see the following prompt:

    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.

  • Directory of Perl Interpreter - the full path name of the Perl interpreter on the host system.
  • DbBuilder Installation Directory - the full path name of the DbBuilder directory.
  • WebZ Installation Directory - the full path name of the <WebZ_root> directory.
  • Operating System - the operating system of your host environment. Enter the value for your operating system from those shown: "aix" (AiX), "osf1" (DIGITAL UNIX), "hpux" (HP-UX), "irix" (IRIX), or "sol" (Solaris).
  • SSDOT Environment Name - a 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.
  • JDK Location - the full path name to the Java Development Kit (JDK) directory.

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/perl
 DbBuilder Installation Directory: /<WebZ_root>/dbbuilder
      WebZ Installation Directory: <WebZ_root>
                     JDK Location: /usr/java
          Target Operating System: sol
           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 will see a number of messages. 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

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:
  •      dbn = dbs/localERIC.ini

    where n is the appropriate number in the database list.

  • Save and close the databases.ini file.
10. Test the installation of your SiteSearch software.


See Also

Installing and Configuring the Open SiteSearch Suite
Installing the WebZ Extension
Installing WebZ
databases.ini Configuration File


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