Description

Affected Files

WebZ and Record Builder Source Code

As with previous releases, the installers available on the FTP site for contain configuration files, the WebZ OBI, the source code for selected Java classes, and a .jar file.

With the release of SiteSearch 4.2.0, OCLC provides a separate .tar file (SiteSearchSource.tar) that contains all Java source files (.java) for SiteSearch 4.2.0, including Record Builder. This .tar file does not include d the compiled versions of these source files (.class), C source code for Newton, or the source code for Pears. (The Pears source code is available from the OCLC Office of Research under an Open Source license.)

As announced to the SiteSearch listserv on October 23, 2001, SiteSearch licensees MUST sign an an amendment to their existing contract, which specifies the terms and conditions for using the source code, to obtain access to the source code file.

If you currently license WebZ only, you will now have access to
Database Builder and Record Builder through the 4.2.0 source code file at no additional charge. However, OCLC provides technical support and assistance only to users with service contracts for Database Builder and Record Builder. WebZ-only users may upgrade their service contracts with OCLC to include Database Builder and Record Builder.

InstallShield Installers for UNIX

In addition to Perl installers, SiteSearch 4.2.0 adds InstallShield installers for UNIX users running Solaris, Linux, DIGITAL UNIX, or Tru64 UNIX. These installers have a graphical user interface and an uninstall option. The Database Builder installer also allows you to install Database Builder without the Record Builder application.

The WebZ installer includes both WebZ and the WebZ extension (including the Apache Web server, if desired). To run these installers, issue these commands from the directory where the installers reside:

WebZ – JDK 1.2.2 and higher:
java -jar WebZ4_2_0Installer.jar

WebZ – JDK 1.1.8 and below:
java -classpath \
<fullpath_to_JDK>/lib/classes.zip:\
WebZ4_2_0Installer.jar

Note:

Do not include the backslashes on the command line. They are included only for readability. Insert a space in place of the first backslash. Do not insert a space in place of the second backslash.

Database Builder – JDK 1.2.2 and higher only:
java -jar DbBuilder4_2_0Installer.jar

With an X-Windows and a PC X server (such as Exceed, X-WinPro, or SuperX), you may receive messages about font problems during the installation, such as this:

Font specified in font.properties not found
[-urw-itc zapfdingbats-medium-r-
normal--*-%d-*-*-p-*-sun-fontspecific]

They do not affect the installation and you can safely ignore them.

WebZ4_2_0Installer.jar (UNIX)
DbBuilder4_2_0Installer.jar (UNIX)

Uninstall Option with InstallShield Installers

In SiteSearch 4.2.0, the InstallShield installers lay down these uninstall directories:

• WebZ: <WebZ_root>/_uninst
• Database Builder: <WebZ_root>/dbbuilder/_uninst

Each directory contains two files: uninstall.dat and a .jar file. You cannot use the uninstall option if you delete these directories.

Files Removed During Uninstallation
Each uninstaller removes all files it created during the installation, including any of these files that you have modified. To retain your customized versions of files created during the installation (such as configuration files in the <WebZ_root>/ini directory), copy or move them elsewhere before running the uninstaller.

The uninstaller does not remove new files or directories that you create after the installation, such as custom Java class packages or HTML files.

Running the Uninstallers
To uninstall WebZ or Database Builder, follow these steps:

• WebZ:
  • Go to <WebZ_root>/_uninst.
  • Type:
       java -jar uninstall_webz.jar
• Database Builder:
  • Go to <WebZ_root>/dbbuilder/_uninst.
  • Type:
        java -jar uninstall_dbbuilder.jar

Then follow the onscreen instructions.

WebZ4_2_0Installer.jar (UNIX)
DbBuilder4_2_0Installer.jar (UNIX)

WebZ4_2_0Installer.exe (Windows NT)
DbBuilder4_2_0Installer.exe (Windows)

<WebZ_root>/_uninst (new directory) – WebZ
<WebZ_root>/dbbuilder/_uninst (new directory) – Database Builder

Description

Affected Files

Pears Database Engine

