Main -> Documentation -> WebZ System Administration -> WebZ System Information -> Open SiteSearch Suite Directory Structure and Contents

Open SiteSearch Suite Directory Structure and Contents

This document describes the default directory structure and contents of the Open SiteSearch suite upon installation. The directories listed in the table below are found in the <WebZ_root> directory of your Open SiteSearch environment. The contents of your installed environment will depend upon which Open SiteSearch components you have licensed, Open SiteSearch WebZ, Open SiteSearch Database Builder, and/or Open SiteSearch Imaging Support Package, as well as which Web server you will be using to access the WebZ Out-of-the-Box Interface (OBI). Refer to the "Related Components" column in the table below to see which directories and files you will find in your environment.

Outline of the Open SiteSearch Suite Directory Structure

Directory

Related Components

Description of Contents

cgi-bin/

Apache Server

Includes the Common Gateway Interface (CGI) scripts that are used by the Apache server. By default during the Apache server installation, this directory is empty.

cgi-bin/sscgi

WebZ

Contains the script files necessary to perform the tif to gif image conversion required to view image records in the WebZ OBI.

classes/lib

WebZ

Contains the SS4_0_0.jar file, where the core classes for the Open SiteSearch suite are stored.

classes/ORG/oclc

WebZ, Database Builder, and Imaging Support Package

Contains the ORG.oclc.* packages for the WebZ system. The following packages are included in this directory:

  • fmts/
  • fmts/obi/
  • fmts/zbase/
  • gadgets/
  • obi/
  • obi/extverb/
  • obi/util/
  • stats/
  • tools/
Note:

The Database Builder and Imaging Support Package installers add the necessary formatting classes to these WebZ packages to display the localERIC, Color Archive (CARC), and Electronic Reserve (ERES) sample databases in the WebZ OBI.

dbbuilder/

Database Builder and Imaging Support Package

Includes all of the tools used to build local databases and local image databases using Database Builder and the Imaging Support Package.

dbbuilder/bin

Database Builder

Includes the utility programs and scripts used to build local databases with Database Builder, including the SiteSearch Database Operations Tool (SSDOT).

dbbuilder/collects/

Imaging Support Package

Contains subdirectories for each document collection that includes image source file(s) and associated ScanStation files. By default, there are two document collections included with the Imaging Support Package installation, carc and eres.

dbbuilder/collects/delete

Imaging Support Package

Includes subdirectories for each document collection that serves as a temporary directory used to mark a database document for deletion, preventing other system administrators from modifying the document.

dbbuilder/collects/locked

Imaging Support Package

Includes subdirectories for each document collection that serves as a temporary directory used to lock database documents. By locking a document, only one system administrator can modify the document at a time.

dbbuilder/dbs/

Database Builder and Imaging Support Package

Contains individual subdirectories for each local Open SiteSearch database to store its physical database files. By default, this directory contains subdirectories for the ERIC, carc, and eres sample local databases.

dbbuilder/ssdot/

Database Builder

Contains the configuration files, scripts, utility programs, and help files necessary to use SSDOT to automate the database build process.

dbbuilder/ssdot/exes

Database Builder

Stores the executable files and the ssdot.ini configuration file used to run SSDOT.

dbbuilder/ssdot/help

Database Builder

Defines the location of the help files used to provide context-sensitive help to SSDOT clients.

dbbuilder/ssdot/info

Database Builder

Defines the location of the directory that contains a database registration information file for each registered database in the SSDOT environment.

dbbuilder/ssdot/jobs

Database Builder

Defines the location of the SSDOT directory that is used as a temporary storage place for information about active or completed jobs.

dbbuilder/ssdot/locks

Database Builder

Serves as a temporary directory to lock local databases, preventing changes to the database while a database job is performed in the background.

dbbuilder/ssimage

Imaging Support Package

Contains the scripts/ and TYPES/ subdirectories. The scripts/ directory serves as a central location for the scripts and configuration files associated with creating local image databases from document collections.

The TYPES/ directory contains information regarding the collection types that are used to define the data structure and processing rules for one or more document collections. By default, the TYPES/ directory has two pre-defined collection types associated with the sample image databases, ARCHIVE and RESERVE.

htdocs/

Web Server and WebZ

Serves as the default HTML document root directory for the Web server. WebZ OBI files are located in this directory, as well as the Open SiteSearch suite API documentation (Javadoc).

htdocs/error

WebZ

Contains the WebZ OBI error HTML pages that display system information and error responses when a Java exception or configuration problem occurs.

htdocs/help

WebZ

Contains the Open SiteSearch local documentation files and API documentation (Javadoc).

Note:

The local documentation is not currently distributed with the software, but you can access the Open SiteSearch documentation remotely at http://purl.oclc.org/sitesearch/help.

htdocs/html

WebZ

Contains all of the HTML files used in the WebZ OBI except for the system error pages (see htdocs/error above).

htdocs/icons

Apache server

Includes the images used for the Apache server documentation.

htdocs/images

WebZ

Includes all of the images that are used in the WebZ OBI.

httpd/

Web Server

Serves as the main directory for files and executables associated with the Web server, including the WebZ Extension.

httpd/apache

Apache Server

Contains information specific to the Apache server, including the LICENSE and README files.

httpd/apache/bin

Apache Server

Includes the executable file used by the Open SiteSearch system to start the Apache server. This executable is located in the subdirectory associated with the operating system of your host environment.

httpd/apache/conf

Apache Server

Contains the following Apache server configuration files:

  • access.conf - Defines the access setting for the Apache server, including the location of the system CGI directory.
  • httpd.conf - Serves as the primary configuration file for the Apache server, defining such elements as the server port number, the maximum and minimum servers allowed, the server administrator's user name and group name, and the server root directory.
  • mime.types - Contains mime type definitions for the Apache server.
  • srm.conf - Defines the server namespace and available services, such as the server document root directory and the location of the Open SiteSearch Apache WebZ Extension configuration file, ApacheExt.ini.

