Webvoyage Overview

Webvoyage is controlled by a combination of files and programs within the main Voyager system and on the Web Opac server. Generally speaking, search index functionality is controlled within the System Administration module, including what fields and subfields are indexed, which indexes are suppressed from the OPAC, how search results sort, etc. Display issues, from background color to the number of limits offered on the Simple Search Screen, are controlled by a series of files on the web server.

The Webvoyage html pages themselves are generated by a CGI executable. We do not have access to the CGI source; Endeavor considers the source proprietary, and only puts a copy of the executable on the server. Endeavor does provide some level of control over the CGI through the use of parameter files, like the "opac.ini" that allow a site to customize colors, labels, brief and long displays, etc. There is no overall rule about what can be customized, however. Some labels can be customized, some cannot. Some buttons can be substituted with a gif, some cannot.

Manuals

There are three manuals that describe the setup for Webvoyage.

"Sysadmin" contains instructions on editing the content of indexes, index search results, etc.
"Webvoyage" contains detailed instructions for modifying most aspects of the Web interface, including design issues, selection of searches to provide to the user, default number of records displaying, limits, etc.
"OPAC" contains some instructions for tweaking the interface not found in Webvoyage

Procedures

When making changes to webvoyage files:

Open an SSH connection to the '/m1/voyager/yale_traindb' test region on Vespucci first
Make a copy of the file to be changed in the local 'save' directory, named [filename].save
Verify that your changes achieved the desired affect in 'traindb.library.yale.edu'.
Look to see if the file contains information unique to the region (a re-direct to 'yaledb.library.yale.edu' for example. Files with region-specific information are highlighted in red below and include OPAC.INI, LOGOUT.HTM, WEBCONERR.HTM, WEBVOY.HTM, WEBERR.HTM, VOYAGER.INI. These files must be changed manually. **Do not** copy changed OPAC.INI files, etc. to other regions.
Copy or change the file in the '24hourdb' and 'yaledb' directories on Vespucci.
Copy or change the file in the 'yaledb', 'orbstaffdb', and 'expressdb' directories on Columbus
**NOTE: INI file changes, HTM help changes, CFG config file changes, etc. should also be made in the /etc/webvoyage/Z3950 subdirectories in each of these regions.

Web Server Directory Structure

There are currently three production regions, or copies of the directory structure, in use: orbis, orbstaff, and orbexpress. The main difference between the three (as far as the public is concerned) is the timeout value. The fourth backup production region, orb24hour, is only used when the other production regions are down.

orbis (yaledb) - 20 minute time out
orbstaff (orbstaffdb) - 1 hour time out
orbexpress (expressdb) - 2 minute time out
orb24hour (24hourdb) - used when production Orbis is down for backup

Within each region, there are five subdirectories that contain the files used to generate the Web opac.

/m1/voyager/xxxdb/webvoyage/cgi-bin - contains the cgi that generates the web opac html pages and forms.

../webvoyage/html - contains some high level html pages that display when the system times out, etc.

../webvoyage/html/images - contains all images used by the system.

../etc/webvoyage - contains the header and footer html files, along with the Z39.50, local, vcit, zcit subdirectories.

../etc/webvoyage/local - contains the majority of the parameter and message files used by the system.

These directories contain 3 main types of files. 'INI' files contain parameters that determine the way Webvoyage behaves (which search limits are offered on the simple search page, for example). 'HTM' files contain error messages and informational text offered on specific search pages. 'CFG' files configure the brief, long, email, save, and print displays.
File names highlighted in red contain region-specific information, and should not be copied from one region to the next without careful review.

/m1/voyager/xxxxdb/webvoyage/html

logout.htm

web page displayed when a user clicks 'logout'; directs user back to beginning of session

notavailable.htm

pop-up message that displays for bib records with no holdings; link to message is in record Brief and Long display.

webconerr.htm

'time-out' web page displayed when user times out; directs user back to beginning of session

webvoy.htm

contains the javascript that starts up a new Orbis session in the browser

/m1/voyager/xxxdb/webvoyage/html/images

All gifs used in headers, web pages, etc. are contained in this directory

/m1/voyager/xxxxdb/etc/webvoyage

connect.ini

contains the names of databases offered for Simultaneous Search; Gail updates Z39.50 related files

formats.ini

determines which formats are offered for Print and Save in Webvoyage

marcinfo.ini

determines the content of fixed field positions that are used for Limiting

search.ini

determines the search types that are offered for Simultaneous Search

dbselmsg.htm

explanatory text included on the Webvoyage 'Library Catalogs' page

footer.htm

contains information displayed at the end of every page generated in Webvoyage

header.htm

contains the Orbis header, plus local style sheets that determine font, etc. in the rest of Webvoyage

voyager.ini

contains the machine and port number for the current instance of Webvoyage

/m1/voyager/xxxxdb/etc/webvoyage/local

display.ini

lists the number and kind of record display types

limits.ini

lists the limits offered in both Quick Limits and More Limits

opac.ini

this parameter file controls most of the webvoyage features, and contains a running list of updates at the beginning of the file

search.ini

controls searches offered in the Voyager Simple Search Screen

display[1-2].cfg

these files control the display of bibliographic records (by Marc Tag) in the brief and long display

displayh.cfg

controls the display of record holdings

email.cfg

controls display of bibliographic info e-mailed to a patron

emailh.cfg

controls display of holdings info e-mailed to a patron

emailf.cfg

controls the footer file in e-mailed records

request.cfg

controls bib-level request information

requesth.cfg

controls hold-level request information

save[1-4].cfg

control the display of bibliographic information when a record is saved in the various save formats by a patron

save[1-4]f.cfg

control the footer file included in the saved record for each format

saveh.cfg

controls the display of holdings for all save formats

weberr.htm

controls the page that displays when Orbis is not available

*.htm

contain error messages, help text, and other text messages used by the system

Design Elements

The Orbis headers, buttons, and colors are part of a design created by Angie Hurlbut (ahdesign@snet.net). A template for the toolbar buttons is available on ogma.library.yale.edu in the /usr/web/lso/databaseadmin/webvoyage directory.

Colors

Dark Blue (used for 'Orbis' font) #0066A3
Medium Blue (Active Tabs) #B2DLE3
Light Blue #DFECF3
Gold (thin line used to separate header sections) #F2B31C
Yellow (Inactive Tabs) #FLF0B3

Fonts

Toolbar buttons & other gifs = TheSans Semi Bold Caps
Orbis text font = Verdana

New Books

New Books is a list of new monographic materials: books, CDs, videos, etc.

Make sure that URL in Opac.ini on Columbus: /m1/voyager/yaledb/etc/webvoyage/local is pointing to orbis

<a style="color:#0066A3"href="http://orbis.library.yale.edu/cgi-bin/newbooks.cgi"><FONT FACE=VERDANA>New Books</FONT></a>

Check with Gail about newbooks.pl on Deleon: /m1/voyager/yaledb/local

Make sure $ENV{ORACLE_HOME} = "/oracle/app/oracle/product/10.2.0/db_1";

Check newbooks.txt on Columbus: /m1/voyager/yaledb/webvoyage/cgi-bin

Extract and Display Scripts

The New Books list runs off of a combination of Perl extract script and CGI display script. The Perl extract script 'newbooks.pl' runs on Deleon and generates a text file called 'newbooks.txt.' Newbooks.txt is a fixed position text file listing all books acquired in the last 2-6 weeks. Fields in Newbooks.txt include ISBN, Author, Title, Edition, Imprint, Permanent Location, Temporary Location, Display Call Number, Normalized Call Number, 856 link, and 856 text. Newbooks.txt is FTP'd (using scp) to Columbus once a day.

All of the remaining New Books files, including the 'newbooks.cgi' display script and its related parameter files, live on Columbus in:

/m1/voyager/yaledb/webvoyage/cgi-bin

newbooks.cgi - CGI display script that displays the content of newbooks.txt
newbooks.ini - Parameter file that allows you to change the template colors and other miscellaneous New Books display features.
newbooks.English - Parameter file that allows you to change the text of the messages that display in the initial New Books screen
newboosk.txt - the text file contain the New Books list

OPAC.INI changes

In order to display New Books as a Tab in Orbis, make the following changes to the [Course_Reserve_Search_Page] stanza in opac.ini:

Comment out the simple Course Reserve Tab

#Tab_Text=Course Reserve

Uncomment the New Books Course Reserve Tab