Pears is a new Java-based database engine shipped with SiteSearch 4.2.0. The OCLC Office of Research developed Pears as a replacement for the Newton database engine used to build databases for many OCLC products and shipped with SiteSearch 4.0.x /4.1.x. (Database Builder for Open SiteSearch 4.2.0 includes both Pears and Newton.) The Pears source code is available from the OCLC Office of Research under an Open Source license.

Features
Notable characteristics of Pears include:

• Built-in Unicode support
• Flexible record indexing, including the ability to create your own index routines and adding/removing indexes without reloading an existing database
• Customizable record handlers (data conversion utilities)
• Support for SGML, MARC, and delimited text input data
• Batch record export
• Customizable record filters to include or exclude records from an input file to a Pears database
• One physical database file per database
• A single utility for managing the database build process
• Fail-safe updates
• Journal files with all changes made to a database during an update
• Relevance ranking
• Compatibility with WebZ and Record Builder
• Conversion from a Newton database to a Pears database

See the Pears System Overview for more information and Pears-Newton Comparison for a side-by-side comparison of Pears and Newton.

Pears Documentation
A new page in the Documentation section of the Help Zone, OCLC SiteSearch Database Builder – Pears provides links to available Pears documentation. The main Help Zone page and the main Documentation page include links to the main Pears page, as well as Database Builder documentation for Newton.

For clarity, Help Zone documents that pertain to Pears include the link "Database Builder – Pears" in the top navigation bar. Documents that pertain to Newton include link "Database Builder – Newton" in the top navigation bar.

Pears Javadoc
You can find Javadoc for selected Pears classes in the Javadoc provided with Database Builder, located under <WebZ_root>/htdocs/rbv0/help/api. This directory includes Javadoc for WebZ, Record Builder, and Pears.

<WebZ_root>/classes/lib/SS4_2_0.jar
<WebZ_root>/classes/lib/pears.jar

SSDOT for Pears

To administer Pears databases, SiteSearch 4.2.0 contains a Pears version of the SiteSearch Database Operations Tool (SSDOT).

SSDOT for Pears has a menu-driven interface with options specific to administering Pears databases, such as reindexing a database, converting a Newton database to a Pears database, and exporting records. SSDOT has been written in Java, which makes it more flexible and extensible than the Newton version of SSDOT.

SSDOT for Pears uses Java internationalization methods and stores menu items, prompts, and error messages in a properties file. This makes it possible for you to customize these items or create a properties file for another language.

The Newton and Pears versions of SSDOT are not interoperable. For Newton databases, use the Newton version of SSDOT in <WebZ_root>/dbbuilder/ssdot. For Pears databases, start SSDOT from <WebZ_root>/dbbuilder/pearsExes/ssdot.

See The SiteSearch Database Operations Tool (SSDOT) for Pears for more information.

<WebZ_root>/dbbuilder/i18n/
     DbBuilderMessages.properties (new)
     DbBuilderMessages_en_US.Properties (new)

<WebZ_root>/dbbuilder/pearsExes/ssdot (new)

ORG.oclc.dbbuilder (new class package)

New Demonstration Databases

OCLC will add these new demonstration databases built with Pears to the SiteSearch FTP site as they become available. Watch for announcements on the SiteSearch listserv and the What's New page on the Help Zone when additional databases are posted to the FTP site.

These files are available for each database:

• raw input data file
• Pears database (.pdb) created from the input data
• .tags file (for SGML and delimited text databases)
• Pears database description configuration file
• WebZ database configuration file
• formatting configuration files unique to the database, if needed
• README file with installation instructions and additional information
• COPYRIGHT statement file

These databases contain copyrighted material. They are intended to demonstrate the types of databases you can build. You cannot redistribute them or make them available to the public.

See SiteSearch/4.2.0/DbBuilder/dbs-pears directory on the FTP site.

Unicode Support

The Record Builder application in SiteSearch 4.2.0 accepts user input with Unicode characters for updating local databases that support Unicode (such as Pears databases).

These Unicode characters may include diacritics, mathematical and other technical symbols, and characters used in non-Roman languages. Record Builder users must use a browser that supports Unicode, such as Versions 4.x and higher of Netscape® Navigator and Communicator and Microsoft® Internet Explorer.