httpd/apache/lib

Apache Server

Contains the compiled WebZ Extension module library that the Apache server uses to communicate with WebZ.

httpd/apache/logs

Apache Server

Includes the Apache server log files, access_log and error_log, as defined in the httpd.conf configuration file.

httpd/apache/ops

Apache Server

Serves as a temporary directory where the Apache writes out a process id file, httpd.pid, used by the Open SiteSearch Operations (OpServe) server to maintain communication with the Apache server.

httpd/apache/scripts

Apache Server

Contains the Open SiteSearch script that starts and stops the Apache server. This script is also included in the <WebZ_root>/scripts directory.

httpd/apache/src

Apache Server

Includes the Java classes that makeup the WebZ Extension module. These classes have already been compiled into a library and are stored in the <WebZ_root>/httpd/apache/bin/hostname directory, where hostname is the name of the host enviroment where your WebZ environment has been installed.

ini/

WebZ and Web server

Contains the following WebZ and WebZ Extension system configuration files:

ini/dbs

WebZ, Database Builder, and Imaging Support Package

Contains a configuration file for each local and remote database available to the Open SiteSearch system.

ini/interface

WebZ

Contains interface definition files that define the colors, fonts, gadgets, and other features of the HTML interfaces available to the system. The system includes three interface styles, defaultStyle.ini, redStyle.ini, and doctStyle.ini.

Note:

The doctStyle.ini file supports the Open SiteSearch local documentation. Do not remove or edit the doctStyle.ini file if you want to use the local version of the documentation.

This directory also contains the ObiTopics.ini and the DisplayGadgets.ini configuration files. The ObiTopics.ini defines Topic Areas and the Quick Search topics and their associated databases used in the WebZ OBI. The DisplayGadgets.ini defines the system gadget classes used to format the display of the various interface elements.

ini/servers

WebZ

Contains the .ini configuration file for each remote server available to the system, including the Access.ini and OclcILL.ini.

logs/

WebZ

Includes the WebZ server and user log files.

msql/

WebZ

Serves as the main directory for the Hughes Technologies Pty. Ltd.'s Mini Structured Query Language (mSQL) server and database(s) used to store the patron profiling and authorization information for the Open SiteSearch Access component. In addition to several subdirectories that are defined below, this directory contains Hughes Technologies licensing information and the msql.conf configuration file, which configures the daemon for mSQL.

Note:

The Open SiteSearch DB_README file in this directory describes the default SQL database and table structure that the Access component expects for storing profiling and authentication information.

msql/bin

WebZ

Contains the following mSQL scripts:

  • msql - provides a command line interface to send mSQL commands to msql2d.
  • msql2d - executes the daemon process that has to be running for mSQL to work.
  • msqladmin - serves as an administrative program to create and drop databases.
  • msqlconvert - converts Open SiteSearch 3.1 profile tables into the Open SiteSearch 4.0.0 database structure.
  • msqldump - writes out, or "dumps," the current table structure and contents straight to the screen. This information can also be redirected into a text file.
  • msqlexport - exports the database tables into a text file as comma-separated values (.csv).
  • msqlimport - imports a text file with comma-separated values (.csv) into the tables of a database.
  • relshow - outputs information about an mSQL database.

msql/classes/lib

WebZ

Contains the compressed class files for the Center for Imaginary Environments' (CIE) mSQL Java Database Connectivity (JDBC) driver in the imaginary.zip file. Also includes licensing information (README) and mSQL-JDBC driver programming tips (PROGRAMMING).

msql/doc

WebZ

Contains the HTML and image files for the local mSQL documentation from Hughes Technologies.

msql/msqldb/

WebZ

Contains subdirectories for each mSQL database to store all of the related database files.

By default, the only mSQL database included in the WebZ installation is the sample database called accessdb. This sample database should be used to configure the Access component to work with the WebZ system. If you remove any files in the accessdb/ subdirectory, you will not be able to use the sample database to test the Access component.

Note:

If you installed the WebZ software on the HP-UX operating system, you will need to re-build the sample database after installation to fix a known software bug.

ops/

WebZ

Contains the following system operation files:

  • .pid files - Acts as process id files for various Open SiteSearch components.
  • .load files - Provides load balance information for the Open SiteSearch servers.
  • OpServe.conn - Contains host and port information for the OpServe (written at startup).
  • Operations.lock - Allows the Web server to determine if an OpServe is running.

scripts/

WebZ

Contains the following scripts, executables, and files to use as administrative tools for the WebZ system:

  • apache - Starts and stops the Apache server.
  • ber2marc - Converts BER data to MARC format.
  • ber2txt - Converts BER data to ASCII text.
  • bounce - Stops and restarts the specified WebZ server.
  • iniconverter - Converts Open SiteSearch 3.1 database configuration files into the Open SiteSearch 4.0.0 format.
  • msql - Starts and stops the mSQL server used for the Access component.
  • ssadmin - Starts the Open SiteSearch administrative interface, ssadmin.
  • ssmgr.hostname (where hostname is the name of the WebZ host environment) - Provides the configuration information that ssadmin uses to perform its administrative tasks.
  • zclient - Starts the zclient Z39.50 interface.

stats/

WebZ

Stores the WebZ system statistics files.

tmp/

WebZ

Contains information about individual user sessions. Each individual session is given its own directory within tmp/ in which the system can store information about that session. The session directories within tmp/ are removed as each session ends.
[Main][Documentation][Technical Reference][Glossary][Search]