(General Release Edition)
ERL Z39.50 Gateway 4.0
Administrator's Guide
C O N T E N T S
[ Guide C O N T E N T S
]
About
This Guide
The Z39.50 Gateway provides a
transparent link between Z39.50 clients and the ERL
database server, regardless of hardware or software
differences. This link enables users at client sites to
search SilverPlatter databases using the familiar
interface, commands, and search methods of their local
systems.
This guide outlines the
features, requirements, and installation instructions
SilverPlatter's ERL Z39.50 Gateway (v. 4.0) for SCO,
Solaris, AIX and Windows NT.
NOTE: In addition to this guide, refer to the
release notes (readme.txt) distributed with the
Gateway software for more information about this release.
[
Guide C
O N T E N T S ]
Supported
Z39.50 Features
The Z39.50 Gateway is compliant
with Version 2 and Version 3 (the most current edition)
of the Z39.50 specification. It supports the following
features:
NOTE: Your Z39.50 client must also support
these features in order for you to use them.
NOTE: By
default, the Gateway retains the last five result
sets. You can change this setting by editing the erlsrvr.cfg
file. See "Configuring
the Z39.50 Gateway" for more information.
[
Guide C
O N T E N T S ]
System
and Client Requirements
System
Requirements
- ERL 2.09.5 or higher
- In addition to the basic
ERL hardware requirements, you need:
- 5 MB hard
disk space for Gateway
installation
- 4 MB RAM
for the first four simultaneous users plus
1 MB RAM for each additional
user
Client
Requirements
- User
Authentication
If the ERL server requires a
username and password, clients must support User
Authentication and send either the open "user/password"
or idPass IdAuthentication in
the initialization request.
If the ERL server uses IP Address checking, you
can specify a username and
password in the erlsrvr.cfg file. See "Configuring
the Z39.50 Gateway" for more information.
- Attribute
Sets
Client must support Bib-1
Attributes or
they must be dynamically configured through the
Version 3 Explain Database.
- Record
Syntaxes
Clients must support MARC, SUTRS or
GRS.1.
[
Guide C
O N T E N T S ]
Installing
the Z39.50 Gateway
NOTE: You can
install the 4.0 version of the Z39.50 Gateway over
previous versions. The configuration settings will be
retained and used as the default values during
installation.
On
UNIX Machines
To install the
Z39.50 Gateway on a UNIX machine:
- Download the appropriate installation package
file to a temporary directory and uncompress
the file.
- Log in as "root" on your machine.
- Change to the directory that contains the
downloaded installation file.
- Type tar xf erlz3950v4.tar to
untar the file.
- Change to the z3950 directory
and type ./setup to start the
installation program.
- When the SilverPlatter License Agreement appears,
press [Enter] to page through
the agreement or [Q] to go to
the end. To continue the installation process,
you must agree to the statement at the end of the
license agreement:
"Do you accept the above
license terms? (y/n) :"
- Type Y to continue the
installation.
- Type the TCP port number for the Z39.50 Gateway,
then press [Enter].
NOTE:
"210" is the standard port number for
Z39.50. Test servers commonly use port
"2210." You may specify any port. To
use a port number below 1024, the Gateway must be
run with root privilege.
- Type the maximum amount of virtual memory (in
bytes) you want to allow for each Z39.50
connection (1500000 is the
default), then press [Enter].
- Type the hostname or IP address of the ERL server
you want the Gateway to access.
NOTE: If
you are installing the Z39.50 Gateway on the ERL
server machine, use "localhost" as the
hostname.
- Type the ERL username to be used when building
the Explain database (the default is
"admin"), then press [Enter].
NOTE: This
user should have access to all databases on the
server.
- Type the ERL password for the above ERL username
(the default is "admin"), then press
[Enter].
- The script starts copying files to the
installation directory. If erlzbib1.cfg
already exists on your machine (from a previous
Z39.50 installation), the script asks you if you
want to replace it with a new version and save
the original as erlzbib1.cfg.bak in the
/sproot/z3950 directory.
- Type Y to overwrite the
file (recommended) and make a backup
copy.
- Type N to use the
existing file.
- If you are installing the Gateway on the ERL
server machine, type the path of the directory
that contains /sproot.
Otherwise, enter none.
- The script then asks you if you want the dbserver
to automatically rebuild the Explain database.
- Type Y if you want the
server to automatically rebuild the
Explain database whenever the list of
available databases changes.
- Type N if you do not
want the Explain database to rebuild
automatically.
- Type the name of the user who will own the Z39.50
Gateway files ("erl" is default), then
press [Enter].
- The script then asks you if you want the Gateway
to start when the system reboots.
- Type Y if you want the
Gateway to start automatically.
- Type N if you want to
start the Gateway manually.
- The script asks if you want to build an Explain
database at this point.
- Type Y if you want the
an Explain database built now.
- Type N if you don't plan
to provide an Explain database, or if you
want to build the initial Explain
database later.
- The script asks if you want to start the Gateway
now.
- Type Y if you want the
Gateway to start now.
- Type N if you want to
start the Gateway later.
- The final installation screen displays the path
to the Z39.50 directory and confirms that
installation is complete.
Once installation is complete, you can test the
Gateway using the Z39.50 client of your choice. (Zdemo, a
freely distributed Z39.50 client from
OCLC, is included in SilverPlatter's Z39.50 Gateway
package. See "Sample zdemo Session"
for more information.)
On
Windows NT Machines
To install the
Z39.50 Gateway on a Windows NT machine:
- Download the Z39.50 installation file to a
temporary directory.
- Run erlz3950.exe to extract the Z39.50
Gateway files. When the initial Welcome
screen appears, click Next to
begin the installation.
- Specify a destination folder for the extracted
files (C:\TEMP\ERL Z39.50 Gateway
is the default), then click Finish
to begin the ERL Z39.50 Gateway Setup program.
- Read the Welcome screen, then click Next.
- Read the Software License Agreement, then click Yes
to continue with the Setup program.
- Specify the destination folder in which you want
to install the Gateway (C:\Program
Files\SilverPlatter Information\ERL Z39.50
Gateway\ is the default), then click Next.
- Select the program components you want to
install, then click Next.
- Program files: includes
the executable program files for the
Gateway.
- MARC Maps: includes the
files that map SilverPlatter Records to
MARC format.
- Explain Builder:
includes the files needed to create a
searchable Explain Database.
- Configuration Files:
includes setup files that control the
operation of the Z39.50 Gateway.
- zdemo Program Files:
includes the OCLC's zdemo program that
you can use to test the operation of the
Z39.50 Gateway.
- zdemo Source Files:
includes the source files used to build
the zdemo program.
- Documentation: includes
the Z39.50 documentation files.
- Specify a TCP port number (210
is the default) for the Gateway, then click Next.
NOTE:
"210" is the standard port number for
Z39.50. Test servers commonly use port
"2210."
- Specify a name and location for the Z39.50
Gateway log file, then click Next.
(By default, the log file is named erlz3950.log
and stored in the Gateway's program
directory.)
- Specify the maximum amount of virtual memory (in
bytes) you want to allow for each Z39.50
connection (1500000 is the
default), then click Next.
- Specify the domain name address and port number
of the ERL server the Gateway will access (the
defaults are "localhost" and
"416," respectively), then click Next.
NOTE: If
you are installing the Z39.50 Gateway on the ERL
server machine, use "localhost" as the
domain name. Most ERL servers are on port
"416."
- Specify the domain name and port number of the
ERL server you want the Explain database to
describe (the defaults are whatever you specified
in step 11), then click Next.
NOTE: If
you are installing the Z39.50 Gateway on the ERL
server machine, use "localhost" as the
domain name. Most ERL servers are on port
"416."
- Specify the ERL user name and password to use
when building the Explain database (the defaults
are "admin"/"admin"), then
click Next.
NOTE: This
user should have access to all databases on the
localhost machine.
- Specify the Program Folder for the Z39.50 Gateway
program icons (ERL Z39.50 Gateway
is the default.), then click Next.
- Before the files are copied, your installation
settings are displayed.
- You can make changes at this time by
clicking Back to return
to the information you want to change.
- If the information you entered is
correct, click Next to
copy the program files to the directory
you specified.
- Once the files are copied, a DOS window opens and
prompts you for your ERL password.
Once you
type your ERL password, the following message
appears to confirm that the Gateway has been
installed and started:
"ERL Z39.50 Gateway installed.
ERL Z39.50 Gateway started.
Press Enter to continue."
- Press [Enter] to close the DOS
window. When you return to the Setup
screen, click Finish to complete
the installation process.
Once installation is complete, you can test the
Gateway using the Z30.50 client of your choice. (Zdemo, a
freely distributed Z39.50 client from
OCLC, is included in SilverPlatter's Z39.50 Gateway
package. See "Sample zdemo Session"
for more information.)
[
Guide C
O N T E N T S ]
Sample
zdemo Session
f meds0016
Now searching database 'meds0016'
s cats dogs and
111 bytes sent
read 18 bytes
Result 1: 198 records found.
Search Successful! :-)
d 1
27 bytes sent
read 694 bytes
reading another 4096 bytes
read 1718 bytes altogether
reading another 3072 bytes
read 2742 bytes altogether
reading another 2048 bytes
read 3766 bytes altogether
reading another 1024 bytes
read 4790 bytes altogether
1 records returned
Present successful
recordSyntax='1.2.840.10003.5.10'
008
19969712
024 4
$a0378-1135(199612)53:3/4L.355:VFCP;1-1
033 $a971022
035 $a97161074
036 $aGENBANK/X61096;
GENBANK/M73037
044 $aNETHERLANDS
100 10 $aMay-SW
245 10 $aVirulence of feline Chlamydia
psittaci in mice is not a function
of
the major outer membrane protein (MOMP).
513 $aJOURNAL-ARTICLE
520 $aThe virulent
strain of feline Chlamydia psittaci, the Cello strain,
produces conjunctivitis and upper respiratory disease in
cats. T
his same strain produces a lethal disease in mice when
inoculated i
ntraperitoneally (i.p.). In this study we have shown that
the Baker
strain of feline C. psittaci is attenuated in the mouse
model syst
em. Intraperitoneal inoculation of mice with the Baker
strain produ
ced no disease but did stimulate an immune response that
protected
the mice from subsequent produced i.p. inoculation with
the virulen
t
Cello strain. To determine if the difference between
these two st
rains was in the major outer membrane protein (MOMP), the
omp1 gene
which codes for this protein was sequenced for both the
Baker and
Cello strains. The MOMP was chosen to study because in
Chlamydia tr
achomatis this protein has been shown to contain
neutralizing epito
pes and has been shown to play a role in cell attachment.
These fun
ctions make it a likely structural component capable of
mutating an
d
causing altered cell tropism and virulence. The DNA
sequence of t
he
omp1 was determined by amplifying the gene with PCR,
cloning the
PCR product into the pCR-II cloning vector and
determining the DNA
sequence of the inserted gene using primers to sites in
the plasmi
d
vector. From the DNA sequence, the deduced amino acid
sequence of
MOMP was determined for both the attenuated Baker and the
virulent
Cello strains of feline C. Psittaci. The results
indicated that th
e
omp1 gene of both strains contained 1179 base pairs which
coded f
or
a protein 392 amino acids. The DNA sequences of the omp1
gene of
the two strains differed by only two base pairs which
resulted in
two amino acid changes in the MOMP. The Baker strain had
a serine i
nstead of a tryptophan at amino acid 7 and a tyrosine
instead of an
aspartic acid at amino acid 125 of the uncleaved protein.
Neither
amino acid change was in an area of the MOMP which could
logically
account for the difference in biological activity. Amino
acid 7 was
in
the leader sequence which is cleaved from the authentic
MOMP an
d
is not present in the infectious elementary body. Amino
acid 125
was in a conserved hydrophobic area of one of the
constant regions
of
the protein. A change at this location was not likely
surface ex
posed and thus could not affect cell adhesion, tissue
tropism or ne
utralizing epitopes. Therefore, the differences in the
primary stru
cture of the MOMP from the Baker and Cello strains of
feline C. psi
ttaci could not account for the attenuation of the Baker
strain for
mice. The molecular basis of their difference is yet to
be determi
ned.
545 $aDepartment of
Veterinary and Biomedical Sciences, University
of
Nebraska-Lincoln 68583, USA.
546 $aENGLISH
650 22 $aAmino-Acid-Sequence
650
22 $aBacterial-Outer-Membrane-Proteins-genetics
650 22 $aBase-Sequence
650 22 $aCats-
650 22 $aCell-Line
650
22 $aChlamydia-psittaci-genetics
650
22 $aChlamydia-psittaci-physiology
650 22 $aDogs-
650 22 $aDNA-Primers
650 22 $aMice-
650 22 $aMice,-Inbred-Strains
650 22 $aMolecular-Sequence-Data
650 22 $aOrnithosis-microbiology
650 22 $aPolymerase-Chain-Reaction
650 22 $aSequence-Alignment
650
22 $aSequence-Homology,-Amino-Acid
650
22 $aSequence-Homology,-Nucleic-Acid
650 22 $aSpecies-Specificity
650 22 $aVirulence-
650
12 $a*Bacterial-Outer-Membrane-Proteins-biosynthesis
650 12 $a*Cat-Diseasesv
650
12 $a*Chlamydia-psittaci-pathogenicity
650 12 $a*Ornithosis-veterinary
650 27 $aAnimal
650 27 $aSupport,-Non-U.S.-Gov't
650 02 $abiosynthesis
650 02 $agenetics
650 02 $aphysiology
650 02 $apathogenicity
650 02 $amicrobiology
650 02 $aveterinary
650 $aMICROBIOLOGY
650
$aVETERINARY-MEDICINE
653 01
$aBacterial-Outer-Membrane-Proteins
653 01 $aDNA-Primers
653 01
$aouter-membrane-protein-,-Chlamydia-psittaci-6BC
653 02 $a0
653 02 $a0
653 02 $a142540-68-9
700 10 $aKelling-CL
700 10 $aSabara-M
700 10 $aSandbulte-J
773 0 $tVet-Microbiol. 1996 Dec;
53(3-4): 355-68 $x0378-1135
787 0 $aVETERINARY-MICROBIOLOGY
q
[ Guide C O N T E N T S
]
Configuring the Z39.50
Gateway
You can configure the following Z39.50
Gateway settings by editing the erlsrvr.cfg file
in the /sproot/z3950 directory:
To
change the ERL server address:
- Find the [z3950conn]section.
- Edit the following line to reflect
the correct ERL server hostname:
server_addr1 = /2/<ERL server hostname>/416
NOTE: If
the Z39.50 Gateway and the ERL server are running
on the same machine, use "localhost" as
the hostname.
- Save the erlsrvr.cfg
file.
To
change the Explain ERL server address:
- Find the [z3950expl]section.
- Edit the following line to reflect
the correct ERL server hostname:
server_addr1 = /2/<ERL server hostname>/416
- Save the erlsrvr.cfg
file.
To
set a default username and password for the ERL server:
- Add the following lines to the [z3950conn]section:
ERL.USERNAME = <username>
ERL.PASSWORD = <password>
- Save the erlsrvr.cfg
file.
To
set a default username and password for the Explain ERL
server:
- Edit the following lines in the [z3950expl]section:
ERL.USERNAME = <username>
ERL.PASSWORD = <password>
- Save the erlsrvr.cfg
file.
To
enable message logging of all Z39.50 messages:
- Uncomment the following line in
the [z3950conn]section:
msglog = sessions/log
The Gateway will now create a
log file (e.g., logXXXX.pdu where XXXX
is a random number generated by the Gateway) for
each new Z39.50 connection and keep track of all
messages sent and received. Log files are stored
in the /sessions/log subdirectory
of the Gateway installation directory.
- Save the erlsrvr.cfg
file.
To
change the Sort limit:
- Find the [z3950expl]section.
- Edit the following line to reflect
the new sort limit:
sortlimit = 500
NOTE: Increasing the sort
limit may result in slower system performance.
- Save the erlsrvr.cfg
file.
To
change the number of named result sets that are retained:
- Find the [z3950conn]section.
- Edit the following line in the [z3950conn]section to reflect the number of result
sets you want the server to retain:
resultsets = 5
- Save the erlsrvr.cfg
file.
[ Guide C O N T E N T S
]
Starting/Stopping the
Z39.50 Gateway
On UNIX Machines
To start the
Z39.50 Gateway and open the user menu on UNIX:
- Change to the /sproot/z3950
directory.
- Type ./erlz3950 -m
and [Enter].
To open the
ERLZ3950 user menu:
1. Show connected Z39.50 client
users
2. ERLZ3950 Administration
9. Exit from menu
To shutdown the server, type SHUTDOWN
ERLZ3950>
- 1. Show connected
Z39.50 client users - displays the
username, connection number, process ID
number, and hostname or TCP/IP address for
all currently connected Z39.50 clients.
- 2. ERLZ3950
Administration - NOT CURRENTLY
IMPLEMENTED.
- 9. Exit from menu
- closes the ERLZ3950 menu but leaves the
Gateway running.
To
stop the Gateway on UNIX:
- Type shutdown at
the ERLZ3950> prompt (at the end of the
ERLZ3950 menu) and press [Enter].
IMPORTANT: Be sure you are still in the ERLZ3950
menu when you type shutdown.
Otherwise, you could shut down the ERL server
program (if it is on the same machine) or the
UNIX system.
- When prompted, type the number of
minutes you want to wait before shutting down the
Gateway.
On
Windows NT Machines
NOTE:
The Z39.50 Gateway is installed as a service on Windows
NT machines.
To start and stop
the Gateway on Windows NT:
- Open the Windows NT Control Panel
(Windows NT Start menu > Settings
> Control Panel).
- Click on the Services
icon.
- Scroll down the Services column
until you find the ERL Z39.50 Gateway service.
The Status column contains
"Started" when the service is running.
The service is blank when the service is stopped.
- Start or stop the service as
necessary:
- Click Start
to start the service
- or click Stop
button to stop it. (NOTE: This will not shut down the ERL
server program (if it is on the same
machine).
- Close the Services dialog box.
To open the Z39.50
Gateway user menu on Windows NT:
- Start the ERL Z39.50 Gateway
service (as described above).
- From the Windows NT Start menu,
select ERL Z39.50 Gateway > ERLZ39.50
Gateway User Interface.
A DOS window opens, displaying the
ERLZ3950 menu as shown below:
1. Show connected Z39.50 client
users
2. ERLZ3950 Administration
9. Exit from menu
To shutdown the server, type SHUTDOWN
ERLZ3950>
- 1. Show connected
Z39.50 client users - displays the
username, connection number, process ID
number, and hostname or TCP/IP address for
all currently connected Z39.50 clients.
- 2. ERLZ3950
Administration - NOT CURRENTLY
IMPLEMENTED.
- 9. Exit from menu
- closes the ERLZ3950 user menu window but
leaves the Gateway running.
NOTE: If you shutdown the server at the ERLZ3950>
prompt, you must restart the ERL Z39.50 Gateway
service (as described above)
before you can open the user menu again.
[ Guide C O N T E N T S
]
Installing and Mounting
the Explain Database
NOTE:
The Explain database is only used by Version 3 Z39.50
clients that support the Explain feature. If you are not
using any clients that support Explain, you do not need
to install the Explain database.
The Z39.50 Gateway installation builds
the Explain database in the /sproot/z3950/Z3950
(note capitalization) directory and
automatically installs the database files in the
appropriate location.
If you are running the Z39.50 Gateway
and the ERL server software on the same machine, you can mount the Explain database once installation is complete. If you want to
run the Gateway on a computer other than the ERL server
machine, you must install the Explain database on the ERL server.
Installing the
Explain Database on the ERL Server
There are two ways to install the
Explain database on the ERL server:
Method 1:
After you install the Z39.50 Gateway on its own
machine, you can install it and build the Explain
database on the ERL server machine as well. (You can
then safely ignore the first Explain database built
on the Z39.50 Gateway machine.)
NOTE: If you want to be certain that the
Z39.50 Gateway isn't run on the ERL server
machine, remove the executable file (erlz3950)
from the /sproot/z3950
directory.
Method 2:
You can build the Explain database on the Z39.50
Gateway machine and then copy the files from the /sproot/z3950/Z3950
to the same directory on the ERL server machine.
To copy the files:
- Login as "erl"
on the ERL server machine.
- If it doesn't already
exist, create a /sproot/z3950/Z3950
(note capitalization) directory.
- Copy all the files from
the /sproot/z3950/Z3950
directory on the Z39.50 Gateway machine
to the /sproot/z3950/Z3950
directory on the ERL server machine.
Once installed on the ERL server, you
must mount the Explain database to make it available.
Mounting
the Explain Database
To mount the
Explain database:
- Login as "erl" on the
ERL server machine.
- Change to the /sproot/bin
directory and run ./dbserver.
- Under Install Databases, select
Search For Candidates.
- Type the path /sproot/z3950/Z3950
(note capitalization).
- Select Magnetic Link Install.
- Return to the ERL server's main
menu and mount the #Z39 database.
[
Guide C
O N T E N T S ]
Supported Bib-1 Attributes
and Universal Fields
The Z39.50 Gateway uses a universal
mapping from BIB-1 USE attribute numbers to SilverPlatter
database field names (USE number = SilverPlatter
fields). This mapping is defined by the erlzbib1.cfg
file, which can be changed to suit local needs.
Each line in erlzbib1.cfg
defines one USE attribute number. For example:
8 = IS,ISSN,SN
This specifies that Bib-1 USE attribute
8 (ISSN) will search the IS, ISSN and SN fields. NOTE: The special field *F refers to the Free Text
index -- the index that is searched when no fields are
specified.
When the Gateway encounters a USE
attribute in a Search, Scan or Sort request, it looks up
the field list in the erlzbib1.cfg file. It
checks that list against the selected databases, ignoring
fields that aren't in the databases. If the selected
databases don't have any of the fields, the Gateway sends
back an "unsupported USE attribute" diagnostic.
[
Guide C
O N T E N T S ]
Searching
Multiple Database Names
Clients can request searching multiple
databases by including more than one database in the
SearchRequest's DatabaseName sequence. There is no
restriction on the number of databases that can be
listed.
Each entry in the DatabaseName sequence
is treated as a pattern that can select many databases.
The syntax for the patterns is:
*
Matches zero or more characters
? Matches zero or
one character
$ Matches exactly
one character
[s1,s2,...]
Matches the string s1 or s2, etc.
The individual patterns s1, s2, etc.,
may be any length and may contain *, ? and $ wildcard characters, but not [].
A database list can contain patterns
that match the same database in more than one way. The
Gateway checks that each pattern matches at least one
database. For example if the database server has only one
database, MX03, and a Z39.50 client lists both MX* and
*03, MX03 will be selected. If a client lists MX* and
*04, the Gateway will return the diagnostic
"specified combination of databases not
supported."
NOTE:
Database names are case insensitive.
[ Guide C O N T E N T S
]
Contacting SilverPlatter
Technical Support
If you need further assistance with the
ERL Z39.50 Gateway software, please send an email to support@silverplatter.com or contact one of SilverPlatter's regional
offices:
- United
States:
SilverPlatter Information, Inc.
100 River Ridge Drive
Norwood, MA 02062
Tel: 800-343-0064 or
781-769-2599
Fax: 781-769-8763
- London:
SilverPlatter Information LTD
10 Barley Mow Passage
Chiswick, London W4 4PH
England
Tel: +44 (0) 181 585 6400
Fax: +44 (0) 181 585 6640
- Amsterdam:
SilverPlatter Information BV
Nieuwe Herengracht 49
1011 RN Amsterdam
The Netherlands
Tel: +31 (0) 20 6259650
Fax: +31 (0) 20 6237408
- Berlin:
SilverPlatter Information GmbH
Uhlandstrasse 15
D-10623 Berlin
Germany
Tel: +49 30-315-2161
Fax: +49 30-315-2162
|
