Spy-Server Installation Guide for Borland Enterprise Server

Last modified: 17 January 2003.
  • Home
  • Installation
  • Indexing
  • Configuration
  • Purchasing

  • This page is for information purposes only. It is not a recommendation to use this Java servlet engine or application server. Please consult the supplier's documentation for full installation information and details of how to deploy and configure servlets such as Spy-Server.

    Introduction

    Spy-Server is a Java servlet.  It is a program that must be run by a Java servlet engine on a web server, with its output viewed in a browser.
  • Java application servers usually have built-in support for Java servlets.
  • Alternatively, a Java servlet engine can be installed and connected up to an existing server.

    Please refer to these pages for more information:

  • Servers page for details of application servers and servlet engines.
  • Installation guide for application servers and servlet engines.
  • Deployment overview for Spy-Server.

    Please consult our Getting Started Guide for an overview of how to obtain Spy-Server, set up your server, install and configure Spy-Server.  Get the Spy-Server software from the Download page.

  • Page contents
  • Enterprise Server introduction
  • Setting up...
    Install Spy-Server
    Spy-Server URLs
    Work directory
    Run test searches
    Index your own site
    Word highlighting
  • Configuration
    Init parameters
    Log files
    Updating Spy-Server
    Uninstalling Spy-Server

  • Borland Enterprise Server

    The Borland Enterprise Server is available from http://www.borland.com/products. It includes a servlet engine based on the Tomcat servlet engine and supports the servlet specification JSDK 2.3. There are three versions:
  • Web edition
  • VisiBroker Edition
  • AppServer Edition
    Spy-Server has been tested with the simplest version: Borland Enterprise Server Web edition 5.1

    Borland Enterprise Server has an "Borland Management Console" which makes it easy to deploy Spy-Server.


  • Spy-Server Deployment and Configuration Instructions


    Installing Spy-Server

    Installing the Spy-Server web application SpySrv50.war is usually called deployment.
    1. Start the "Borland Management Console"
    2. Select menu "Wizards+Deployment wizard"
    3. Click "Add", navigate to find SpySrv50.war on a local disk, and click "OK"
    4. Click "Next" and then "Finish"
    5. Once Spy-Server is deployed, select "Close".
    6. Spy-Server should now be installed with context path /SpySrv50.


    Spy-Server URLs

    The following URLs should now be available (assuming that Borland Enterprise Server is running on the default web server port of 80):
    Spy-Server welcome page http://localhost/SpySrv50/
    Spy-Server documentation http://localhost/SpySrv50/doc/
    Spy-Server search page http://localhost/SpySrv50/search
    Spy-Server configuration screen http://localhost/SpySrv50/search?config=now


    Check the work directory location

    Before you start testing Spy-Server, it is important to check that the Spy-Server work directory is in a suitable location.
    Spy-Server uses a work directory to store all its configuration information and search database files. It is important that this directory is secure from unwanted direct access, while still being available to Spy-Server. It is also a good idea to make sure that this directory is not wiped accidentally, eg if you update the Spy-Server runtime to a newer version. Finally, it is also a good idea to backup the contents of the Spy-Server work directory regularly.
    Spy-Server makes a work directory called SpyData when it starts. However, Spy-Server usually makes this directory in an inappropriate place (which is likely to be lost if Spy-Server is redeployed), eg:
    ../var/servers/kidsty/partitions/standard/tmp/tmpbes_45106spysrv50.war/spysrv50.war/spydata

    It is therefore strongly recommended that you change the work directory by setting the work init parameter as described in the following section.

    Changing init parameters

    1. Start the "Borland Management Console"
    2. Drill down to select the server partition "Deployed Modules" entry for Spy-Server, eg SpySrv50.war
    3. Right-click and select "Edit deployment descriptor" from the menu
    4. Wait for the "Borland Deployment Descriptor Editor" window to appear
    5. Open the "SpySrv50.war" tree root and click on "Spy-Server"
    6. Click on the "Init Params" tab at the bottom of the window
    7. Find the parameter, eg work.
    8. Click in the box on the right, enter your new value and press Return.
    9. Select menu "File+Save" then close the Editor window
    10. Close the "Running process" window
    11. The Spy-Server application should now start redeployment
    12. Wait until Spy-Server is running again
    Note that the XML tab in the main console is not updated to show the new init parameter setting.


    Test Search

    Check that you can search the Spy-Server documentation correctly, as follows:

    Browse to the Spy-Server localised search page, eg http://localhost/SpySrv50/search.

    Enter some search text, eg engine and click on "Search".

    The first 10 hits are displayed. Click on a hit and check that the result page is displayed correctly in the browser.

    If the hit page is not shown correctly, then you probably need to alter the Additional Base URL setting in the configuration screen Searching section.


    Index your own site

    Follow the general Getting Started instructions to index your own site to build a search database and start searching.


    Test Word highlighting

    See the Word highlighting instructions for details of how to set this up for HTML pages shown in Internet Explorer 4+.


    Additional Borland Enterprise Server Instructions

    Logs

    By default, the Borland Enterprise Server servlet engine logs are NOT on. In the "Borland Management Console", select "Partition Services" then "Web Containers". Right-click and then select "Configure". Edit the servlet.xml text to uncomment the tag: Logger directory="logs".

    The log files are in a directory similar to this
    ../var/servers/kidsty/adm/properties/partitions/standard/tomcat/logs


    Updating Spy-Server

    1. Start the "Borland Management Console"
    2. Drill down to select the server partition "Deployed Modules" entry for Spy-Server, eg SpySrv50.war
    3. Right-click and select "Redeploy" from the menu
    4. Select the existing entry for SpySrv50.war and click the "Remove" button
    5. Click on "Add" and then proceed as for installation
    Note that you will probably need to reset the Spy-Server work init parameter to your chosen directory, as described above.


    Uninstalling Spy-Server

    1. Start the "Borland Management Console"
    2. Drill down to select the server partition "Deployed Modules" entry for Spy-Server, eg SpySrv50.war
    3. Right-click and select "Remove" from the menu

    Spy-Server online
    Find in Site search engines for MS-servers, Java-servers and CDs/DVDsSpy-Server is part of the FindinSite software range - search engines for MS-servers, Java-servers and CDs/DVDs