Main -> Support -> Product Support FAQ

Open SiteSearch Product Support FAQ

This document includes Frequently Asked Questions (FAQ) submitted to Open SiteSearch Product Support. The answers include references to related documents available from the Open SiteSearch Help Zone. Refer to one of the following sections to review the FAQ:

Z39.50 and Open SiteSearch

Q: How do we configure access to a remote Z39.50 server?

A: Open SiteSearch 4.0 provides template files for the major Z39.50 servers including both the server file (/ini/servers/*.ini) and the database file (/ini/dbs/*.ini). Additional configuration information for other Z39.50 servers is available from Open SiteSearch Product Support.

Configuring Access to Databases and Servers

Q: How can I configure Z39.50 access to our Open SiteSearch environment?

A: The "ZBroker" process can be activated to provide Z39.50 access to ZBase for both outside users and for testing purposes utilizing the 'zclient' testing tool. You will need to modify 2 files "ZBrokerServer.ini" and "OpServe.ini" to accomplish this configuration.

ZBrokerServer.ini Configuration File

OpServe.ini Configuration File

Q: What is 'zclient' and how do I use it?

A: Zclient is a minimal Z39.50 client that can be utilized to test both remote Z39.50 servers and any database or server currently available in your Open SiteSearch 4.0 environment (using the port value for ZBroker). Our documentation site provides both usage instructions and the API for the program.

The zclient Utility

Class ORG.oclc.z39.client.zclient

Q: What is an "alternateId" and how can it be used in accessing Z39.50 servers?

A: The "alternateId" is an integer that represents the actual index id or real use attribute on the remote Z39.50 server. This variable is optional. If not specified, the value defined in the use variable is used.

When this index is searched, WebZ first locates the index based on its use attribute. Next, if an alternateId is defined for the index, ZBase converts the use to the alternateId. Use this variable when the actual database index id or use attribute does not map to a well-known standard (such as Z39.50) or to an index definition in a group database configuration file (for cross-database searching).

Web Servers

Q: Can we use our existing Apache server with Open SiteSearch 4.0?

A: Yes, you can integrate our WebZ extension into your current server as long as you are running Apache version 1.2.x.

Configuring an Existing Apache Web Server to Use the WebZ System

User Interface Issues

Q: What is the OBI?

A: The Out-of-the-Box Interface (OBI) is a sample user interface and a description of this can be viewed from in The WebZ Interface - Description of the OBI.

For a functional description of the OBI, you can view the information in the Obi Frames & Framesets document. This describes each frame and frameset in the OBI and which html file(s) and which Java class is associated with each.

Q: What are Obi Topics and how do I configure them?

A: Obi Topics provides the ability of combining similar resources under a common topic area in the WebZ interface.

ObiTopics.ini Configuration File

Java and Open SiteSearch

Q: What is the system variable "CLASSPATH" and how do I configure it?

A: The CLASSPATH variable is used by Java processes to locate the existence of classes utilized within a Java program. It is configured for the Open SiteSearch servers (JaSSI, ZBase, access, etc.) during the installation process and maintained in the ssmgr.(hostname) file in the /(sitesearch)/scripts directory. In order to compile Java class files (i.e., formatting classes), you must also have your CLASSPATH configured correctly for your system.

For information about configuring the Java CLASSPATH settings, you can view Installing and Configuring the Open SiteSearch Suite.

Q: I was doing a test in WebZ to compile file in /classes/ORG/oclc/fmts/obi directory. The following error occurred:

  javac Class ORG.oclc.fmts.WebZFormatter not found in import.

      import ORG.oclc.fmts.WebZFormatter 

What did I do wrong?

A: This looks as if the Java compiler is unable to find either the <WebZ_root>/classes directory or the WebZ jar file. You will want to verify that your CLASSPATH reflects the absolute location of your <WebZ_root>/classes directory and <WebZ_root>/classes/lib/SS<version>.jar.

You can verify this information by typing the following:

     echo $CLASSPATH

Example reply:


Installing and Configuring the Open SiteSearch Suite

Access Control

Q: What is the Access component of Open SiteSearch and how do I configure it in its current form?

A: The Access Component gives your site flexible access and authorization control supporting your licensing arrangements and presenting users with sets of resources tailored to their needs. This component allows system administrators to require that authentication must take place before a patron can access WebZ resources through the Out-of-the-Box Interface (OBI). By default, the WebZ system is not configured to start the Access component.

Configuring the Access Component

Database Building

Q: What are the variables "internalaccntag" and "internalaccnindx" in the database description (*.dsc) file and how do they affect database building?

A: The Open SiteSearch Database Builder software uses the internalaccntag and internalaccnindx definitions in the database description (*.dsc) file to locate database records for replacement and/or deletion during a database update.

Internalaccntag and Internalaccnindx Definitions

Q: What should I name my Open SiteSearch database in the database description (*.dsc) file for the "DB: " variable?

A: The "DB: " variable specifies an internal database identification for an Open SiteSearch database.

Database Identification

Q: Can I create an Open SiteSearch database using SGML tagged data records?

A: The Database Builder software package provides the necessary tools to work with most types of SGML data. A SGML-to-BER conversion utility (sgmlconv) is provided with the package and can be used to convert SGML records to BER records for Open SiteSearch database building.

Introduction to Using SGML Source Data to Build a Database

Q: Can I create an Open SiteSearch database from text files?

A: The sgmlconv utility allows you to convert SGML or other tagged data into ANS.1/BER encoded records that can be added to an Open SiteSearch database. So you can add the required tags around the various fields so that the conversion program can process the data. For additional information, you can view the following documents:

The Sgmlconv Utility

Introduction to Using SGML Source Data to Build a Database

Q: What BER data conversion tools are provided with Open SiteSearch?

A: The Open SiteSearch software package provides utilities to convert BER records to both 'text' and 'MARC' records.

The ber2txt Utility

The ber2marc Utility

Miscellaneous Questions

Q: How do I keep my Open SiteSearch installation current or what should I do if I locate a possible bug with the software?

A: The first place you should look would be the OCLC SiteSearch Suite Known Bug List. This list is viewable in 3 different formats and will provide information regarding known bugs, possible workarounds, and available fixes. If you are unable to locate your problem or if you need further information regarding a known problem, follow the procedures outlined in the User Support Procedures.

Q: What should I do after installation?

A: The suggested action after an Open SiteSearch Component is installed is to test the features of that component.

Testing the Open SiteSearch Suite Installation

Q: In our old Unix Open SiteSearch 3.1 environment, we had a Z39.50 testing utility called 'zdemo'. Can I get another copy of this?

A: We have 'zdemo' available for downloading from our anonymous ftp server:


  login:     anonymous

  password:  (your email address)

  directory: /pub/SiteSearch/ZDemo/(unix operating system)

  file:      zdemo

Note: be sure to download the file in the ftp binary mode.

Since 'zdemo' is a basic zclient the only documentation for zdemo is available when you type a "?" after you start the program. You can simply place the executable in your <WebZ_root>/scripts directory.

To execute the program, type "zdemo -h(host name) -p(port number)" at your unix prompt.

Example searching an Open SiteSearch installation on a local machine:

   zdemo  -hlocalhost  -p(zbroker port)

Example searching the FirstSearch Z39.50 test server:

   zdemo  -p210

See Also

Technical Support Base
Open SiteSearch Known Bug List

[Home] [Documentation] [Support] [Search]
Last Modified: