Versioning of the WebZ Out-of-the-Box Interface (OBI)

SiteSearch 4.1.0 introduces the concept of versioning the WebZ Out-of-the-Box Interface (OBI) whenever there are significant changes to the interface.

The version 4.1.0 release includes the 4.0.x frames-based interface (called OBI, version 0), and a new version of the OBI (version 1), which demonstrates the features included in OBI, version 0, as well as new features introduced in SiteSearch 4.1.

Each version has its own HTML files and interface styles. The OBI, version 1 has also a directory for rules-based formatting configuration files. Directories pertaining to OBI, version 0 are named obiv0, and those pertaining to OBI, version 1 are named obiv1.

This feature allows you to version your WebZ interfaces as you modify them and/or move your customized 4.0.x interface into its own directory. You specify which interface version to use in the JaSSIServer.ini configuration file.

<WebZ_root>/htdocs/
       obiv0/ (new)
       obiv1/ (new)

<WebZ_root>/ini/interface/
       obiv0/ (new)
       obiv1/ (new)

<WebZ_root>/ini/format/obiv1/ (new)

<WebZ_root>/ini/JaSSIServer.ini

New Version of the OBI

The OBI, version 1, the new version of the WebZ OBI in SiteSearch 4.1.0, incorporates all new functionality introduced in this release, including rules-based formatting, vocabulary-assisted searching, and combined result sets and de-duplication. In addition:

• There are new action-specific images (Search, Browse, and so on) instead of a single Go! button).
• HTML files consistently use style table references for font face and size and the common part of titles that appear in the browser title bar.
• There are three interface styles: a frames-based interface with the same green color scheme used in the 4.0.x OBI, a non-frames interface with a blue color scheme, and a resource sharing style with a blue color scheme. The sample data file for the accessdb database included with the Access component contains autho/password combinations assigned to each of the interface styles.
• It is possible to specify a namespace other than WebZ.
• The HTML files and Java classes introduced in version 4.0.2 for displaying search results and records from temporary databases are not included. However, they are still available in OBI, version 0.

<WebZ_root>/htdocs/obiv1/images/ (new directory)
<WebZ_root>/htdocs/obiv1/htdocs/ (new directory)
<WebZ_root>/htdocs/obiv1/error/ (new directory)

ORG.oclc.gadgets.BookMarkBrief
ORG.oclc.gadgets.ImageJumpbar
ORG.oclc.gadgets.ImageNav
ORG.oclc.gadgets.RefineScreen
ORG.oclc.gadgets.SearchResultsDbList
ORG.oclc.gadgets.TopicList

Files listed under No-Frames Interface

Files listed under Reuse Information Across Interface Style Files

<WebZ_root>/msql/accessdb.dump (UNIX)
<WebZ_root>/accesssql/accessdb.sql (Windows NT)

Non-Frames Interface Demonstrated in OBI, Version 1

OBI, version 1, includes both frames-based and non-frames interfaces with identical features. To easily distinguish the two interfaces, the non-frames interface uses a blue color scheme and the frames-based interface has the same green color scheme used in 4.0.x versions.

Some HTML files have been modified to accommodate a no-frames interface, and there are new HTML files specific to a no-frames interface. (The new files have the same name as analogous files in the frames-based interface except that their names begin with the letters "nf".) There are also new gadgets that support both interfaces.

The interface style and interface display configuration files for the no-frames interface include "noframe" in their name. There are rules-based formats for record display in the no-frames interface.

The [formats] section of all database configuration files contains references to formats used in the non-frames interface, as well as those applicable to the frames-based interface. These formats all begin with the letters "NF".

<WebZ_root>/htdocs/obiv1/html/
      advancedsearch.html
      blankillform.html
      bookmarkemail.html
      bookmarkfull.html
      bookmarks.html
      brief.html (new)
         (replaces results.html)
      copyright.html
      definetopic.html
      full.html (new)
         (replaces record.html)
      fulltext.html
      help.html
      historysearch.html
      illconfirm.html
      illform.html
      nfbookmark.html (new)
      nfbrief.html (new)
      nfdblist.html (new)
      nffull.html (new)
      nffulltext.html (new)
      nfrefine.html (new)
      nfrefinescan.html (new)
      nfscanresults.html (new)
      nfsort.html (new)
      scansearch.html
      search.html
      topicadvancedsearch.html
      topicsearch.html

<WebZ_root>/ini/dbs/

<WebZ_root>/ini/interface/obiv1/
       noframeDisplayGadgets.ini
       frameDisplayGadgets.ini

ORG.oclc.gadgets.
   BriefSearchResultsHeader (new)
