|
Installing
WebZ (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 WebZ. OCLC
SiteSearch 4.1.2a replaces SiteSearch
4.1.2 as the latest SiteSearch software release. 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
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. For UNIX, it also adds MySQL as the relational database
management software for the Access component. For Windows NT, it also
adds the WebZ extension to your host system.
See Installing
WebZ (Version 4.1.0/4.1.1) or Installing
WebZ (Version 4.0.x) for installing previous versions of WebZ.
Requirements
Before completing
this installation, review the information in the Installing
and Configuring the Open SiteSearch Suite and OCLC
SiteSearch Suite System Requirements to ensure that you meet the system
requirements and have all of the information you need to install WebZ
successfully.
| UNIX
users: |
|
(1) If
you have an existing Apache Web server and you use the Web server
only to run the Open SiteSearch software, OCLC recommends that you
install all SiteSearch software in the same directory as your Web
server.
|
| |
(2) If you
have not already installed the Web server/WebZ
Extension, OCLC recommends that you do so before you install
the WebZ software.
|
| Windows
NT users: |
|
The Windows
NT installer for SiteSearch 4.1.2a installs both the WebZ extension
and WebZ.
|
|
All users:
|
|
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.
- Items or commands
you must type appear in single quotes, like this: "apache". Type them
without the quotes.
Installation
Methods
There are two
installation methods, 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.
UNIX
Installation Procedure
Before you install
the WebZ software, configure your
system environment variables. Then read the instructions below. You
should have the following installation files:
- ss4_1_2a.webz.tar.Z
- WebZInstaller_4_1_2a.sh
Time Required
for Installation
Plan on up to
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.
| Note: |
Install WebZ
under the same user name (user account) that you used to install the
WebZ Extension. To conform to good
UNIX system administration practices, we recommend that you do not
use root as the user name. |
|
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 ss4_1_2a.webz.tar.Z and WebZInstaller_4_1_2a.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_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 WebZ - 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/perl
|
|
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
|
|
WebZ
Installation Root
|
Full
path name of the <WebZ_root> directory |
/sitesearch/ss_prod |
|
JDK
Location
|
Full
path name of the Java Development Kit (JDK) on the host system. |
/usr/java1.2.2
|
|
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 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. |
<WebServer_root>/cgi-bin |
|
Web
Server Document Root Directory
|
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. |
<WebZ_root>/htdocs/obiv1 |
|
Host
Name
|
Name
of the host system that the MySQL server runs on to provide
user authentication for WebZ. |
dolphin.anywhere.edu
|
|
MySQL
Port
|
Port
number of the host system that the MySQL server runs on to
provide user authentication to the WebZ OBI. The port number
must be greater than 1024.
|
1114
|
|
MySQL
Process Username
|
User
name of the MySQL system administrator.
|
jsmith
|
| MySQL
Server Admin Email |
Electronic
mail (e-mail) address of the MySQL system administrator. |
jsmith@anywhere.edu
|
|
MySQLDriver
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/perl
WebZ
Installation Root: <WebZ_root>
JDK
Location: /usr/java1.2.2/
Web Server CGI-BIN Directory:
<WebZ_root>/cgi-bin
Web Server Document Root Directory: <WebZ_root>/htdocs/obiv1
Host
Name IP Address: 123.456.78.90
Operating
System: sol
MySQL
Port: 1114
MySQL
Process Username: jsmith
MySQL
Server Admin Email: jsmith@anywhere.edu
SQLDriver
Classname: org.gjt.mm.mysql.Driver
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. The installation
begins and the following message appears:
Beginning
the installation of the Open SiteSearch WebZ - 4_1_2a
This may take a few minutes, please wait.
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. Check your
WebZ license for the basis of your licensing agreement. Is your
WebZ license based on the number of simultaneous users?
- Yes.
Verify the number of simultaneous users for which you are licensed.
Go to step 10.
- No.
Go to step 12.
|
| 10. Open the
OpServe.ini configuration file (located
in <WebZ_root>/ini) with a text editor. |
|
11. Specify
the number of simultaneous WebZ users in your license:
- Edit the
MaxSimultaneousUsers variable in the [WebZLicense]
section.
- Save and
close OpServe.ini.
| Note: |
When
the maximum number of WebZ 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.
|
|
|
12. Is your
operating system Solaris?
- Yes.
Are you using JDK 1.3?
- Yes.
Add the text shown in dark
bold blue print in the two places shown below to
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 13.
- No.
Go to step 13.
|
|
12. Are
you planning to install Database Builder?
|
Return
to Contents
Windows
NT Installation Procedure
Before you install
the WebZ software, configure your system
environment variables. Then read the instructions below, and make
sure that you have the WebzInstaller4_1_2a.exe installation file.
The SiteSearch
4.1.2a WebZ installer includes the WebZ Extension for Windows NT.
Time Required
for Installation
Plan on up to
30 minutes to install WebZ 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 WebZInstaller4_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 in which you want to install 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.
| Note: |
|
If
you subsequently plan to install Database Builder, use a directory
name without spaces. The Database Builder installer places
its files under the same top-level directory used for WebZ.
Database Builder does not function properly with directory
names that contain spaces.
|
|
|
5. Enter
information about the server where you are installing WebZ and the
WebZ extension:
|
Prompt
|
Description
|
Example
|
|
Server's
Host Name
|
Full
name of the server that will host SiteSearch.
|
bongo.dev.oclc.org
|
|
Server's
IP Address
|
Internet
Protocol (IP) address of the SiteSearch host system. |
132.174.211.231
|
|
Web
Server Name
|
Web
server used for WebZ. Select Netscape or Microsoft IIS (Internet
Information Server) from the drop-down list.
|
Netscape
|
| Note: |
|
The
installer automatically detects the name and IP address of
the server from which you are running the installer.
|
Click Next>
to continue.
|
|
6. Enter
information about your SQL server. WebZ for Windows NT supports
Microsoft SQL server as the relational database management system
for WebZ'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
|
|
Java
SQL Driver Class Name
|
The
fully qualified class name of the SQL driver.
|
sun.jdbc.odbc.JdbcOdbcDriver
|
Click Next>
to continue.
|
|
7. Select
a Typical or Custom installation by clicking the appropriate radio
button:
- Typical
– installs WebZ and the WebZ extensions for both Netscape
and IIS. The WebZ extensions take little space and SiteSearch
can function properly with both WebZ extensions installed, so
there is usually no reason not to install both.
- Custom
– allows you to select which components to install.
Click Next>
to continue.
|
|
8.
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:
|
|
9. While
the installation proceeds, you can follow its progress by reading
the messages displayed and the progress bar.
|
|
10. When
the installer completes, click Finish to end the installation.
|
|
11. Check your
WebZ license for the basis of your licensing agreement. Is your
WebZ license based on the number of simultaneous users?
- Yes.
Verify the number of simultaneous users for which you are licensed.
Go to step 12.
- No.
Go to step 14.
|
| 12. Open the
OpServe.ini configuration file (located
in <WebZ_root>\ini) with a text editor. |
|
13. Specify
the number of simultaneous WebZ users in your license:
- Edit the
MaxSimultaneousUsers variable in the [WebZLicense]
section.
- Save and
close OpServe.ini.
| Note: |
When
the maximum number of WebZ 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.
|
|
|
14. Are
you planning to install Database Builder?
|
Return
to Contents
See Also
Installing
and Configuring the Open SiteSearch Suite
Operating the WebZ System
Installing the WebZ Extension (Version 4.1.2a)
Installing Database Builder (Version 4.1.2a)
|