29 JULY 98 ==================================== ERL Z39.50 Gateway 4.0 Release Notes ==================================== These release notes outline the requirements, installation instructions and known bugs for SilverPlatter's ERL Z39.50 Gateway (v. 4.0). The Gateway is available for UNIX (SCO, Solaris and AIX) and Windows NT. NOTE: For more documentation, refer to the "ERL Z39.50 Gateway 4.0 Administrator's Guide" (z3950_ag.htm or z3950_ag.txt) in the sproot/z3950/docs directory after you install the gateway. =-=-=-=-= Contents =-=-=-=-= 1. System and Client Requirements 2. Installing the Z39.50 Gateway 3. Known Bugs/Issues 4. Contacting SilverPlatter Technical Support =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 1. 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. * 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. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 2. Installing the Z39.50 Gateway =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 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. To install the Z39.50 Gateway on a UNIX machine: 1. Download the appropriate installation package file to a temporary directory and uncompress the file. 2. Log in as "root" on your machine. 3. Change to the directory that contains the downloaded installation file. 4. Untar the file. Type: tar xf erlz3950v4.tar 5. Change to the z3950 directory and type ./setup to start the installation program. 6. 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) :" 7. Type Y to continue the installation. 8. 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. 9. 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]. 10. 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. 11. 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. 12. Type the ERL password for the above ERL username (the default is "admin"), then press [Enter]. 13. 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. o Type Y to overwrite the file (recommended) and make a backup copy. o Type N to use the existing file. 14. If you are installing the Gateway on the ERL server machine, type the path of the directory that contains /sproot. Otherwise, enter none. 15. The script then asks you if you want the dbserver to automatically rebuild the Explain database. o Type Y if you want the server to automatically rebuild the Explain database whenever the list of available databases changes. o Type N if you do not want the Explain database to rebuild automatically. 16. Type the name of the user who will own the Z39.50 Gateway files ("erl" is default), then press [Enter]. 17. The script then asks you if you want the Gateway to start when the system reboots. o Type Y if you want the Gateway to start automatically. o Type N if you want to start the Gateway manually. 18. The script asks if you want to build an Explain database at this point. o Type Y if you want the an Explain database built now. o Type N if you don't plan to provide an Explain database, or if you want to build the initial Explain database later. 19. The script asks if you want to start the Gateway now. o Type Y if you want the Gateway to start now. o Type N if you want to start the Gateway later. 20. 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.) To install the Z39.50 Gateway on a Windows NT machine: IMPORTANT: Installation of the Gateway as a service on the NT platform can be problematic if the Gateway is installed in the default directory (\Program Files\Silverplatter Information). This directory is also used by WebSPIRS and can become full. To avoid problems, install the Gateway into a new directory. 1. Download the Z39.50 installation file to a temporary directory. 2. Run erlz3950v4.exe to extract the Z39.50 Gateway files. When the initial Welcome screen appears, click Next to begin the installation. 3. 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. 4. Read the Welcome screen, then click Next. 5. Read the Software License Agreement, then click Yes to continue with the Setup program. 6. 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. 7. Select the program components you want to install, then click Next. o Program files: includes the executable program files for the Gateway. o MARC Maps: includes the files that map SilverPlatter Records to MARC format. o Explain Builder: includes the files needed to create a searchable Explain Database. o Configuration Files: includes setup files that control the operation of the Z39.50 Gateway. o zdemo Program Files: includes the OCLC's zdemo program that you can use to test the operation of the Z39.50 Gateway. o zdemo Source Files: includes the source files used to build the zdemo program. o Documentation: includes the Z39.50 documentation files. 8. 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." You can specify any port. To use a port number below 1024, the Gateway must be run with root privilege. 9. 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.) 10. 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. 11. 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." 12. 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." 13. 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. 14. Specify the Program Folder for the Z39.50 Gateway program icons (ERL Z39.50 Gateway is the default.), then click Next. 15. Before the files are copied, your installation settings are displayed. o You can make changes at this time by clicking Back to return to the information you want to change. o If the information you entered is correct, click Next to copy the program files to the directory you specified. 16. 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." 17. Press [Enter] to close the DOS window. When you return to the Setup screen, click Finish to complete the installation process. =-=-=-=-=-=-= 3. Known Bugs =-=-=-=-=-=-= * Installation of the Gateway as a service on the NT platform can be problematic if the Gateway is installed in the default directory (\Program Files\Silverplatter Information). This directory is also used by WebSPIRS and can become full. To avoid problems, install the Gateway into a new directory. * Searches beginning with the "*" wildcard symbol result in inconsistent result sets. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-= 4. 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 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 ---------------------------------- 29 JULY 98