ORG.oclc.gadgets.DbListforScanResult (new)
ORG.oclc.gadgets.DbListforSearchResult (new)
ORG.oclc.gadgets.FullRecordHeader (new)
ORG.oclc.gadgets.FullTextHeader (new)
ORG.oclc.gadgets.IllForm (new)
ORG.oclc.gadgets.ImageDisplay (new)
ORG.oclc.gadgets.ToolbarAnchor (new)

ORG.oclc.obi.briefscreen
ORG.oclc.obi.currentstate
ORG.oclc.obi.fullscreen
ORG.oclc.obi.resultsinfoscreen
ORG.oclc.obi.searchrefinescreen
ORG.oclc.obi.startscreen

ORG.oclc.obi.extverb.AdvancedQuery

Rules-Based Formatting

SiteSearch 4.0.x releases include a number of Java formatting classes for formatting record displays. To change record formatting you had to edit these classes or write your own classes.

SiteSearch 4.1.0 introduces rules-based formatting, a new way of creating and modifying record display formats that does not usually require writing or modifying Java code.

Rules-based formatting uses formatting configuration (.ini) files that contain display specifications. Each display specification consists of one or more rule specifications (formatting rules), which are the building blocks of a display.

Rule specifications refer to Java formatting classes that implement one aspect of a record display format, such as adding a record number, adding the record data, or adding a save button. If the Java class requires parameters, you provide them as part of the rule specification. The field(s) or subfield(s) that you want to include in the record display may be one of the parameters required by a formatting rule.

Some formatting rules use labels or HTML code to precede or follow record data ("data wrappers"). You specify data wrappers in the relevant interface display configuration file (such as displayGadgets.ini).

You create or modify a record display format by selecting the rule specifications that build the elements of the display that you need and specifying their parameters in a formatting configuration file.

As in Site Search 4.0.x versions, you specify a database's formats in its database configuration file. However, instead of referring to a formatting class, you refer to a formatting configuration file. All database configuration files shipped with SiteSearch 4.1.0 refer to formatting configuration files instead of formatting classes. However, you can continue to use your existing 4.0.x formatting classes with SiteSearch 4.1. In addition the OBI, version 0, interface display formatting file, displayGadgets.ini, refers to the rules-based formats rather than the 4.0.x formatting classes.

SiteSearch 4.1.0 includes a new directory for formatting configuration files (<WebZ_root>/ini/format/obiv1/). The formatting rules themselves are contained in a new class package, ORG.oclc.fmts.rules.

See WebZ Rules-Based Formatting for more information.

ORG.oclc.fmts.ber2txt
ORG.oclc.fmts.FieldData (new)
ORG.oclc.fmts.FormatBerUtil
ORG.oclc.fmts.RuleSpec (new)
ORG.oclc.fmts.RulesBasedDisplayGenerator (new)
ORG.oclc.fmts.rules package (new package)

ORG.oclc.gadgets.FormatRecords
ORG.oclc.gadgets.
    FormatRecordsAndAttachHoldings
ORG.oclc.gadgets.Record Holdings

ORG.oclc.obi.refinescreen
ORG.oclc.obi.sortscreen

<WebZ_root>/ini/dbs/

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

<WebZ_root>/ini/interface/obiv0/
       DisplayGadgets.ini

<WebZ_root>/ini/interface/obiv1/
      frameDisplayGadgets.ini
      noframeDisplayGadgets.ini

• Thesaurus database associated with the target database
                and/or
• Sample result set from the target database

For databases associated with thesauri, WebZ builds a term list from the target database if the patron's search term does not exist in the associated thesaurus database.

The term list includes check boxes that allow the patron to select one or terms to search the target database. The terms have links to a thesaurus tree if the target database is associated with a thesaurus database and the patron's term exists in the thesaurus. The thesaurus tree shows a term with respect to broader, narrower, and related terms in the thesaurus. Term list and thesaurus tree displays use the rules-based formatting introduced in version 4.1.

In the 4.1.0 release, four databases are associated with thesauri on the SiteSearch demo site for illustrative purposes (ERIC, Medline, PsycInfo, and WorldCat). Numerous other catalog and citation databases demonstrate creation of term lists from the database itself in the release as well.

You must obtain a license for each thesaurus you wish to use, as you do for other databases. Since thesauri are stored in databases, you need to configure a thesaurus database as you would any other database.

Database configuration files have a new [TermFinder] section for configuring term lists generated from sample result sets.

See WebZ and Vocabulary-Assisted Searching for more information.

<WebZ_root>/ini/interface/obiv1/
       frameDisplayGadgets.ini
       noframeDisplayGadgets.ini

