findinsite-js installation guide for Borland Enterprise Server

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 findinsite-js.

Introduction

findinsite-js 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 findinsite-js.

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

Page contents

Enterprise Server introduction

Setting up...

Install findinsite-js

findinsite-js URLs

Work directory

Run test searches

Index your own site

Word highlighting

Configuration

Init parameters

Log files

Updating findinsite-js

Uninstalling findinsite-js

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 two versions:

VisiBroker Edition

AppServer Edition
findinsite-js has been tested with an old simple version: Borland Enterprise Server Web edition 5.1

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

findinsite-js Deployment, Configuration and Usage Instructions

Installing findinsite-js

Installing the findinsite-js web application findinsitejs.war is usually called deployment.

Start the "Borland Management Console"
Select menu "Wizards+Deployment wizard"
Click "Add", navigate to find findinsitejs.war on a local disk, and click "OK"
Click "Next" and then "Finish"
Once findinsite-js is deployed, select "Close".
findinsite-js should now be installed with context path /findinsitejs.

findinsite-js URLs

The following URLs should now be available (assuming that Tomcat is running on the default web server port of 80, and the context path is /findinsitejs):

findinsite-js welcome page	http://localhost/findinsitejs/
findinsite-js documentation	http://localhost/findinsitejs/doc/
findinsite-js search page	http://localhost/findinsitejs/search
findinsite-js configuration screen	http://localhost/findinsitejs/search?config=now

Check the work directory location

Before you start testing findinsite-js, it is important to check that the findinsite-js work directory is in a suitable location.

findinsite-js 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 findinsite-js. It is also a good idea to make sure that this directory is not wiped accidentally, eg if you update the findinsite-js runtime to a newer version. Finally, it is also a good idea to backup the contents of the findinsite-js work directory regularly.

findinsite-js makes a directory called FindData when it starts. However, findinsite-js usually makes this directory in an inappropriate place (which is likely to be lost if findinsite-js is redeployed), eg:
../var/servers/kidsty/partitions/standard/tmp/tmpbes_45106findinsitejs50.war/findinsitejs.war/finddata

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

Start the "Borland Management Console"
Drill down to select the server partition "Deployed Modules" entry for findinsite-js, eg findinsitejs.war
Right-click and select "Edit deployment descriptor" from the menu
Wait for the "Borland Deployment Descriptor Editor" window to appear
Open the "findinsitejs.war" tree root and click on "FindinSite"
Click on the "Init Params" tab at the bottom of the window
Find the parameter, eg work.
Click in the box on the right, enter your new value and press Return.
Select menu "File+Save" then close the Editor window
Close the "Running process" window
The findinsite-js application should now start redeployment
Wait until findinsite-js 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 findinsite-js documentation correctly, as follows:

Browse to the findinsite-js localised search page, eg http://localhost/findinsitejs/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 findinsite-js

Start the "Borland Management Console"
Drill down to select the server partition "Deployed Modules" entry for findinsite-js, eg findinsitejs.war
Right-click and select "Redeploy" from the menu
Select the existing entry for findinsitejs.war and click the "Remove" button
Click on "Add" and then proceed as for installation

Note that you will probably need to reset the findinsite-js work init parameter to your chosen directory, as described above.

Uninstalling findinsite-js

Start the "Borland Management Console"
Drill down to select the server partition "Deployed Modules" entry for findinsite-js, eg findinsitejs.war
Right-click and select "Remove" from the menu