findinsite-js installation guide for IBM WebSphere

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 WebSphere introduction Setting up... Install findinsite-js findinsite-js URLs Work directory Run test searches Index your own site Word highlighting Configuration Init parameters Updating findinsite-js Uninstalling findinsite-js

IBM WebSphere

WebSphere can be connected to several types of main server, including the "IBM HTTP Server" which is based on Apache. WebSphere includes a servlet web server so it does not need to be connected to a web server when testing.

WebSphere has an "Administrative Console" browser interface which makes it fairly easy to deploy findinsite-js.

findinsite-js Deployment, Configuration and Usage Instructions

findinsite-js has also tested OK on the Windows version of WebSphere Application Server version 5; the instructions below work, with two extra options page; and you will need to start findinsite-js in the Administrative Console Applications+Enterprise Applications section.

Installing findinsite-js

1. Start the WebSphere Administrative Console, eg: http://localhost:9090/admin. Give any suitable login username.

2. In the navigation panel on the left, open Nodes, then SERVER, then click on "Enterprise Applications".

3. Click on Install
   Fill in the top 3 fields as follows:

   Path:	Browse to find findinsitejs.war on your local disk
   Application name:	Eg FindinSite
   Context Root:	Eg /fisjs
   Click Next

   In the next screen, select an appropriate Virtual Host, eg default_host. You can set Precompile JSPs to No.
   Click Next

   Confirm installation and click Finish.

4. Click on link: "Plug-in configuration needs to be regenerated".
   Click Generate

5. Click on link: "Configuration needs to be saved".
   Click OK

6. Click Exit at top to exit console.

7. Stop WebSphere

   Do this from the "First steps" panel,
   Or by running <WS_INSTALL_DIR>/bin/stopserver.bat

8. Stop and restart the "IBM HTTP Server" service so that the new plug-in mapping is recognised.

   In W2000, open the Control Panel, select Administrative Tools, then Services.
   In NT4, open the Control Panel, then Services.
   Find "IBM HTTP Server". Right-click, first to stop and then again to start the server service.

9. Restart WebSphere

findinsite-js URLs

Check the work directory 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.

Changing init parameters

1. Start the WebSphere "Application Assembly Tool"
2. Open the findinsite-js auto-generated .EAR file, eg
   ../AppServer/installedApps/FindinSite.ear
3. In the tree, drill down into "Web Modules+FindinSite+Web Components+FindinSite+initialization Parameters"
4. Select the desired parameter on the right, eg work
5. Enter a new Parameter value and click on Apply
6. Then File+Save the application assembly

7. In the "WebSphere Administrative Console", find the "Enterprise Applications" list.
8. Select the checkbox next to FindinSite, click "Stop" then "Start"
9. Wait until findinsite-js is running again

Test Search

1. Browse to the findinsite-js localised search page, eg http://localhost/fisjs/search. Check that the "findinsite-js" image is shown correctly; if not check the first IMG link in the template file FindHead.htt in the WebSphere installedApps/FindinSite.ear/findinsitejs.war/ directory.

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

3. 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

Test Word highlighting

Additional IBM WebSphere Instructions

Updating findinsite-js

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

Uninstalling findinsite-js

1. In the "WebSphere Administrative Console", find the "Enterprise Applications" list.
2. Select the checkbox next to FindinSite, click "Uninstall"