<WebZ_root>/ini/dbs/
       ERICThesaurus.ini (new)
       PsycThesaurus.ini (new)
       MeSH.ini (new)
       LCSH.ini (new)

<WebZ_root>/htdocs/obiv1/html/
       termfindersearch.html (new)
       termlist.html (new)
       thestree.html (new)

<WebZ_root>/htdocs/obiv1/error/
      badtermfinder.html (new)
      voasnotsupported.html (new)

ORG.oclc.gadgets.SearchTabbar
ORG.oclc.gadgets.TermFinderHeader (new)
ORG.oclc.gadgets.TermListDisplay (new)
ORG.oclc.gadgets.ThesNavButtons (new)
ORG.oclc.gadgets.ThesTreeDisplay (new)

ORG.oclc.obi.extverb.TermFinderQuery (new)
ORG.oclc.obi.extverb.ThesaurusQuery (new)

ORG.oclc.fmts.zbase.ThesaurusBriefBerFmt (new)

Previous versions of SiteSearch displayed the results of a cross-database search as a group of individual result sets, one from each database. Patrons had to navigate each result set individually.

Version 4.1.0 introduces two new features to enhance cross-database searches – combined result sets and de-duplication.

Combined result sets

A combined result set displays search results from one or more databases as a single continuous result set. The databases can be from a either a predefined topic or a user-defined topic. Each record in the result set retains its identification with the database from which it was retrieved. In the OBI, version 1, the search results summary includes the number of records from each database.

A new SupportsMergeReads parameter in the [ZBase] section of <WebZ_root>/ini/servers/ZBase.ini enables or disables combined result set functionality in version 4.1.0. By default, SupportsMergeReads=true (enable combined result sets).

De-duplication

De-duplication implements Z39.50-1995 Amendment 2: Z39.50 Duplicate Detection Service. De-duplication utilizes WebZ's combined result set functionality. It allows WebZ to detect and then group, or cluster, duplicate records under a single representative record. WebZ supports de-duplication for a group of databases (topic) or a within a single database that contains duplicate records.

For a group of databases, you specify the manner in which you want de-duplication to occur in a new [dedup] section of the group database configuration file. The [dedup] section includes a de-duplication key.

A de-duplication key is similar to a database sort key. De-duplication keys use a new 4.1.0 feature, the ability to define custom sort keys.

You also specify rules-based formats that support de-duplication in the [formats] section of the database configuration file for each database in the group.

See WebZ Cross-Database Searching Functionality for more information.

<WebZ_root>/ini/servers/ZBase.ini

Version 4.1.0 introduces the concept of base styles. You can create base interface style files with information common to multiple interface styles and reference them in other files. You can also include statements in individual interface style files that override information in a base style.

For example, if two interface styles are identical except for colors and images, a base style (such as BaseStyle.ini) could contain all interface style information except for colors and images. Then the individual interface style files (such as blueStyle.ini and greenStyle.ini) would contain a reference to the base style and [colors] and [images] sections for the colors and graphics for that particular style.

In this example, you would add these statements to blueStyle.ini and greenStyle.ini to refer to BaseStyle.ini:

An interface style can have more than one base and a file that is a base in one configuration file can have its own base files. See the interface style files frameGreen.ini and noframeBlue.ini in <WebZ_root>/ini/interface/obiv1 and their base files for an illustration of this concept.

<WebZ_root>/ini/interface/obiv1/ (all new)
       BaseFrameStyle.ini
       BaseNoFrameStyle.ini
       BaseStyle.ini
       colorsBlue.ini
       colorsGreen.ini
       fontsArial.ini
       frameBlueStyle.ini
       frameGreenStyle.ini
       frameRssStyle.ini
       imagesBlue.ini
       imagesGreen.ini
       noframeBlueStyle.ini
       noframeGreenStyle.ini
       pagesFrame.ini
       pagesNoFrame.ini

ORG.oclc.gadgets.GadgetAndStyleLoader

New bookmarking options introduced in version 4.0.2 allow you to provide the ability to:

• bookmark more than one record at a time.
• "unsave" (remove) all bookmarked records on the saved record list at one time.

ORG.oclc.obi.extverb.BookMark
ORG.oclc.obi.extverb.EmailRecs

ORG.oclc.obi.util.BookMarkEntry

<WebZ_root>/htdocs/obiv1/html/
       bookmarkfull.html
       brief.html
       fulltext.html
       nfbrief.html (new)
       nffulltext.html (new)

Combining Subfields for Hotlinks on Full Record Display

The version 4.0.x formatting classes did not automatically combine subfields on hotlinks on the full record display. For example, if the subjects field contained the following:

Hurricane protection -- United States -- Research

