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

Installing WebZ (Version 4.0.x)

Table of Contents

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


Introduction

This document explains how to install version 4.0.x of WebZ. The Open SiteSearch WebZ installation process installs the WebZ configuration files, Out-of-the-Box Interface (OBI) HTML and image files, Java classes, and API documentation on your host system.

To install version 4.1.0 of WebZ, see Installing WebZ (Version 4.1.0).


Requirements

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

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

Important: Do not set a document root in Netscape or IIS until after you install both the WebZ Extension and WebZ. These servers use the same directory for HTML documents. Doing so creates a root directory for HTML documents (htdocs) that the installer cannot override.


Document Conventions

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

For example:

  • UNIX: the server root directory (<WebServer_root>) might be /web/netscape.
  • NT: the server root directory (<WebServer_root>) might be J:\web\netscape.
  • UNIX: the WebZ root directory (<WebZ_root>) might be /web/netscape/ss_prod
  • NT: the WebZ root directory (<WebZ_root>) might be J:\web\netscape\ss_prod.
  • Your WebZInstaller_<version>.class file might be WebZInstaller_4_0_2.class.


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 WebZ software, configure your system environment variables. Read the instructions below, and make sure that you have the following installation files:

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

Time Required for Installation

Plan on about 30 minutes to install WebZ 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 WebZ installation.

Directions

Follow the instructions below to install WebZ using the Java installer.

1. Move to the <WebServer_root> directory or create a new directory for the Open SiteSearch suite components. This directory is referred to as the <WebZ_root> directory in this procedure.

Note:

If you have an existing Web server and you only use the Web server to run the Open SiteSearch software, OCLC recommends that you install all SiteSearch software in the same directory as your Web server.

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

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

3. Start the installation process:

  • UNIX: From the command prompt in the <WebZ_root> directory, type "java WebZInstaller_<version>" and press Enter.
  • NT: Double-click the WebZInstaller _<version>.bat file.

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

5. Click Next at the bottom of the Welcome screen to move to the System Information screen.

6. Select the appropriate operating system from the Choose an Operating System drop-down list. Click Next to move to the WebZ Installation Root screen.

7. Enter the location where you want to install the WebZ software and the other Open SiteSearch components. The directory that appears in the WebZ Installation Root field on the WebZ Installation Root screen is your current directory. Be sure you include the full path name of the directory.

8. Click Next at the bottom of the screen to move to the System Configuration Information screen.

9. Enter the following information on the System Configuration Information screen:

UNIX and NT Fields

  • JDK Location - the full path name of the Java Development Kit (JDK) on the host system. Example: user/java.
  • Web Server CGI-BIN Directory - the full path name of the directory that contains any Common Gateway Interface (CGI) scripts used for the Web server and WebZ operations. If you are using the Apache server, this directory MUST be the same CGI-BIN directory that you defined in the WebZ Extension installation.
    Example: <WebServer_Root>/cgibin
  • Web Server Document Root Directory - the full path name of the directory that contains all of the HTML and image files associated with the Web server and WebZ. This directory MUST be the same document root directory that you defined in the WebZ Extension installation.
    Example: <WebZ_Root>/htdocs
  • Host Name IP Address - the Internet Protocol (IP) address of the host system.
    Example: 123.456.78.90
  • SQLDriver Classname - The fully qualified class name of the Mini Structured Query Language (mSQL) driver. The default is com.imaginary.sql.msql.MsqlDriver, which is located in the imaginary.zip file in the <WebZ_root>/msql/classes/lib directory.

UNIX Fields

  • miniSQL Host Name - the name of the host system that the Hughes Technology (mSQL) server runs on to provide user authentication to the WebZ OBI.
    Example: admin.anywhereU.edu
  • miniSQL Port - the port number of the host system that the mSQL server runs on to provide user authentication to the WebZ OBI. The port number must be greater than 1024.
    Example: 1114
  • miniSQL Process Username - the user name of the mSQL system administrator.
    Example: jsmith
  • miniSQL Server Admin Email - the electronic mail (e-mail) address of the mSQL system administrator.
    Example: jsmith@anywhereU.edu