There is a new formatting class, ORG.oclc.fmts.obi.UTF8RecordDumper, for dumping records with Unicode characters.

JaSSIServer_rb.ini and ZBase_rb.ini each contain a new parameter (UTF8EncodeInput in JaSSIServer_rb.ini and supportsUTF8 in ZBase_rb.ini) that you must set to TRUE to enable Unicode support in the WebZ interface. In addition, you must add set another new parameter (UTF8Encode) to TRUE in the [database] section of the database configuration file of each database that contains Unicode characters.

<WebZ_root>/classes/lib/SS4_2_0.jar

<WebZ_root>/ini/JaSSIServer_rb.ini

<WebZ_root>/ini/servers/ZBase_rb.ini

ORG.oclc.fmts.obi.UTFRecordDumper
     (new)

ORG.oclc.mantis.MantisHook
ORG.oclc.mantis.MantisXML

ORG.oclc.mantis.gadgets.DbTemplateList

ORG.oclc.mantis.hooks.DC3URLHook
ORG.oclc.mantis.hooks.DCURLHook
ORG.oclc.mantis.hooks.
     MARCBigControlHook
ORG.oclc.mantis.hooks.MARCHook

Single-Record Import

In SiteSearch 4.2.0, the Record Builder application allows you to import one record at a time from an input file to a local Pears or Newton database. The input file can contain only one record. The record must be in a format that matches the template you use to update the database.

Import Record Processing
Record Builder's Options Menu now has an Import Record option, which allows you select the database to which you want to import a record and then select the record. Record Builder displays it on the Edit Record screen, where you can edit it if you wish. At this point, you must submit the record to the database or add it to the Save database.

Record Builder the characters "_imported" to the file name of all imported records to help you identify which records have been imported.

Import Record Configuration
The Record Builder administrator specifies a location for files containing records to import in a new section of JaSSIServer_rb.ini, [ExpImportLocation]. This location also applies to records exported from Record Builder and to all databases updated with Record Builder in this environment.

You specify information about the data format of imported records in a new [Import] section of the database's Record Builder database configuration file. You may also specify additional information for the appropriate record handler in another new section of this file, [Handle_input_record_type].

<WebZ_root>/classes/lib/SS4_2_0.jar

<WebZ_root>/dbbuilder/dbs/dc/dc.dtd
<WebZ_root>/dbbuilder/dbs/dcq/dcq.dtd
<WebZ_root>/dbbuilder/dbs/parks/
     parks.dtd
<WebZ_root>/dbbuilder/dbs/scores/
     scores.dtd

<WebZ_root>/htdocs/rbv0/html/
     import.html (new)

<WebZ_root>/ini/JaSSIServer_rb.ini

<WebZ_root>/ini/dbs/
     localdc_rb.ini
     localdcq_rb.ini
     localmcat_rb.ini
     localparks_rb.ini
     localscores_rb.ini

<WebZ_root>/ini/interface/rbv0/
     RBStyle.ini

ORG.oclc.mantis.gadgets.FileSelect
     (new)

Single-Record Export

Record Builder now also supports single-record export for Pears and Newton databases. Record Builder exports the record in a format compatible with the database. For example, for a DC database, Record Builder exports the records in SGML format. For a MARC database, Record Builder exports records in MARC format.

Export Record Processing
To export a record, you must be viewing a record in either its brief (on the Search Results screen) or full format (on the Edit Record or View Record screens).

The Search Results screen now contains an Export Record icon () beside each record. The new Export Record menu option, as well as the Open Record and Open Browse options, lead to the Search Results screen. There are two choices for specifying the name and destination of an exported record, Export or Export As ....

Export saves the record in a directory designated by the Record Builder administrator (configurable in JaSSIServer_rb.ini), with a predefined file name.

Export As ... allows you to save the record on a local hard drive or any other location accessible from your workstation. You select a name and location for the file.

The Available Actions list on the Edit Record and View Record screens includes Export record and Export record as... options as well.

Export Record Configuration
The Record Builder administrator specifies a default destination for exported records in a new section of JaSSIServer_rb.ini, [ExpImportLocation]. This location also applies to records imported into Record Builder and to all databases updated with Record Builder in this environment.