each item separated by dashes would have a separate hotlink to conduct a search of just that item (such as Hurricane protection).

The formatting rules introduced in version 4.1.0 can combine subfields in this type of a search. Among the formatting rules that accomplish this are:

ORG.oclc.fmts.rules.AddCompoundSubjectPhrase
ORG.oclc.fmts.rules.AddRecordData

A number of the database configuration files shipped in the 4.1.0 release refer to formatting configuration files that use these formatting rules to implement this feature.

Alternate Namespace

SiteSearch 4.1.0 supports using a namespace other than WebZ by adding references in interface style files for the alternate namespace and default queries (SCAN, QUERY, AND FETCH) that contain the namespace.

All URLs in your SiteSearch system contain the namespace, like this:

http://bongo:19860/WebZ/Authorize? \ 
  sessionid=0

If you use MySite as the namespace, the URLs would then look like this:

http://bongo:19860/MySite/Authorize? \ 
   sessionid=0

HTML files in the OBI, version 1, and gadgets use these style table references instead of hard-coded references to the WebZ namespace. Because HTML files in OBI, version 0 use these gadgets as well, the interface style files for OBI, version 0 also contain style table references to the default queries, although the HTML files do not.

If you decide to customize the namespace, you must change it in the following configuration files in addition to your interface style files:

<WebZ_root>/ini/
     JaSSIServer.ini
     WebSvrExt.ini

<WebZ_root>/htdocs/obiv1/html/

<WebZ_root>/htdocs/obiv1/error/

<WebZ_root>/ini/interface/obiv0/
       defaultStyle.ini
       redStyle.ini
       rssStyle.ini

<WebZ_root>/ini/interface/obiv1/
       BaseStyle.ini

ORG.oclc.gadgets package

ORG.oclc.obi.historyscreen
ORG.oclc.obi.initialize

Support for Additional Bib-1 Attribute Types

Previous versions of SiteSearch allowed you to set default values for each index defined for a database (or database group) for the Z39.50 Bib-1 use and structure attributes. SiteSearch 4.1.0 extends this capability to the other four attribute types: relation, position, truncation, and completeness. This enhancement allows you to add these attributes to queries to Z39.50 targets that support their use.

You may use these attributes as needed on a per database, per index basis. Add the default values after the use and structure lines in the index definitions. For example:

position=1

indicates that a search should always begin at the beginning of the field, since 1 is the Bib-1 position value that signifies first in field.

See ANSI/NISO Z39.50-1995, Appendix 3, ATR: Attribute and/or Attribute Set Bib-1 (Z39.50-1995): Semantics for the allowable values for each attribute type.

See these database configuration files for examples of indexes with additional Bib-1 attribute types:

<WebZ_root>/ini/dbs
       DRAMultiLIS.ini
       Dynix.ini
       III.ini
       MedlineOvid.ini
       RLG-Zephyr.ini
       Sirsi.ini

<WebZ_root>/classes/lib/
   SS4_1_0.jar

License Management

For licenses based on the number of simultaneous users, SiteSearch 4.1.0 allows you to configure your environment (via the OpServe.ini configuration file) to limit the number of simultaneous user sessions for WebZ and Database Builder in conformance with your license agreement.

When WebZ or Database Builder reaches this limit, the next patron or staff member receives a message that indicates that the system is unavailable and a new session does not start.

The allServer.stats log file records occurrences when patrons and/or staff cannot access the system because simultaneous user limit has been exceeded.

Enhancements to Holdings Display

Version 4.1.0 displays holdings from full record displays with an improved tabular display that can display holdings from more than one database.

You specify the databases as input to ORG.oclc.fmts.rules.AddLocalHoldingsButton. The [LibHoldingsLink] section of the formatting configuration file <WebZ_root>/ini/format/obiv1/MarcArticleRules.ini demonstrates the use of this formatting rule.

ORG.oclc.fmts.obi.MarcCatalogFmt

ORG.oclc.obi.localholdingsscreen

<WebZ_root>/htdocs/obiv1/html/
     localholdings.html

Interlibrary Loan (ILL) Processing Enhancement

The ILL confirmation screen (illconfirm.html) displays a default message if interlibrary loan services are enabled for a database but the ILL service type is not specified in the database configuration file.

Define Custom Sort Keys

SiteSearch 4.1.0 allows you to create custom sort keys for sorting records and for de-duplicating records in a cross-database search or a single database search that contains duplicate records.

This feature implements the ORG.oclc.db.IDbSortKey interface and allows you to specify the fields to use for sorting or de-duplicating records. If you do not define a sort key class, this class uses ORG.oclc.zsorts.DefaultSortKey for performing the sort or de-duplication. The ORG.oclc.zsorts package also includes two other examples of custom sort key classes.