NT Fields

  • Host Name - the name of the host system that your SQL server runs on to provide user authentication to the WebZ OBI.
    Example: admin.anywhereU.edu
  • JDBC URL -the Uniform Resource Locator (URL) and protocols that the Java Database Connectivity (JDBC) driver uses to locate your SQL server.
    Example: jdbc:odbc:Accessdb

10. Click Next at the bottom of the screen to continue the WebZ installation.

11. You receive a message asking whether you want to overwrite <WebZ_root>/ini/HostMap.ini? Click Yes.

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

    Making backup files, please wait...

    Cleaning up temporary files, please wait...

This part of the installation usually takes about 25 minutes.

13. When the installer completes, you see 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 the operating system of the host system where you are installing WebZ.

14. Click Finish to end the installation.

15. If you are using Netscape or IIS as your Web server, set the document root in the Web server configuration now.

16. Proceed to the Database Builder installation, if applicable.


Perl Installation Procedure (UNIX)

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

  • ss<version>.webz.tar.Z
  • WebZInstaller_<version>.sh

Time Required for Installation

Plan on about 20 minutes to install WebZ 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 WebZ using Perl scripts.

1. Move to the <WebServer_root> directory or create a new directory for the Open SiteSearch Suite components. This directory is referred to as the <WebZ_root> directory in this procedure. Copy the ss<version>.webz.tar.Z and WebZInstaller_<version>.sh files into this directory.

Note:

OCLC recommends that you install all of the Open SiteSearch Suite software into the same directory as your Apache server if you are only using the server to run SiteSearch.

2. Type "WebZInstaller_<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.
    Example: /usr/perl
  • 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).
    Example: sol
  • WebZ Installation Root - the full path name of the <WebZ_root> directory.
    Example: /dove1/netscape/ss_prod
  • JDK Location - the full path name of the Java Development Kit (JDK) on the host system.
    Example: /usr/java/
  • Web Server CGI-BIN Directory - the full path name of the directory that contains any Common Gateway Interface (CGI) scripts used for the Web server and WebZ operations. If you are using the Apache server, this directory MUST be the same CGI-BIN directory that you defined in the WebZ Extension installation.
    Example: <WebServer_Root>/cgi-bin
  • Web Server Document Root Directory - the full path name of the directory that contains all of the HTML and image files associated with the Web server and WebZ. This directory MUST be the same document root directory that you defined in the WebZ Extension installation.
    Example: <WebZ-root>/htdocs
  • Host Name - the name of the host system that the Hughes Technology Mini Structured Query Language (mSQL) server runs on to provide user authentication to the OBI.
    Example: admin.anywhereU.edu
  • Host Name IP Address - the Internet Protocol (IP) address of the host system.
    123.456.789.01
  • miniSQL Port - the port number of the host system that the mSQL server runs on to provide user authentication to the WebZ OBI. The port number must be greater than 1024.
    Example: 1114
  • miniSQL Process Username - the user name of the mSQL system administrator.
    Example: jsmith
  • miniSQL Server Admin Email - the electronic mail (e-mail) address of the mSQL system administrator.
    Example: jsmith@anywhereU.edu
  • SQLDriver Class - The fully qualified class name of the mSQL driver. The default is com.imaginary.sql.msql.MsqlDriver, which is located in the imaginary.zip file in the <WebZ_root>/msql/classes/lib 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
            WebZ Installation Root: <WebZ_root>
                      JDK Location: /usr/java/
      Web Server CGI-BIN Directory: <WebZ_root>/cgi-bin
Web Server Document Root Directory: <WebZ_root>/htdocs
              Host Name IP Address: 123.456.78.90
                  Operating System: sol
                      miniSQL Port: 1114
          miniSQL Process Username: jsmith
        miniSQL Server Admin Email: jsmith@anywhereU.edu
               SQLDriver Classname: com.imaginary.sql.sql.MsqlDriver

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 should take about 15 minutes.

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

WebZInstaller script Finished!

creating ./config.status

9. If you are using Netscape or IIS as your Web server, set the document root in the Web server configuration now.

10. Proceed to the Database Builder installation, if applicable.


See Also

Installing and Configuring the Open SiteSearch Suite
Operating the WebZ System
Installing the WebZ Extension (Version 4.0.x)
Installing Database Builder (Version 4.0.x)


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