Content Search Guide

CHAPTER 2

Configuring Your Environment for Conceptual Searching

This chapter explains how to set up your environment for implementing conceptual searching in your exteNd Director applications. You will learn about platform-specific and server-specific configuration requirements for using conceptual search capabilities with the Content Management (CM) subsystem.

The following configuration tasks are covered:

Installing the exteNd Director Dynamic Reasoning Engine

As you learned in About Searching, conceptual searching uses a Dynamic Reasoning Engine (DRE) based on technology from Autonomy, Inc. Therefore, you must install the DRE on the platform where you will run exteNd Director applications that implement conceptual search.

This section describes how to install the DRE on platforms supported by exteNd Director. These platforms are listed in the Release Notes.

Installing the DRE on Windows

The exteNd Director DRE is automatically installed with exteNd Director on Windows and automatically launched when you start the Windows machine where you installed exteNd Director.

If you want to run the DRE on a different machine from where you installed exteNd Director, follow these steps:

Procedure To install the exteNd Director DRE on a remote Windows server:

Run the exteNd Director installation program and proceed through the introductory screens.
On the Setup Type panel, choose the Custom option.
On the panel for selecting features, select Autonomy DRE.
Finish the installation wizard.

Installing the exteNd Director DRE on a remote Windows server

If you want to run the DRE on a different Windows machine from where you installed exteNd Director, follow these steps:

Procedure To install the exteNd Director DRE on a remote Windows server:

Run the exteNd Director installation program and proceed through the introductory screens.
On the Setup Type panel, choose the Custom option.
On the panel for selecting features, select Autonomy DRE.
Finish the installation wizard.

Installing the DRE on UNIX

In the installer directory (Director/autonomy), run the setup command, using this syntax:

  ./Setup.sh App_Name App_dir DRE_IP_Address DRE_Port DRE_IndexerPort Root_html_dir CGI_dir_Map

where:

Argument	Description
App_Name	Name of your Autonomy server installation
App_dir	The full path of the location where the software should be installed NOTE: This directory will be created and must not already exist
DRE_IP_Address	The host IP address
DRE_Port	The port number for communicating with the DRE; this port must be different from the DRE_IndexerPort
DRE_IndexerPort	The port number for communicating with the indexing process of the DRE NOTE: This port must be different from the DRE_Port
Root_html_dir	The full path to the location of the root document directory for your Web server NOTE: The HTML files will be installed into a subdirectory with the same name as App_Name
CGI_dir	The full path to the CGI directory on your Web server NOTE: This directory needs to be mapped for CGI files and to be accessible via the URL /Scripts (see CGI_Dir_Map)
CGI_Dir_Map	The CGI mapping to be used

Here is a sample command:

  ./Setup.sh MyServer /Autonomy/Server 127.0.0.1 2000 2001 /opt/ns-home/docs /opt/ns-home/cgi-bin /Scripts

When prompted, choose a style.
Navigate to the App_dir directory and start the Autonomy services by entering these commands:
```
  cd App_dir
  StartQuery.sh
```

Adding the Autonomy Java Native Interface to your environment

You add the Autonomy Java Native Interface (JNI) to your environment by:

Adding autonomyJNI.jar to your application server classpath

AutonomyJNI.jar resides in:

On	JAR is installed at
Windows	The exteNd Director installation directory under the subdirectory autonomy
Linux	$HOME/Director500Autonomy
Solaris	$HOME/Director500Autonomy

To add autonomyJNI.jar to your server classpath, follow server-specific instructions below.

Instructions for Novell server

Start the server from the command line with the classpath command. For example, assuming you install exteNd Director at c:\xwb, here is the syntax:

To	Use this command line
Prepend a JAR to the classpath	silverserver +cp:p C:\xwb\exteNd Director\autonomy\autonomyJNI.jar
Append a JAR to the classpath	silverserver +cp:a C:\xwb\exteNd Director\autonomy\autonomyJNI.jar

NOTE: If you install exteNd Director on your hard drive under Program Files, you must use the shortcut Progra~1 in the path on the command line.

Instructions for BEA WebLogic server

Follow these instructions to add autonomyJNI.jar to your BEA WebLogic server classpath:

Open the server's startup file for editing.

TIP: The default startup file on Windows NT is startWebLogic.cmd.
Edit the set CLASSPATH command by appending autonomyJNI.jar to the classpath.
Save and close the file.

Instructions for IBM WebSphere server

Copy autonomyJNI.jar to the WebSphere Classpath directory (typically \WebSphere\AppServer\lib).

Adding the Autonomy dynamic library to your environment

The Autonomy dynamic library is contained in the following files on each supported platform:

On this platform	Dynamic library is
Windows NT	autonomyJNI.dll
Linux	libautonomyJNI.so
Solaris	libautonomyJNI.so