Query Parser Enhancement

SiteSearch 4.1.0 contains query normalization (filter) classes that allow you to manipulate patrons' search terms to better match specific database indexes.

The query normalization classes are included in a new class package, ORG.oclc.qnorm, and have been developed for a wide variety of databases. However, you can also write your own query filters and apply them on a per-database or per-index basis.

The [BIB1attributes] section of each database configuration file now contains a line like this to specify the appropriate query filter for the database:

filter = \
ORG.oclc.qnorm.RemoteZFSTermNormalizer

You can also use different query filters on a per-index basis by adding the filter= line to each index.

<WebZ_root>/ini/dbs

ORG.oclc.qnorm package (new)

ORG.oclc.obi.extverb.HistoryQuery

For remote databases, Version 4.1.0 allows you to remap the incoming ElementSetName on a present request to an element set name specific to the target database.

You do this by adding one or more of the following parameters to the [database] section of the remote database's configuration file:

where <string> is the database-specific element set name for brief, full, or full text records, respectively.

Specify and Create Formatting Classes for OPAC Record Syntax Records

For remote and Newton databases, SiteSearch 4.1.0 allows you to specify and create formatting classes to create OPAC Record Syntax records to be returned on a present request from ZBase. Two .ini parameters in the [Formats] section of the database configuration file allow you to specify the appropriate formatting class, as follows:

Z39FullOpac  = <fmt_class>
Z39BriefOPAC = <fmt_class>

for full and brief records, respectively.

ORG.oclc.fmts.zbase.ExampleOPACFmt is an example class that demonstrates how to create OPAC Record Syntax Records.

See ANSI/NISO Z39.50-1995, Appendix 5, REC: Record Syntaxes for more information about OPAC Record Syntax Records.

<WebZ_root>/ini/dbs/

ORG.oclc.fmts.zbase.ExampleOPACFmt
ORG.oclc.fmts.zbase.OPACapi

Example Class for Z39.50 Extended Services Requests

Version 4.1.0 includes a new class, ORG.oclc.obi.extverb.ExampleExtSvc, that demonstrates how to create Z39.50 Extended Services Requests.

Support for Z39.50 Normarc Record Syntax

Version 4.1.0 now supports the Z39.50 Normarc record syntax. To specify this record syntax, specify:

recordSyntax = NORMARC

in the [database] section of the database configuration file.

See ANSI/NISO Z39.50-1995, Appendix 5, REC: Record Syntaxes for more information.

<WebZ_root>/ini/dbs/

Version 4.1.0 adds database and server configuration files for two additional vendors – Dynix and RLG-Zephyr.

<WebZ_root>/ini/dbs/
       Dynix.ini
       RLG-Zephyr.ini

<WebZ_root>/ini/servers/
       Dynix.ini
       RLG-Zephyr.ini

Version 4.1.0 renames database and server configuration files for DRA and MultiLis to DRAClassic and DRAMultiLIS, respectively, to conform to DRA's naming conventions.

<WebZ_root>/ini/dbs/
       DRAClassic.ini
       DRAMultiLIS.ini

<WebZ_root>/ini/servers/
       DRAClassic.ini
       DRAMultiLIS.ini

Version 4.1.0 includes the following refinements to database configuration files shipped with this release:

• New indexes and specification of use and structure attributes in indexes, where appropriate
• Increasing the value of the maxAutoSortRecords parameter in the [sort] section of databases that support sorting

To streamline and make server configuration files consistent, some server configuration files no longer contain default values. See Database Server Configuration Files or a list of these values from the June 1999 InSite for information about server configuration file defaults.

Time Socket Connection for Servers

In rare cases, a remote server hosting a database may not respond quickly to failed connection attempts. To handle this situation, Version 4.1.0 adds a new flag (timeTheSocketConnect=<true> or <false>) to server configuration files. By default, there is no timeout on the software attenting to make a socket connection. If set to true, this flag invokes a 10,000 millisecond timer to time the connection on the call to new Socket().

Version 4.0.2 allows you to replace numerals in ordered lists in configuration files with asterisks, but version 4.0.2 was shipped with numerals in ordered lists. The configuration files in version 4.1.0 now contain asterisks instead of numerals in ordered lists.

[ZBase]
MaintainMinimum = true
MinServers = 1
MaxServers = 10

If MaintainMinimum=true, when a server stops or crashes for any reason, OpServe starts a new server of that type at the next OpServe polling period.

Note: The default value for MaintainMinimum is false.

(2) OpServe now adds the following information to its log whenever it starts a server:

