|
Description of the Open SiteSearch 4.0.2 Release
Table of Contents
Introduction
Document Conventions
New Functionality and Software Enhancements
-- New Functionality
-- Software Enhancements
Bug Fixes
Introduction
This document provides a detailed list of the new functionality, software enhancements, and bug fixes included with the Open SiteSearch suite 4.0.2 release. Read this document before upgrading an existing version of the Open SiteSearch software to version 4.0.2. SiteSearch 4.0.2 includes the functionality of versions 4.0.0, 4.0.0a, and 4.0.1, as well as new software features, enhancements, and bug fixes.
Important Note: After you carefully review this document, refer to Upgrading to Open SiteSearch 4.0.2 for specific instructions about upgrading your current SiteSearch environment to version 4.0.2.
Document Conventions
Throughout this document, <WebZ_root> refers to the location of your WebZ environment.
New Functionality and Software Enhancements
Important Note: The SS4_0_2.jar file contains the software byte code and replaces the jar file(s) included in previous versions of the Open SiteSearch suite.
All software enhancements in version 4.0.2 occur in the WebZ component of SiteSearch.
New Functionality
|
Description
|
Affected Files
|
|
Support for Java Mail 1.1
The JavaMail API provides a platform-independent and protocol-independent framework to build Java-based mail and messaging applications. It provides a set of abstract classes that model a mail system. The JavaMail API is implemented as a Java standard extension.
SiteSearch 4.0.2's e-mail capabilities have been updated to use Sun's JavaMail 1.1 API. Sun did not make this API available in time for use in previous SiteSearch versions. See Sun's Web site for more information about JavaMail.
|
ORG.oclc.obi.extverb.EmailRecs
<WebZ_root>/classes/lib/activation.jar
<WebZ_root>/classes/lib/mail.jar
|
|
Additional
Support for Temporary Databases
Version 4.0.2 includes new HTML pages and corresponding JavaPage classes for displaying search results and records from temporary databases.
New sections in DisplayGadgets.ini support formatting of search results from a temporary database, records from a temporary database, and dumping temporary records for debugging purposes.
The JumpBar gadget includes a new parameter, tempDb, indicate whether to format records from a temporary database search. tempDB can set to either true or false; the default is true.
The style files (defaultStyle.ini, rssStyle.ini, and redStyle.ini) contain new references to the new HTML pages and anchors on these pages.
Some temporary database searches (such as those against a holdings database) do not occur in response to a query that a user explicitly enters. These searches may yield no records. When a search yields no records, the user normally sees a display created by refine.html, which includes text input fields for refining the search and a message that no records could be retrieved. However, when the search occurs against a temporary database and cannot be refined by the user, refine.html now displays only the error message.
Formatting information in refine.html has been replaced by a new StyleTable gadget, which determines which format to use (refine text input fields and the error message, or just the error message). The style files contain a reference to this gadget.
|
<WebZ_root>/ini/interface
<WebZ_root>/htdocs/html
ORG.oclc.gadgets.RefineScreen
ORG.oclc.gadgets.TempNav
ORG.oclc.gadgets.JumpBar
ORG.oclc.obi.temprecordscreen
ORG.oclc.obi.tempresultsframescreen
ORG.oclc.obi.tempresultsnavscreen
ORG.oclc.obi.tempresultsscreen
|
|
Enhanced Z39.50 Access Control Support
Version 4.0.2 adds Z39.50 support for access control to respond to requests for authentication by a target server. See Section 3.2.5, Access Control Facility, in ANSI/NISO Z39.50-1995, for more information about this feature.
|
<WebZ_root>/classes/lib/SS4_0_2.jar
<WebZ_root>/htdocs/error/
|
Software Enhancements
|
Description
|
Affected Files
|
|
Improved Formatting for ILL Requests from Citation Databases
Version 4.0.2 provides more complete information for ILL requests from databases that contain citations from journals and other periodicals than was available in previous versions.
This was
accomplished by changing the formatting class for ISOILL requests
from MarcISOILLFmt
to MarcArticleISOILLFmt in the .ini file for databases that contain
article citations.
|
<WebZ_root>/ini/dbs
ABII.ini
AcadIndx.ini
AppliSci.ini
ArtFirst.ini
ArtsHum.ini
BIOSIS.ini
ContentsFirst.ini
ERIC.ini
FastDoc.ini
GpoERL.ini
Inspec.ini
LibRefCEBSCO.ini
Medline.ini
NetFirst.ini
PapersFirst.ini
Psyc.ini
RILM.ini
SocSciIndx.ini
WorldCat.ini
|
|
Adding Source Information to Inter-Library Loan (ILL) Requests
For ILL requests, version 4.02 captures the source (database where the user locates a reference) and adds it to the ILL request.
|
ORG.oclc.fmts.obi.MarcArticleISOILLFmt
ORG.oclc.fmts.obi.MarcISOILLFmt
ORG.oclc.obi.illformscreen
|
|
Enhanced ILL Validation
Version 4.0.2 adds a validation method to the ISOILL verb. MyISOILL overrides this method with its own validation routine. Although the Out-of-the-Box Interface (OBI) does not use MyISOILL, you can examine MyISOILL for an example of validation that goes beyond that included in ISOILL.
|
<WebZ_root>/classes/lib/SS4_0_2.jar
ORG.oclc.obi.extverb.MyISOILL
|
|
Set Size of Toolbar (or Top) Frame in StyleTable
Previous versions of SiteSearch contained the size the size of the toolbar (or top) frame, in rows, in homeframe.html. Version 4.0.2 changes the hard-coded value in homeframe.html to a reference in the StyleTable (&StyleTable.htmlparms.framerows).
|
<WebZ_root>/htdocs/html/homeframe.html
<WebZ_root>/ini/interface
|
|
Customize Jump Bar Label
The JumpBar gadget includes a new parameter (JumpBarLabel=<string>), which allows you to specify the text preceding the JumpBar anchors.
In previous versions of SiteSearch, the Jump Bar anchors were hard-coded.
|
ORG.oclc.gadgets.JumpBar
|
|
Select Fonts for Limit Fields
You can now have different fonts for the label for Limits fields and the Limits selections themselves by using two new parameters in the Limits gadget:
- inputBoxFont=, which specifies the font for the label for a Limits input field.
- selectFont=, which specifies the font for the Limits selections, whether appear in a drop-down list or as radio button selections.
If you do not use these new parameters, the Limits display works as it has in previous versions.
|
ORG.oclc.gadgets.Limits
|
|
Enhanced
Bookmarking Capabilities
New bookmarking options in version 4.0.2 allow you to provide the ability to:
- bookmark more than one record at a time, which is controlled by the numrecs=<value> widget on the URL.
- "unsave" (remove) all bookmarked records at one time, which is controlled by the action=deleteall widget on the URL.
| Note: |
The OBI shipped with version 4.0.2 does not demonstrate these features.
|
|
ORG.oclc.obi.extverb.BookMark
|
|
Specify Display of User-Defined Topics
You can specify whether to display topics defined by a user during the user's session the anchor list of topics.
Use the new parameter in the Topics gadget, keepUserDefinedTopics, to indicate whether to display these topics or not. keepUserDefinedTopics can be either true or false. The default setting (true) displays the user-defined topics.
|
ORG.oclc.gadgets.TopicList
ORG.oclc.obi.util.Topics
|
|
Enhanced Extensibility of Selected Gadgets
Changes to the gadgets shown in the list to the right make them more readily extensible to other classes.
Extensibility here refers to making the methods in these classes "protected" so that their functionality becomes available to other classes that extend them.
|
ORG.oclc.gadgets.FormatRecords
ORG.oclc.gadgets.FormatRecordsAnd
AttachHoldings
ORG.oclc.gadgets.SearchHeader
|
|
Enhanced <oclc-app> Tag Functionality
(1) An HTML file can contain one more than <oclc-app> tag. The tags are executed sequentially in the order in which they appear in the HTML file. For example, if an HTML file contains the following:
<oclc-app type="JavaPage"
name="resultsscreen">
</oclc-app>
<oclc-app type="JavaPage"
name="resultsnavscreen>
</oclc-app>
resultsscreen executes first, followed by resultsnavscreen.
(2) The <oclc-app> tag now accepts parameters, using the following syntax:
<oclc-app type="JavaPage"
name="sethelpstate">
<parm name="helpFor"
value="Results">
<parm name="stuff"
value="stuffdata">
</oclc-app>
In this example, the <oclc-app> tag passes two parameters, available as widgets, to sethelpstate.java: helpFor with a value of "Results", and stuff with the value "stuffdata".
As this example shows,
- parm denotes a parameter
- a tag can have multiple parameters
- the parameters appear between the <oclc-app> and </oclc-app> tags
- you must include both the parameter's name and its value.
|
<WebZ_root>/classes/lib/SS4_0_2.jar
|
|
Enhanced
.ini Functionality
(1) Ordered lists of entries in an .ini file can now use asterisks in place of numbers. This prevents you from having to renumber the entries as they are added, moved, and deleted.
For example, here is part of a list from <WebZ_root>/ini/databases.ini:
db1 = dbs/doct.ini
db2 = dbs/WorldCat.ini
db3 = dbs/ABII.ini
db4 = dbs/AppliSci.ini
...
db34 = dbs/localCARC.ini
You could replace the numbers in this list with asterisks, like this:
db* = dbs/doct.ini
db* = dbs/WorldCat.ini
db* = dbs/ABII.ini
db* = dbs/AppliSci.ini
...
db* = dbs/localCARC.ini
| Note: |
The numbered lists in these files work with either asterisks or numerals and have not been changed to asterisks in version 4.0.2. This feature merely allows you to make this change if you wish.
You cannot mix asterisks and numerals within an .ini file. Use one method or the other.
|
(2)
Long lines of input text in any .ini file can now contain a continuation
(\) character. This improves the readability of long text lines
in .ini files. For example, here is a section from defaultStyle.ini
with continuation characters:
noScanTerms = <font &StyleTable.fonts.face;>\
<b>No terms returned for your \
request</b><br></font> \
<font &StyleTable.fonts.face; \
size="-1">Please change or simplify \
your browse and try again.</font>
|
Item (1): Any .ini file with an ordered list or lists in:
<WebZ_root>/ini
<WebZ_root>/ini/dbs
<WebZ_root>/ini/interface
<WebZ_root>/ini/loc
<WebZ_root>/ini/servers
Item (2): Any .ini file in:
<WebZ_root>/ini
<WebZ_root>/ini/dbs
<WebZ_root>/ini/interface
<WebZ_root>/ini/loc
<WebZ_root>/ini/servers
|
|
Method Name Changes in ORG.oclc.ber.DataDir
Method names in DataDir have been updated to a more object-oriented format. If you have written classes that extend DataDir, you will receive deprecation messages when you compile in Version 4.0.2, but the extended classes should run without problems.
|
<WebZ_root>/classes/lib/SS4_0_2.jar
|
Bug Fixes
See Also
Upgrading to Open SiteSearch 4.0.2
Description of the Open SiteSearch 4.0.1 Release
Description of the Open SiteSearch 4.0.0a Patch
Open SiteSearch Suite Known Bug List (by Category)
|