Oracle® Secure Enterprise Search

Checking the Software Requirements

This section lists software requirements for Microsoft Windows installations.

A Windows system must meet the following minimum operating system requirements:

• Windows Server 2003 - all editions

• Windows 2000 with Service Pack 2 or later

• Windows XP Professional

Checking Hardware Requirements

Oracle SES requires a minimum of 2 gigabytes of disk space. This includes 1 gigabyte to install and approximately 0.5 gigabytes to create the initial Oracle SES index. Additional Oracle SES requirements are based on the amount of data that you need to search. Here are some configuration examples:

To index 100,000 documents:

• 4 gigabytes disk space

• 1 gigabyte RAM

To index 1,000,000 documents:

• 20 gigabytes disk space

• 6 gigabytes RAM

For installation help, including pre-installation tips, see the Oracle SES tutorial:

http://st-curriculum.oracle.com/tutorial/SESAdminTutorial/index.htm

Configuring a Loopback Adapter

A loopback adapter is required if:

• You are installing on a Dynamic Host Configuration Protocol (DHCP) computer, or

• You are installing on a non-networked computer and plan to connect the computer to a network after installation

For detailed instructions, see the Oracle Database Installation Guide 10g Release 1 (10.1.0.2.0) for Windows. This is posted at

http://download.oracle.com/docs/html/B10130_02/reqs.htm#sthref370

Changing the Oracle SES Middle Tier Port

To change the Oracle SES middle tier port, follow these steps:

1. Shutdown the middle tier with the following command:

   $ORACLE_HOME/bin/searchctl stop
   
   

2. Edit the value for the port attribute in $ORACLE_HOME/oc4j/j2ee/OC4J_SEARCH/config/http-web-site.xml. (Make sure that the new port is not already in use.)

3. Start the middle tier with the following command:

   $ORACLE_HOME/bin/searchctl start
   

Creating Registry Keys

If this is the first time-installation of Oracle SES, then you must create the registry keys before starting.

HKEY_LOCAL_MACHINE \ SOFTWARE \ ORACLE \ inst_loc = Inventory_Location

The Inventory_Location is the location of your installer files. For example:

Drive_Letter:\program files\oracle\Inventory

Selecting a Response File

Before performing a silent installation, you must provide information specific to your installation in a response file. The installer will fail if you attempt an installation using a response file that is not configured correctly. Response files are text files that you can create or edit in a text editor.

The Oracle SES DVD provides the following templates for the Oracle Universal Installer response files:

Response files are located in the \response directory on Disk 1 of the Oracle SES DVD. You must edit the response file according to your requirements for silent installation.

To use a response file, first copy it from the DVD to your system. For example:

1. Go to the \response directory.

2. Copy the server.rsp file to your system hard drive:

   # copy server.rsp Drive_Letter:\1018\Disk1\response\server.rsp
   

Editing the Response File

Use any text editor to edit the response file to include information specific for your system. You must specify values for variables in your response file. Each variable listed in the response file is associated with a comment, which identifies the variable type. For example:

string = "Sample Value"
Boolean = True or False
Number = 1000
StringList = {"StringValue 1", "String Value 2"}

The values that are given as <Value Required> must be specified for silent installation. Remove the comment from the variable values in the response file before starting the Oracle SES installation.

Specifying a Response File and Starting the Installation

Before you specify a response file, ensure that all the values in the response file are correct. To make Oracle Universal Installer use the response file at installation time, specify the location of the response file as a parameter when starting Oracle Universal Installer. To perform a silent installation, use the -silent parameter:

Drive_Letter:\> setup.exe -silent -responseFile absolute_path_and_filename

The success or failure of silent installations is logged in the installaction<timestamp>.log file. Additionally, the silent installation creates the silentinstall<timestamp>.log file. The log files are created in the C:\Program Files\Oracle\Inventory\oui_inventory\Logs directory.

