Document Actions

Installing Isite2 for Windows


Obtaining and Installing the Software

  1. Download Isite for Windows (W95/98/2000/NT/XP).
  2. Unzip this file (it will unzip into Isite2-Win by default).
  3. Rename this directory if you wish. In our examples here we will assume we have renamed C:\Isite2-Win to c:\Isite2.
  4. If you want, you can copy the following *.dll files into your Windows System32 folder:
    • cygwin1.dll
    • cygz.dll
      Assuming the *.dll files are located at C:\Isite2 the command will look like this:
    • C:\Isite2>copy *.dll %SystemRoot%\System32
  5. If the files were successfully copied it will print:
    • 2 file(s) copied.

Build an Index

  1. Open a command shell.

    2. Note: These programs are built with the Cygwin emulator, so they require DOS-style paths like C:\Isite2 to be expressed as /cygdrive/c/Isite2. Keep that in mind if you specify absolute paths.

    For this example, we will assume that your database name will be in bold and the string you are searching for will be in bold italics.
  2. While in the Isite2 directory, build an index using this command (all on one line):
    3. C:\Isite2>Iindex2.exe -d /cygdrive/c/Isite2/db/test -t fgdc -o fieldtype=/cygdrive/c/Isite2/fgdc.fields
    /cygdrive/c/Isite2/data/*.xml

    Note the forward slashes on the file paths! Note also the use of the command for mp to generate the HTML and plain text versions of the metadata, and that we have a customized mp configuration file (fgdc.cfg) to do this for you. This will generate output for each file.

    • /cygdrive/c/Isite2/db/test is where Isite will create and store your database files
    • /cygdrive/c/Isite2/data/*.xml is the path to your metadata files
    • If you wish to use SGML files instead of XML files for example, you would change this /cygdrive/c/Isite2/data/*.xml to /cygdrive/c/Isite2/data/*.sgml
    • Click here for advanced indexing options.
  3. Once it finishes indexing, you can test that the index was built correctly by confirming that the following full text search on your test database for the string water returns 4 hits:
    • C:\Isite2>Isearch2.exe -d /cygdrive/c/Isite2/db/test water
  4. The following full text search should only return 1 hit however:
    • C:\Isite2>Isearch2.exe -d /cygdrive/c/Isite2/db/test title/water

Configuring the Z39.50 server

  1. Once you have verified that the indexes were built correctly, you will need to modify the files zserver.ini and sapi.ini with a text editor.  Notepad will do the job, as will MS Word, providing you remember to save the file as plain text.

Open and edit the file zserver.ini. Confirm the following parameters are set as they are below:

ServerType=STANDALONE
Port=210
SAPI=/cygdrive/c/Isite2/sapi.ini
AccessLog=/cygdrive/c/Isite2/zserver_access.log
DBList=test

If you would like to add additional databases, you can create a comma delimited list in your zserver.ini. If you were adding a database named student for example:

DBList=test,student

Next, open and edit sapi.ini.  You need to make an entry for each database you want to have available through zserver. Use the following for the test database, in the [Default] section of sapi.ini:

[test]
Type=ISEARCH
Location=/cygdrive/c/Isite2/db
FieldMaps=/cygdrive/c/Isite2/bib1_fgdc.map,\
/cygdrive/c/Isite2/gils_fgdc.map,\
/cygdrive/c/Isite2/geo_fgdc.map
Note the use of the backslash character (as the last character on the line) as the continuation character.  Also, you may use relative paths instead of absolute paths in the FieldMaps parameter, assuming these files are located in the same directory as the zserver program. For example:
[test]
Type=ISEARCH
Location=/cygdrive/c/Isite2/db
FieldMaps=bib1_fgdc.map,gils_fgdc.map,geo_fgdc.map
  1. Once you have configured zserver.ini and sapi.ini appropriately, you can issue the command

C:\Isite2>zserver.exe

to start the server, then minimize the window and let the server run unattended. If you want to start zserver in a directory other than the one where zserver.ini and sapi.ini are located, the command would be (for example):

C:\Isite2>zserver.exe -i/cygdrive/c/Isite2/zserver.ini

Testing the zserver Installation

Once you have the zserver running (on port 210 and with a database named "test"), you can test it by confirming that it up by executing the following command:

C:\Isite2>zping.exe localhost 210

The following title search for the string "water" should only return a single hit:

C:\Isite2>zclient.exe localhost 210 "test" "water[1,4]"

Confirm that a full text search for the string water returns 4 hits:

C:\Isite2>zclient.exe localhost 210 "test" "water[1,1016]"

Finally a global spatial search should return 5 hits (all the records):

C:\Isite2>zclient.exe localhost 210 "test" "90 -180 -90 180[1,2060]"

Installing zserver as a Windows Service

Requirements:

  • Windows NT Server 4.0, Windows 2000, or Windows XP Professional
  • Isite for Windows (W95/98/2000/NT/XP)
  • Srvany program - lets you serve any program as a service
  • INSTSRV (or, for Windows 2003 Server, SC)- Installs and removes system services from NT

Installation of Srvany.exe after Isite:

Install SRVANY.EXE as a Windows NT service, for example:

C:\Isite2>INSTSRV Z39.50Server c:\Isite2\srvany.exe

where "Z39.50Server" is the name of the service you are creating. You should receive the following message if the command was successful.

The service was successfully added!

Make sure that you go into the Control Panel and use the Services applet to change the Account Name and Password that this newly installed service will use for its Security Context.

Use the "Services" control panel to configure the "Startup type" to "Automatic".

  1. Bring up the "Services" control panel:
    • C:\Isite2>start %SystemRoot%\system32\services.msc /s
  2. Scroll down to the item "Z39.50Server."
  3. Right click on it and choose "Properties" to bring up the "Z39.50Server Properties" dialog box.
  4. Change "Startup type:" to "Automatic".
  5. Choose the "Log On" tab.
  6. Set "Log On As:" to "Local System account".
  7. Press "OK" to save your changes.

Specifying the application to start & its parameters:

  1. Run the Registry Editor:
    • C:\>REGEDIT.EXE
  2. Click on the plus sign (plus sign) next to "My Computer" (My Computer). The plus sign will turn into a minus sign (minus sign) and a tree of folders (folder) will appear.
  3. Click on the plus sign next to the folder labeled "HKEY_LOCAL_MACHINE", and another tree structure will expand beneath it.
  4. Following the above pattern, click on the plus signs (plus sign) next to the folders (folder) "SYSTEM", "CurrentControlSet", "Services", and "Z39.50Server", in that order.
  5. When you have navigated that far correctly you should see the following in your status bar:
    6. My Computer\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Z39.50Server
  6. Create a new key named "Parameters" by right clicking on the "Z39.50Server" and choosing "New Arrow Key" as shown below:
    7. new key
  7. Under the "Parameters" key, create a new string value named "Application" by right clicking on the "Parameters" folder and choosing "New Arrow String Value". as shown below:
    8. new string
  8. Double click on the "Application" string value you have just created and in the "Edit String" window that pops up specify there the full path to the zserver.exe executable (including the extension - C:\Isite2\zserver.exe), as shown below:
    9. Edit String - C:\Isite2\zserver.exe
  9. Following the pattern of steps above, create a new string value named under the "Parameters" key named "AppDirectory" and specify there the full path the application executable resides in:
    • C:\Isite2
  10. See the online tutorials for creating a Clearinghouse Node for further details of testing and registration. Until you register your server with the FGDC, it will not be included in the search forms. To register, fill in the server-level metadata at http://registry.fgdc.gov/.

That's it!

NOTE: You can check if everything is working okay by going into "Z39.50Server Properties" using the steps outlined above, going to the "Log On" tab and check the box next to "Allow Service to Interact with Desktop". Set the "DebugLevel" in zserver.ini to 5 so you will get some feedback.

Interact with Desktop

Then reboot and log in. You will get a command prompt box with the zserver debug text displayed.

IMPORTANT: DO NOT leave the "Allow Service to Interact with Desktop" checked, because the command prompt box will appear for every user and if a user exits the box, the service will terminate.

For example (if everything is okay):

CNIDR zserver, Version 2.3.0, Copyright (c) 1995-2004 MCNC/CNIDR and A/WWW Enterprises

zserver.ini Path = /cygdrive/c/Isite2/bin/zserver.ini
SAPI File = sapi.ini
Looking for map files in /cygdrive/c/Isite2/bin/

Attempting to mount database test
Location is /cygdrive/c/Isite2/db
Successfully mounted.
Adding 67 fields from /cygdrive/c/Isite2/bin/bib1_fgdc.map to internal mapping tables...
Adding 67 fields from /cygdrive/c/Isite2/bin/gils_fgdc.map to internal mapping tables...
Adding 67 fields from /cygdrive/c/Isite2/bin/geo_fgdc.map to internal mapping tables...

Listening on port 210...
NT Forking Server Started

Waiting to Accept client...

If you need assistance, contact us at support@clearinghouse3.fgdc.gov.