You specify information about the data format of exported records in a new [Export] section of the database's Record Builder database configuration file. You may also specify additional information for the appropriate record handler in another new section of this file, [Handle_input_record_type].

<WebZ_root>/classes/lib/SS4_2_0.jar

<WebZ_root>/dbbuilder/dbs/dc/dc.dtd
<WebZ_root>/dbbuilder/dbs/dcq/dcq.dtd
<WebZ_root>/dbbuilder/dbs/parks/
     parks.dtd
<WebZ_root>/dbbuilder/dbs/scores/
     scores.dtd

<WebZ_root>/htdocs/rbv0/error/
    exportfail.html

<WebZ_root>/htdocs/rbv0/html/
      rbsearch.html

<WebZ_root>/htdocs/rbv0/images/
     export_icon.gif

<WebZ_root>/ini/JaSSIServer_rb.ini

<WebZ_root>/ini/dbs/
     localdc_rb.ini
     localdcq_rb.ini
     localmcat_rb.ini
     localparks_rb.ini
     localscores_rb.ini

<WebZ_root>/ini/format/rbv0/
     DCFormats.ini
     MarcRBCatalogFormats.ini
     RBRules.ini

<WebZ_root>/ini/interface/rbv0/RBStyle.ini

ORG.oclc.mantis.gadgets.PullDown
ORG.oclc.mantis.obi.mantisinit

Add Export and Import Privileges to rbdb Database

The access table in Record Builder's rbdb database has two new allowable values in its type column: import and export. These values allow you to assign import and/or export privileges to groups of Record Builder users. The sample database, rbdb.dump, contains an importgrp with import privileges and an exportgrp with export group with export privileges in the access, members, and groups tables.

<WebZ_root>/mysql/rbdb.dump (UNIX)
<WebZ_root>\accesssql\rbdb.sql (Windows NT)

Date and Time of Last Database Update

Record Builder now shows the date and time of the active database's last update above the EditSession information.

Record Builder refreshes the last update information after individual record updates during the Record Builder session. It does not refresh this information after batch updates to the database.

<WebZ_root>/classes/lib/SS4_2_0.jar

ORG.oclc.mantis.gadgets.Menubar

ORG.oclc.mantis.util.Util

Other Interface Enhancements

The Record Builder interface in SiteSearch 4.2.0 has some improved error messages. In addition, the Available Actions list no longer contains redundant XML viewing options – View XML (Long) and View XML (Wide) – and has more consistent terminology and capitalization in list items.

<WebZ_root>/ini/interface/rbv0/RBStyle.ini

ORG.oclc.mantis.gadgets.PullDown

Description

Affected Files

Record Builder Installation Optional with InstallShield Installers

In SiteSearch 4.2.0 the InstallShield installers for UNIX and Windows NT allow you to install Database Builder without its Record Builder application. This feature is not available with the Perl installers.

The installer has two installation options – Typical and Custom. A Custom installation allows you to select which Database Builder components to install. You can install Database Builder with or without Record Builder and its sample databases.

If you initially install Database Builder without Record Builder, you can subsequently add Record Builder by running another Custom installation and just selecting Record Builder.

DbBuilder4_2_0Installer.jar (UNIX)

DbBuilder4_2_0Installer.exe (Windows NT)

Unicode Support

The WebZ interface in SiteSearch 4.2.0 can:

• accept patron input with Unicode characters
• include Unicode characters in queries to local and remote databases that support Unicode
• display search results with Unicode characters from these databases

These Unicode characters may include diacritics, mathematical and other technical symbols, and characters used in non-Roman languages. Patrons must use a browser that supports Unicode, such as Versions 4.x and higher of Netscape® Navigator and Communicator and Microsoft® Internet Explorer.

WebZ also interprets Unicode characters in configuration files, in the format

\uxxxx

where xxxx is the four-digit hexadecimal code for a Unicode character. For example, \u0020 represents a space.

Similarly, the Record Builder interface in SiteSearch 4.2.0 also accepts user input with Unicode characters for updating local databases that support Unicode (such as Pears databases).

There is a new formatting class, ORG.oclc.fmts.obi.UTFRecordDumper, for dumping records with Unicode characters.