The silentinstall<timestamp>.log file contains the following line if the installation was successful:

The installation of Oracle Secure Enterprise Search <Installation Type> was successful.

The installaction<timestamp>.log file contains specific information for each installation type.

Security Tips for Silent Installations

The response file contains the installation password in clear text. To minimize security issues, follow these guidelines:

• Set the permissions on the response files so that they are readable only by the operating system user performing the silent installation.

• If possible, remove the response files from the system after the silent installation is completed.

Error Handling

The success or failure of a silent installation is logged in the silentinstall<timestamp>.log file. This file is created in the Inventory\log directory.

Values for variables that are of the wrong context, format, or type are treated as if no value were specified. Variables that are outside any section are ignored.

If you attempt a silent installation with an incorrect or incomplete response file, or if Oracle Universal Installer encounters an error, such as insufficient disk space, the installation fails.

Increase Memory - Optional

On Windows, Oracle SES cannot allocate memory (SGA + PGA) correctly if the machine has more than 2G physical memory. The maximum memory usage Oracle SES can allocate is 800M.

If your server has more than 2G physical memory, you can manually increase the SGA and PGA memory size.

In the following steps:

• %ORACLE_HOME% is the directory where Oracle SES was installed.

• <SES Password> is the Oracle SES administrator password specified during installation.

• <SES NAME> is the Oracle SES instance name specified during installation.

1. Open the original initialization parameter file (init.ora.*) file with a text editor. It is in the %ORACLE_HOME%\admin\<SES NAME>\pfile directory. Remember to make a backup of this file.

2. Find sga_target and pga_aggregate_target, and increase the size of each. For example, increase the SGA to 800M with sga_target=800M.

   Specify 30% of physical memory to sga_target and 10% of physical memory to pga_aggregate_target. 1.5G is the limit for sga_target, even if you specify more than 1.5G. Save the modified file.

3. Start Oracle SES.

4. Enter sqlplus in a command prompt to start SQL*Plus.

5. Enter the following in the SQL*Plus login prompt:

   sys/<SES Password> as sysdba
   
   

6. Create a new server parameter file (SPFILE) with the following statement:

   SQL> CREATE SPFILE='%ORACLE_HOME%\dbs\SPFILE_NEW.ORA'
   FROM PFILE='%ORACLE_HOME%\admin\<SES NAME>\pfile\init.ora.*';
   
   

   Specify a new file name for SPFILE, and specify the modified init.ora.* file for initialization parameter file (pfile).

   See Also:

   Oracle Database SQL Reference for details on the CREATE SPFILE statement

7. Enter exit to quit SQL*Plus.

8. Shut down Oracle SES.

9. Make a backup for the original SPFILE: %ORACLE_HOME%\dbs\SPFILE.ORA. Then, rename the newly created %ORACLE_HOME%\dbs\SPFILE_NEW.ORA to SPFILE.ORA.

10. Start Oracle SES.

11. To confirm that your change was applied, launch SQL*Plus with the eqsys/<SES Password> user. Then enter the following:

    SQL> show parameter sga_target
    SQL> show parameter pga_aggregat_target
    
    

    If Oracle SES cannot start, then restore the SPFILE.ORA and start Oracle SES again.

Certifications and Patches

The Oracle SES administration tool and default query application are certified on the following browsers:

• Firefox 1.0, 1.0.1, 1.0.6, 1.0.7, 1.5

• Internet Explorer 6.0

• Netscape 7.1, 7.2

• Mozilla 1.7.3

The requirements and certifications included in this installation guide were current at the time this guide was published. See the certification matrix on the OracleMetalink Web site for the most up-to-date information.

Starting Oracle Secure Enterprise Search

Oracle SES should be started before upgrade. For example, navigate to the bin directory and run searchctl startall.

Backing Up the Oracle SES 10.1.6 Instance

There is no downgrade support from 10.1.8. Before upgrading, first shutdown Oracle SES. Then, perform the following steps.