[D19990415.T094545.217][Thread:main] \
[Starter.start()]
zbase starting
Host: bongo
zbase: numServersRunning=1 minServers=1 \
maxServers=10

<WebZ_root>/ini/OpServe.ini

<WebZ_root>/classes/lib/SS4_1_0.jar

OpServe log files in <WebZ_root>/logs/

Change in Memory Threshold for JaSSIServer

The JaSSIServer in SiteSearch 4.1.0 requires more memory than in 4.0.x versions. The new memory thresholds are as follows:

[hostname]
LowUsedMemory =  15000
MedUsedMemory =  20000
HighUsedMemory = 25000

Version 4.1.0 adds a new trace level to server logs: TRACE_HOUSEKEEPING.

This trace level adds housekeeping statistics to the server logs, such as this example from JaSSIServer.ini:

[D19990716.T133044.778] [Thread:Thread-31] \
[JaSSI.housekeeping()]
Housekeeping
------------ 
Number of active user sessions = 1 
Number of active users connected = 0 
Number of active threads = 5
Priority of current thread = 5
Total Memory available = 14680064
Total Free Memory available = 3510876
Check active threads for timeouts:
---------------------------------- 
Completed check on active threads for \
timeouts.

<WebZ_root>/ini/
       JaSSIServer.ini
       ZBaseServer.ini
       ZBrokerServer.ini
       AccessServer.ini

ssadmin utility

<WebZ_root>/classes/lib/SS4_1_0.jar

Increase Access to Variables in Selected Classes

(1) Some variables in ORG.oclc.gadgets.SearchHeader were modified to make them protected to allow other classes to extend them.

(2) Some variables in ORG.oclc.fmts.Diacritic were changed from static variables to public variables.

• frames and no-frames versions
• a list of deprecated classes
• class descriptions on a package's index page
• lists of all uses of each class

See <WebZ_root>/htdocs/obiv1/api/help-doc.html for more information.

<WebZ_root>/htdocs/obiv1/help/api/

URI/URL Syntax Conformance with RFC 2396

The WebZ Extensions for the new Web server versions supported in version 4.1.0 and the Web server versions shipped with 4.0.x releases now conform to RFC 2396, Uniform Resource Identifier: Generic Syntax. To conform to this standard, each WebZ Extension inserts the user sessionid after the question mark (?) in the URL. Open SiteSearch 4.0.x releases place the sessionid before the question mark in the URL, which does not comply with the RFC 2396 standard accepted within the Internet community.

New (4.1) URL syntax
"/WebZ/html/search.html:active=1? \ 
sessionid=01-3962-1582399739:topic="

Old (4.0.x) URL syntax
"/WebZ/html/search.html:active=1: \
sessionid=01-3962-1582399739?topic="

URLs in HTML files in version 4.1.0 (in both OBI, version 1 and OBI, version 0) use the RFC-2396 compliant syntax.

You should upgrade to the new WebZ extension even if you continue to use an older version of your Web server. However, you also need to modify any customized HTML files to ensure that they support the new URL syntax shown above. See Upgrading to Open SiteSearch 4.1.0 for more information.

<WebZ_root>/htdocs/obiv1/html
<WebZ_root>/htdocs/obiv1/error
<WebZ_root>/htdocs/obiv0/html
<WebZ_root>/htdocs/obiv0/error

ORG.oclc.gadgets package

Support for New Web Server Versions

In addition to the Web servers supported by SiteSearch 4.0.x, SiteSearch 4.1.0 adds support for the following new Web server versions:

• Apache 1.3.6 (UNIX only)
• Netscape FastTrack 3.01 (UNIX and Windows NT)
• Netscape Enterprise 3.61 (UNIX and Windows NT)

Record Builder

In SiteSearch 4.1.0, Database Builder includes a new application, Record Builder. Record Builder is an end-user application built on WebZ technology that harnesses Database Builder's administrative utilities to allow the creation, modification, and maintenance of Newton searchable databases for local collections of such things as images, sound files, Web sites, and data. Through its own pre-built Web interface, Record Builder offers an alternative to batch updating by providing cataloguers a way to add, modify, and delete single records online using a variety of predefined templates and workforms. The Database Builder installation automatically installs Record Builder, but its use is optional.

In a SiteSearch environment that includes Record Builder, a single OpServe manages both WebZ and Record Builder. Record Builder has its own Web server port and Web server extension, JaSSI and ZBase servers (JaSSIRB and ZBaseRB), and Access server (AccessServerRB), and a Lock server. This is the usual configuration, although it is possible to set up Record Builder-only environment.