JaSSIServer.ini and ZBase.ini each contain a new parameter (UTF8EncodeInput in JaSSIServer.ini and supportsUTF8 in ZBase.ini) that you must set to TRUE to enable Unicode support in the WebZ interface.

<WebZ_root>/classes/lib/SS4_2_0.jar

<WebZ_root>/ini/JaSSIServer.ini

<WebZ_root>/ini/servers/ZBase.ini

ORG.oclc.fmts.obi.UTFRecordDumper
     (new)

ORG.oclc.gadgets.BookMarkFull
ORG.oclc.gadgets.ScanResults

ORG.oclc.obi.historyscreen

Multilingual Interface Support/New OBI Version

SiteSearch 4.2.0 ships with the OBI version 2, in addition to the OBI, version 1. Coupled with Unicode support, the OBI, version 2, lays the groundwork for multilingual interface support in WebZ.

The OBI, version 2, includes its own HTML files, gadgets, formatting configuration files, and interface style, interface display, and topics configuration files. It does not change the WebZ interface except to support language-specific labels, error messages, and images, which can be customized for a particular language with language configuration files.

Language Configuration Files and Language Tables
Language configuration files reside in subdirectories of <WebZ_root>/ini/interface/obiv2. SiteSearch 4.2.0 includes one directory, /en, with a set of English language configuration files. These files are examples that you can copy and modify to build language-specific configuration files.

The JaSSI uses language configuration files to build a language table for a particular language. The language configuration files have variables that contain labels for HTML pages, images, error messages, and other-language items. You specify the names and locations of language configuration files in a new section in JaSSIServer.ini, [InterfaceLanguages]:

[InterfaceLanguages]
default = interface/obiv2/en/langBase.ini
en = interface/obiv2/en/langBase.ini
zh = interface/obiv2/zh/langBase.ini

Here, there are two sets of language configuration files – en for English and zh for Chinese. (The Chinese language configuration files are not shipped with SiteSearch 4.2.0; this is an example to illustrate use of more than one set of language configuration files.)

Language configuration files use base files like interface style configuration files. For example, the langBase.ini file in the <WebZ_root>/ini/interface/obiv2/en directory has a [bases] section with references to other language configuration files.

Selecting a Language in the WebZ Interface
The opening screen for the OBI, version 2, <WebZ_root>/htdocs/obiv2/index.html, uses radio buttons to obtain the patron's choice of language:

<input id=en type="radio" name="language" \
value="en-US">
<Label for=en><a href= \
"/html/index_en.html">English</a></label>

<input id=zh type="radio" name="language" \
value="zh-CN">
<Label for=en><a href= \
"/html/index_zh.html">Chinese</a></label>