1. Using the Windows registry editor regedit, back up the following Windows registry entry: \HKEY_LOCAL_MACHINE\software\oracle.

2. Back up the OC4J service as described in "Backing Up the OC4J Service".

3. Ensure that you backup the following folders:

   • %ORACLE_HOME%: This is where Oracle SES 10.1.6 is installed.

   • oradata: This is the location you specified for Data Storage Location during the installation.

   • Inventory_Location: This is the location of your installer files. For example: Drive_Letter:\program files\oracle\Inventory

Backing Up the OC4J Service

Using the Windows registry editor regedit, back up the following Windows registry entry:

\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Oracle%ORACLE_SID%OC4J

where %ORACLE_SID% is the name of your search instance.

This corresponds to the OC4J service. The regedit utility has an export function that lets you specify a file that contains the backed up registry entry.

\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Oracle%ORACLE_SID%OC4J

Moving QTA Jar Files

For any custom query-time authorization (QTA) jar files in the 10.1.6 Oracle home directory, manually move them into the new Oracle home directory or into an entirely new location. Also, for any sources that used these QTA jar files, update the location in the Jar File Name field on the Home - Sources - Authorization page. This protects you from inadvertently deleting these jar files if you remove the old Oracle home directory after the upgrade process.

Migrating Federated Sources

To migrate federated sources in the 10.1.6 installation, you must edit each federated source in the 10.1.8 installation. On the Home - Sources - Customize Federated Source page, enter the Web services URL for the source.

After editing the source, you can have public federated search on the remote Oracle SES instances. For secure federated search, see the section "Setting Up Secure Federated Search" in the Oracle Secure Enterprise Search Administrator's Guide. If the remote Oracle SES instances are using the 10.1.6 installation, then they also need to be upgraded to 10.1.8 for secure federated search to work.

If the remote Oracle SES instances are using the 10.1.6 installation, then follow Appendix A, "10.1.6 to 10.1.8 Upgrade" in the Oracle Secure Enterprise Search Administrator's Guide, or they also need to be upgraded to 10.1.8 for secure federated search to work.

Migrating Single Sign-On Configuration

If the 10.1.6 Oracle SES instance had been configured to use a single sign-on URL to access the Oracle SES search page and administration tool, then do the following to migrate the configuration to 10.1.8:

1. Edit the $ORACLE_HOME/oc4j/j2ee/OC4J_SEARCH/config/http-web-site.xml file. In the element web-site, change the attribute protocol from "http" to "ajp13":

   <web-site ... protocol="ajp13" ... >
   
   

2. Restart the Oracle SES middle tier using searchctl restart.

3. Configure mod_osso to protect the search with SSO. Add the following lines to $AS_HOME/Apache/Apache/conf/mod_osso.conf within the IfModule element:

   <Location /search/query/formlogin.uix>
     require valid-user
     AuthType Basic
   </Location>
   
   

4. Restart Oracle HTTP Server. On the OracleAS middle tier host, run the following command:

   $AS/opmn/bin/opmnctl restartproc process-type=HTTP_Server
    
   opmnctl: restarting opmn managed processes...
   

Changes in 10.1.8

• If 10.1.6 was connected to Oracle Internet Directory, then after upgrade, you may see "orclApplicationCommonName=oesEntity_ ... " in the user name on the Global Settings - Identity Management Setup page. This user was created implicitly by Oracle SES 10.1.6 when the instance connected to Oracle Internet Directory, and it was used internally for Oracle Internet Directory authentication and authorization. After upgrade, 10.1.8 continues to use the user for Oracle Internet Directory authentication and authorization.

• In 10.1.6, the jar files for custom crawler plug-ins were located in the $ORACLE_HOME/search/lib/agent directory. This directory does not exist in 10.1.8. These jar files from 10.1.6 were migrated to the $ORACLE_HOME/search/lib/plugins directory.