Web Servers for Windows NT with Record Builder
If you are using the Microsoft Internet Information Server (IIS) as your Web server, it is not possible to run WebZ and Record Builder simultaneously on a single machine. Your options are to:

• Use Netscape as your Web server, which will allow you to run WebZ and Record Builder simultaneously on the same machine
• Use IIS as the Web server for a WebZ-only environment and Netscape as the Web server for a Record Builder-only environment or a WebZ/Record Builder environment
• Use Netscape as the Web server for a WebZ-only environment and IIS as the Web server for a Record Builder-only environment
• Use IIS as the Web server for a WebZ-only environment on one machine and IIS as the Web server for a Record Builder-only environment on another machine

Databases
SiteSearch 4.1.0 includes four sample Record Builder databases and accompanying templates and workforms:

Structure of <WebZ_root>/dbbuilder/dbs Directory
As in SiteSearch 4.0.x versions, there is a subdirectory for each database in <WebZ_root>/dbbuilder/dbs. Under the database's directory, such as <WebZ_root>/dbbuilder/dbs/eres, there are additional files and directories:

• *.xml templates, the database description (.dsc) file, and the database tag definition (.dtd) file
• /data, /journal, and /updatelogs directories for Record Builder
• /db directory, which contains the database's five physical files

<WebZ_root>/dbbuilder/dbs also contains a new /save directory.

Configuration
Record Builder has its own configuration files; the files are analogous to those in a WebZ-only environment. To distinguish these files, their names end with "_rb" . For example, JaSSIServer.ini pertains to a WebZ-only environment and JaSSIServer_rb.ini pertains to a SiteSearch environment that includes both WebZ and Record Builder.

You specify the configuration files for the databases that you plan to manage with Record Builder in Record Builder's databases_rb.ini file. These database configuration files use the same format as other SiteSearch database configuration files. If you want your patrons to view the databases you manage with Record Builder in your WebZ interface, you must include these databases in databases_ini, and create database configuration files for them.

Start-up Scripts
There are also new scripts for starting Record Builder. The apache_rb script starts the Apache Web server running on the port designated for Record Builder. The ssadmin_rb script starts all the servers necessary for a SiteSearch environment that includes both WebZ and Record Builder.

Interface
The Record Builder interface (designated Version 0) has its own HTML files, interface style files, and interface display gadgets configuration file, and uses the rules-based formatting introduced in SiteSearch 4.1.0. Its interface style files are built around a base style. The HTML files reside in <WebZ_root>/htdocs/rbv0. This directory also has a number of subdirectories. The .ini files reside within the standard configuration file structure in separate /rbv0 subdirectories.

Java classes
There are Java classes specific to Record Builder in a new class package, ORG.oclc.mantis.

Database Configuration Files
<WebZ_root>/ini/dbs/ (new)
      localARCH_rb.ini (new)
      localERES_rb.ini (new)
      localSave_rb.ini (new)
      localdc_rb.ini (new)
      localmcat_rb.ini (new)
      Lock.ini (new)
      localERES.ini
      localARCH.ini (new)

Structure of <WebZ_root>/dbbuilder/dbs Directory
      <WebZ_root>/dbbuilder/dbs/save (new)
      <WebZ_root>/dbbuilder/dbs/database/
            /data (new)
            /db
            /journal
            /updatelogs

Other Configuration Files
<WebZ_root>/ini/
      Access_Server_rb.ini (new)
      JaSSIServer_rb.ini (new)
      LockServer.ini (new)
      OpServe_rb.ini (new)
      SSAdmin_rb.ini (new)
      WebSvrExt_rb.ini (new)
      ZBaseServer_rb.ini (new)
      databases_rb.ini (new)

<WebZ_root>/ini/servers/
      Access_rb.ini (new)
      ZBase_rb.ini (new)

<WebZ_root>/httpd/apache_1.3.6/httpd_rb.conf
(new) - UNIX only

<WebZ_root>/ini/mantis/ (new directory)

Scripts
<WebZ_root>/scripts/
     apache_rb (new)
     ssadmin_rb (new)
     ssadmin_rb.bat (new) - Windows NT only

HTML files and images
<WebZ_root>/htdocs/rbv0/ (new directory)
     /dbdata
     /error
     /help/api/
     /html
     /images
     index.html

Interface style and display gadgets files
<WebZ_root>/interface/rbv0/ (new directory)

Formatting rules
<WebZ_root>/format/rbv0/ (new directory)

Java classes
ORG.oclc.lock package (new)
ORG.oclc.mantis.gadgets package (new)
ORG.oclc.mantis.hooks package (new)
ORG.oclc.mantis.obi package (new)
ORG.oclc.mantis.util package (new)

Access Component