Based on the radio button selection, JaSSI would know whether to use the language configuration files associated with the interface language "en" ( value="en-US") or the interface language "zh" (value="zh-CN) for this WebZ session.

Language Table (&LangTable) Entities
In an HTML page, a gadget, a formatting configuration file, or an interface style or interface display configuration file, you specify a reference to a variable in a language configuration file as a &LangTable (language table) entity, similar to the &StyleTable and &FmtDisplay entities in configuration files and gadgets.

For example, the OBI, version 1, HTML page for the brief display, <WebZ_root>/htdocs/obiv1/html/brief.html, includes this line:

<TITLE>&StyleTable.pagetitles.HtmlHeadTitle;\
SearchResults</TITLE>

Its counterpart in the OBI, version 2, <WebZ_root>/htdocs/obiv1/html/brief.html, has this line in its place:

<TITLE>&LangTable.pagetitles.HtmlHeadTitle;\
&nbsp;&LangTable.pagetitles.results;</TITLE>

Both &LangTable entities refer to variables in the [pagetitles] section of a language configuration file. For the en (English) language, this section is in <WebZ_root>/ini/interface/obiv2/en/lang.ini:

[pagetitles]
HtmlHeadTitle = Open SiteSearch WebZ \
Demonstration
results = Search Results

Creating a Multilingual Interface
Here are the steps for creating and implementing a multilingual interface based on the OBI, version 2.

1. When you install the WebZ extension and WebZ, specify <WebZ_root>/htdocs/obiv2 as the Web server default document root directory.

2. Create language-specific configuration files based on the files in the <WebZ_root>/ini/interface/obiv2/en directory. Use a different directory for each language.

3. If needed, create new images with language-specific labels and move them to the <WebZ_root>/htdocs/obiv2/images directory. Then modify the [images] section of the appropriate interface style configuration file.

4. Modify index.html so that it provides a way for patrons to select the language of their choice.

5. Modify <WebZ_root>/ini/JaSSIServer.ini as follows:



• Uncomment the UTF8EncodeInput variable in the [JaSSI] section and set it equal to TRUE.
• Uncomment the [InterfaceLanguages] section. Modify it to reflect the name and location of each set of language configuration files.
• Change the path references in the [InterfaceStyles], [InterfaceDisplayGadgets], and [Topics] sections so that they refer to the appropriate /obiv2 subdirectory.
  
  

6. In <WebZ_root>/ini/servers/ZBase.ini, uncomment the supportUTF8 variable and set it equal to TRUE.

7. Modify any other HTML files, interface styles, formats, or Java classes related to the multilingual interface as needed.

<WebZ_root>/htdocs/obiv2 (new directory directory with same structure as /obiv1)
     index.html (new)
     /error (new directory)
     /html (new directory)
     /images (new directory)

<WebZ_root>/ini/format/obiv2 (new directory)

<WebZ_root>/ini/interface/obiv2 (new directory)

<WebZ_root>/ini/interface/obiv2/en (new directory)

ORG.oclc.gadgets.FormatRecords
ORG.oclc.gadgets.
     FormatRecordsWithDuplicates

ORG.oclc.gadget.obi (new class package)

ORG.oclc.obi.authorizescreen
ORG.oclc.obi.fulltextscreen
ORG.oclc.obi.historyscreen
ORG.oclc.obi.illconfirmscreen
ORG.oclc.obi.illformscreen
ORG.oclc.obi.initialize
ORG.oclc.obi.localholdingsscreen
ORG.oclc.obi.refinescreen
ORG.oclc.obi.resultsinfoscreen
ORG.oclc.obi resultsnavscreen
ORG.oclc.obi.scannavscreen
ORG.oclc.obi.scanresultsscreen
ORG.oclc.obi.searchrefinescreen

ORG.oclc.obi.extverb.BookMark
ORG.oclc.obi.extverb.EmailRecs
ORG.oclc.obi.extverb.HistoryQuery
ORG.oclc.obi.extverb.TopicQuery

ORG.oclc.util.Sorts
   

Description

Affected Files

New Location for Sample Notis Database

The database and server configuration files for a Notis database point to a different sample database.

<WebZ_root>/ini/dbs/Notis.ini

<WebZ_root>/ini/servers/Notis.ini

FastDoc Removed from WebZ OBI

FastDoc is no longer available as a FirstSearch database. Therefore, the WebZ OBI no longer includes a link to FastDoc and the FastDoc.ini database configuration file is not included in SiteSearch 4.2.0.

<WebZ_root>/ini/databases.ini

<WebZ_root>/ini/dbs/FastDoc.ini (removed)

FirstSearch Remote Database Name Changes

Applied Science & Technology Abstracts
Social Sciences Abstracts
FirstSearch recently changed the remote database name for Z39.50 per-search access to two databases included in the WebZ OBI, Applied Science & Technology Abstracts and Social Sciences Abstracts. The [database] section of their database configuration files includes a comment with its new database name. Use this name in the remoteZDbName variable if you subscribe to these databases on a per-search basis.

RILM Abstracts of Music Literature
The remoteZDbName variable in RILM.ini contains this database's new name for Z39.50 access – RILM_Music_Abstracts.

PapersFirst
The remoteZDbName variable in PapersFirst.ini contains this database's FirstSearch long name (papersfirst), rather than its alternate name (ppf1). This ensures that the database's name displays correctly in search results.

<WebZ_root>/ini/dbs/

AppliedSciTechAbstracts.ini
PapersFirst.ini
RILM.ini
SocialSciAbstracts.ini

BR154: Full Text Button Missing from Full Record Display for ABI/Inform