You must add this dynamic library to your server environment—that is, to the machine on which you deploy your application. Follow the server-specific and platform-specific instructions below.

Instructions for Novell server

On Windows The file autonomyJNI.dll is installed in the exteNd Director installation directory under the subdirectory autonomy.

The directory containing autonomyJNI.dll is automatically added to the path of the machine where you install exteNd Director. If you are using this machine as your server, you are all set. Otherwise, add the path of the directory containing autonomyJNI.dll to your library path (the PATH environment variable of your server).

On UNIX Add the path of the directory containing libautonomyJNI.so or libautonomyJNI.sl to the library path as follows:

Open your Novell configuration file .agprofile in the Novell exteNd^TMApplication Server installation directory.
Edit .agprofile as follows:

For

Do this

Solaris

Add the path to libautonomy.so to the LD_LIBRARY_PATH variable

For	Do this
Solaris	Add the path to libautonomy.so to the LD_LIBRARY_PATH variable

Instructions for other supported servers

Consult the documentation for BEA WebLogic and IBM WebSphere servers for instructions on how to edit the library path for those servers on Windows and UNIX platforms.

Determining your exteNd Director project configuration

Before you create your exteNd Director project, you need to determine which subsystems you need to include for implementing conceptual searching. Often, the configuration is dictated by the methodologies you choose for updating content in the CM repository.

Use the following table as a guide:

To update content	Include
To update content	Search subsystem	CM subsystem	Portal subsystem	DAC
Using the CMS Administration Console in the DAC
At runtime using the CM API			—	—
Using WebDAV to transfer updates from third-party applications into the CM repository			—	—

You can use any combination of these methodologies as long as you include the required subsystems in your exteNd Director project.

For more information about the CMS Administration Console, CM API, and WebDAV, see the Content Management Guide.

Creating the exteNd Director project

Now that you have determined which subsystems you need for implementing conceptual search, you can create a new exteNd Director project that includes these subsystems and all others that your application will need.

You use the Project Wizard to create new projects. If you create a custom project, you can include subsystems individually. If you create a typical project, all exteNd Director subsystems are included automatically.

Procedure To create an exteNd Director project that supports searching:

Follow the procedure for using the Project Wizard, described in the section on creating exteNd Director projects in Developing exteNd Director Applications.
Keep these guidelines in mind:
- You must enable conceptual search for your project—either as you create a new project at design time or afterward in an existing project. See Enabling conceptual search for details.
- If you installed the DRE on UNIX, change the location of the binary document text filter directory, which defaults to a Windows path. You can set this directory at design time if you create a custom project in the Project Wizard and modify settings on the Filters tab in the Content Management Search Configuration panel.
  
  IMPORTANT: After creating your project, set read/write/execute permission on the designated binary document text filter directory.

Enabling conceptual search

Before you can implement search in your applications, you must set the option that enables the conceptual search capability.

You can set this option at design time when you create a custom exteNd Director project, or in an existing project.

Procedure To enable search at design time:

Begin creating your project using the Project Wizard.

For more information, see the section on creating exteNd Director projects in Developing exteNd Director Applications.
In the Setup Type panel, select Custom.

IMPORTANT: If you create a typical project instead of a custom project, search is disabled by default. You must then override this default after you create your project, using the technique described in To enable search in an existing project:.
When you reach the Content Management Search Configuration panel, set Enable link to the search service to Yes:
Complete the rest of the wizard panels to finish creating your project.

Procedure To enable search in an existing project:

In exteNd Director, open config.xml for the CM subsystem in the project in which you want to implement conceptual search.

For more information about where project files are located, see the section on exteNd Director project structure in Developing exteNd Director Applications.
In the configuration file, set the property com.sssw.cm.search.enable.repository name to true:

Make sure you enable search for the correct repository. For example, if you plan to search the default CM repository, enable this option:
```
  com.sssw.cm.search.enable.Default
```
Configure other options in this file if necessary, as described in Setting Search Options.
Redeploy the project for the new settings to take effect.

For more information about this option, see Enable link to the Search subsystem?.

Setting security options

Your system administrator needs to set security options so that when authorized users add custom metadata fields in the CM repository, these changes propagate to the Search service and are indexed correctly into the DRE. In this way, the CM subsystem is synchronized with the Search service to preserve the integrity of search results.

Here's what to do:

Assign authorized users to the SearchAdmin group.
Assign READ, WRITE, and PROTECT permissions to the SearchAdmin group.

For more information To learn how to set these options in the Portal Administration Console (PAC), see the chapter on managing security using the PAC in the User Management Guide.

Setting search options

The Search subsystem provides a comprehensive set of options that you can configure to customize search technology and behavior.

For more information To learn more about these options, see Setting Search Options and Search Options Reference.