The Access component now includes the ability to control access to local databases that staff maintain with Record Builder. You can assign access privileges (read, write, delete, view, and/or admin) to Record Builder staff on a per-database basis.

JaSSIRB and ZBaseRB servers for Record Builder include built-in Access clients and there is a separate Access server for Record Builder (AccessServerRB).

The rbdb database contains authentication and authorization data for Record Builder users. The Database Builder installation includes a sample data file for creating the rbdb database.

New Parameters for Pippin Utility

The pippin utility has two new parameters:

SSDOT has been modified to accept these new parameters as well.

<WebZ_root>/dbbuilder/pippin

<WebZ_root>/dbbuilder/ssdot/ssdot

New Parameters for Other Internal Database Utilities

The indxloop and valindex utilities (which are internal to Database Builder) have several new parameters, which are read from their input:

The programs that run these utilities automatically provide these parameters as needed.

SSDOT Online Local Database Updates

SiteSearch 4.1 release enables you to perform local online database updates using the SSDOT interface to access the database building utilities without stopping the WebZ system. This feature allows WebZ to immediately provide patrons with access to the updated database information as soon as the update is complete. You no longer need to stop and restart the WebZ system to access the updated database information. Online updates also support Record Builder.

<WebZ_root>/dbbuilder/ssdot/ssdot
<WebZ_root>/dbbuilder/ssdot/exes/hardini.pl
<WebZ_root>/dbbuilder/ssdot/exes/maint.pl

<WebZ_root>/dbbuilder/bin/dumpbdam
<WebZ_root>/dbbuilder/bin/dumpdbdesc
<WebZ_root>/dbbuilder/bin/dumpnip
<WebZ_root>/dbbuilder/bin/indxloop
<WebZ_root>/dbbuilder/bin/initdb
<WebZ_root>/dbbuilder/bin/newtsize
<WebZ_root>/dbbuilder/bin/pippin
<WebZ_root>/dbbuilder/bin/pipreorg
<WebZ_root>/dbbuilder/bin/rome
<WebZ_root>/dbbuilder/bin/romemerg
<WebZ_root>/dbbuilder/bin/routines.h
<WebZ_root>/dbbuilder/bin/sortnip
<WebZ_root>/dbbuilder/bin/testmem
<WebZ_root>/dbbuilder/bin/valindex
<WebZ_root>/dbbuilder/bin/vallists

BR072: Truncated and Proximity Searches on Newton Databases Throw Exceptions

WebZ

<WebZ_root>/classes/lib/SS4_1_0.jar

BR071: Searches Using Multiple Restrictors on an Advanced Search Page are Parsed Incorrectly

WebZ

<WebZ_root>/classes/lib/SS4_1_0.jar

BR070: Searches Using Multiple Restrictors are Parsed Incorrectly when Using 'NOT'

WebZ

<WebZ_root>/classes/lib/SS4_1_0.jar

BR069: Z39.50 Connections to ZBroker Fail

WebZ

<WebZ_root>/classes/lib/SS4_1_0.jar

BR068: Associated Database Topics Do Not Display when a Patron is ReAuthorized

WebZ

ORG.oclc.obi.util.Topics

BR067: HideInMenus Option Ignored After Patron ReAuthorization

WebZ

<WebZ_root>/classes/lib/SS4_1_0.jar

BR066: Piping Unix Commands to SSAdmin Throws SSAdmin into a Loop

WebZ

<WebZ_root>/classes/lib/SS4_1_0.jar

BR065: Hotlink Queries from a Scan Term Fail if the Scan Term Contains Special Characters

WebZ

BR064: Results of Topic Search Continue to Display After Searching a Single Database

WebZ

BR063: Error Messages Do Not Display Correctly in WebZ

WebZ

<WebZ_root>/classes/lib/SS4_1_0.jar

BR062: Database Builder Users Cannot Specify Which Special Characters to Replace or Delete in a Phrase Index

WebZ

WebZ

BR061: WebZ Incorrectly Handles Structure Attributes

WebZ

<WebZ_root>/classes/lib/SS4_1_0.jar

BR060: WebZ Incorrectly Handles Structure Attributes in a Scan Request

BR059: Restrictor Searches for Local Newton Databases Are Failing

WebZ

<WebZ_root>/classes/lib/SS4_1_0.jar

BR058: The WebZ Formatting Classes Do Not Parse/Display MARC Holdings Information Correctly

WebZ

ORG.oclc.fmts.obi.MarcCatalogFmt

BR057: Searches Using Date Ranges Are Not Configured For Newton Databases in the Out of the Box Interface (OBI)

WebZ

<WebZ_root>/classes/lib/SS4_1_0.jar