Installation and Upgrade Guide
10g Release 1 (10.1.8) for Microsoft Windows (32-Bit)
B32263-01
December 2006
This document describes how to install Oracle Secure Enterprise Search (SES). It includes the following sections:
This section contains the following topics:
Oracle SES can be installed on the following Windows operating systems: Windows 2000, Windows Server 2003, and Windows XP.
This section contains the following topics:
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
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
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
https://download.oracle.com/docs/html/B10130_02/reqs.htm#sthref370
To change the Oracle SES middle tier port, follow these steps:
Shutdown the middle tier with the following command:
$ORACLE_HOME/bin/searchctl stop
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.)
Start the middle tier with the following command:
$ORACLE_HOME/bin/searchctl start
For easy instructions on installing Oracle SES, see the Installation Tips tutorial:
http://st-curriculum.oracle.com/tutorial/SESAdminTutorial/index.htm
To install the Oracle Secure Enterprise Search software:
Ensure that you satisfy all minimum requirements, as described in "Pre-Installation Tasks".
Log on as a member of the Administrators group to the computer on which you will install Oracle components. This user cannot be part of more than one domain in the same network.
If you are installing on a Primary Domain Controller (PDC) or a Backup Domain Controller (BDC), then log on as a member of the Domain Administrators group.
Insert the DVD or navigate to the directory where you downloaded or copied the installation files. Use the same installation media to install Oracle Secure Enterprise Search on all supported Windows platforms.
Start the installer:
When installing from a hard disk, double-click setup.exe
located in the directory you created for the downloaded or copied installation files.
When installing from the DVD, enter the following:
prompt> cd prompt> CDROM:\setup.exe
This launches Oracle Universal Installer. In the Oracle Universal Installer, the only value that you must specify is the administrative password. The remaining values are set to a default, but they can be overridden. Following is the list of the installation parameters:
Search Server Name: Name for your search server.
Administrative Password: The password that you will later use to log on to the administration tool.
HTTP Port: The port on which the Oracle SES middle tier will listen. For example, if you installed Oracle SES on host myhost.oracle.com and you specify port 7890, then your search page URL will be http://myhost.oracle.com:7890/search/query/search
.
Destination Path: The location where Oracle SES software is installed.
Data Storage Location: The location where Oracle SES will store its data.
The following screenshot shows the Oracle Universal Installer screen.
Click Install. The installer will perform the prerequisite checks and proceed with the installation.
When all of the configuration tools have finished, click Exit, then click Yes to exit from Oracle Universal Installer.
A silent installation has no graphical output and no input by the user. It is accomplished by supplying Oracle Universal Installer with a response file and specifying the -silent
flag on the command line. Use silent installation when you want similar installations on more than one computer. Additionally, you can use silent installation when performing the Oracle SES installation from a remote location using the command line.
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
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:
Installation Type | Response File |
---|---|
Oracle SES installation |
|
Oracle SES upgrade |
|
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:
Go to the \response
directory.
Copy the server.rsp
file to your system hard drive:
# copy server.rsp Drive_Letter:\1018\Disk1\response\server.rsp
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.
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
WARNING:
During installation, response files may be copied to subdirectories under %ORACLE_HOME%. When the installation completes successfully, these copies are removed. If the installation fails, however, these copies may not be removed. If you have provided passwords or other sensitive information in your response files, Oracle recommends that you delete any copies of the response files that remain in your file system.
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.
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.
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.
The following URLs indicate a successful installation:
Search: http://host:port/search/query/search
Administration tool: http://host:port/search/admin/index.jsp
(Log on using the password specified during installation.)
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.
Note:
Because this task increases the SGA and the PGA to improve cache hit ratio, it should be done by an Oracle Database administrator.See Also:
Oracle Database Concepts for more information on Oracle memory architectureIn 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.
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.
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.
Start Oracle SES.
Enter sqlplus
in a command prompt to start SQL*Plus.
Enter the following in the SQL*Plus login prompt:
sys/<SES Password> as sysdba
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 theCREATE
SPFILE
statementEnter exit
to quit SQL*Plus.
Shut down Oracle SES.
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
.
Start Oracle SES.
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.
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.
See Also:
"Oracle Support Services"To uninstall Oracle SES, navigate to Control Panel - Add or Remove Programs, and remove Oracle Secure Enterprise Search.
This section contains the following topics:
See Also:
Appendix A, "10.1.6 to 10.1.8 Upgrade" in the Oracle Secure Enterprise Search Administrator's Guide
"Upgrade Issues" in the Oracle Secure Enterprise Search Release Notes
This section contains the following topics:
Oracle SES should be started before upgrade. For example, navigate to the bin
directory and run searchctl startall
.
There is no downgrade support from 10.1.8. Before upgrading, first shutdown Oracle SES. Then, perform the following steps.
Using the Windows registry editor regedit
, back up the following Windows registry entry: \HKEY_LOCAL_MACHINE\software\oracle
.
Back up the OC4J service as described in "Backing Up the OC4J Service".
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
Using the Windows registry editor regedit
, delete the following Windows registry entry: \HKEY_LOCAL_MACHINE\software\oracle
.
Invoke the import function in the registry editor and point it to the file that was backed up, as described in "Backing Up the Oracle SES 10.1.6 Instance".
Restore the OC4J service as described in "Restoring the OC4J Service".
Ensure that the folders that were backed up in "Backing Up the Oracle SES 10.1.6 Instance" are restored to their pre-upgrade locations. The restored folders should be an exact replica of the backup that was performed.
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.
Using the Windows registry editor regedit
, delete 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.
Invoke the import function in the registry editor and point it to the file that was backed up, as described in "Backing Up the OC4J Service".
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.
When the Oracle SES installation process detects an existing Oracle SES instance on the computer, it will give you the option of either upgrading the existing installation or creating a new installation.
If you choose to upgrade an existing installation, then simply follow the prompts to select the location where the Oracle SES 10.1.6 software is installed, the administrative password that was set with this existing installation, and the location where the new Oracle SES 10.1.8 software will be installed. The 10.1.8 location must be different than the 10.1.6 location; that is, you cannot install 10.1.8 inside the 10.1.6 Oracle home.
A silent upgrade has no graphical output and no input by the user. It is accomplished by supplying Oracle Universal Installer with a response file and specifying the -silent
flag on the command line.
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 upgrade.
To use a response file, first copy it from the DVD to your system. For example:
Go to the /response
directory.
Copy the upgrade.rsp
file to your system hard drive:
# copy upgrade.rsp Drive_Letter:\ses\response\upgrade.rsp
Use any text editor to edit the response file to include information specific for your system.
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_to_response_file
WARNING:
During upgrade, response files may be copied to subdirectories in the Oracle home. When the upgrade completes successfully, these copies are removed. If the upgrade fails, however, these copies may not be removed. If you have provided passwords or other sensitive information in your response files, then delete any copies of the response files that remain in your file system.
This section contains the following topics:
WARNING:
The Data Storage Location specified in the Oracle SES installation is shared by both the 10.1.6 and the 10.1.8 installations. If this data storage directory is inside the 10.1.6 Oracle home, then be very careful not to remove this directory after upgrading to 10.1.8.
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.
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:
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" ... >
Restart the Oracle SES middle tier using searchctl
restart
.
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>
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...
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.
The tool for starting and stopping the search engine is searchctl
. To restart Oracle SES after rebooting, navigate to the $ORACLE_HOME/bin
directory where Oracle SES is installed and run searchctl restartall
.
To become familiar with Oracle Secure Enterprise Search, Oracle suggests that you complete the following tasks:
Read the Oracle Secure Enterprise Search Administrator's Guide, particularly Appendix A, Upgrade Issues.
Follow the Oracle Secure Enterprise Search tutorial:
http://st-curriculum.oracle.com/tutorial/SESAdminTutorial/index.htm
Log in to the Oracle SES administration tool, using the user name and password set in the installation. With the administration tool, you can:
Define sources to search
Configure and schedule the crawling of the sources
Monitor the status and performance of crawling and search
Click the Help link in the top right corner of any page in the administration tool for context-sensitive help.
In a production environment, where a load balancer or other monitoring tools are used to ensure system availability, Oracle SES can also be easily monitored through the following URL: http://<host>:<port>/monitor/check.jsp
. The URL should return the following message: Oracle Secure Enterprise Search instance is up.
Note:
This message is not translated to other languages, because system monitoring tools may need to byte-compare this string.If Oracle Secure Enterprise Search is not available, then the URL returns either a connection error or the HTTP error code 503.
To download free release notes, installation documentation, white papers, or other collateral, visit Oracle Technology Network (OTN). You must register online before using OTN; registration is free and can be done at
http://www.oracle.com/technology/membership/
If you already have a user name and password for OTN, then you can go directly to the documentation section of OTN at
http://www.oracle.com/technology/documentation
If you purchased Oracle Product Support, you can call Oracle Support Services for assistance. Oracle Support Services include phone assistance, version updates, and access to our service offerings. You have access to phone support 24 hours a day, 7 days a week. In the U.S.A., you can call Product Support at 1-800-223-1711.
Make sure you have your CSI (CPU Support Identifier) number ready when you call. Keep the CSI number for your records, because it is your key to Oracle Support Services. The Oracle Store sends the CSI number to you in an e-mail alert when it processes your order. If you do not have your CSI number and you are in the U.S.A., you can look up your CSI number by accessing our online Order Tracker, which provides detailed order information. Go to the Oracle Store and click on Order Tracker located above the top navigation bar.
For Oracle Support Services locations outside the U.S.A., call your local support center for information about how to access support. To find the local support center in your country, visit the Support Web Center at
At the Support Web Center you will find information on Oracle Support Services, such as:
Contact information
Instructions on how to access electronic services
Helpful Web sites
Support resources
Oracle Support Portfolio
Oracle Support Services news
With Oracle Product Support, you have round-the-clock access to OracleMetalink, the Oracle Support Services premier Web support offering. OracleMetalink offers you access to installation assistance, product documentation, and a technical solution knowledge base.
It has technical forums, where you can post questions about your Oracle products and receive answers from Oracle Technical Support Analysts and other Oracle users. The questions and answers remain posted for the benefit of all users.
OracleMetalink options include:
Service Request (SR) access
Patch downloads
Bug database query access
Product life-cycle information
You can access OracleMetalink at
Resource | Contact Information or Web Site |
---|---|
OracleMetalink | http://metalink.oracle.com |
Purchase additional products, full-use licenses, version updates, and documentation in the U.S.A. | http://oraclestore.oracle.com |
Access technical resources for developers | http://www.oracle.com/technology/index.html |
Access information about technical support | http://www.oracle.com/support |
Locate local Oracle Support Centers outside the U.S.A. | http://www.oracle.com/support |
Locate local Oracle offices outside the U.S.A | http://www.oracle.com/global/index.html |
Call Client Relations in the U.S.A. | 1-800-223-1711 |
Speak with your sales representative in the U.S.A. | 1-800-ORACLE-1 |
Obtain TTY access to technical support in the U.S.A. | 1-800-446-2398 |
Our goal is to make Oracle products, services, and supporting documentation accessible, with good usability, to the disabled community. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Accessibility standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For more information, visit the Oracle Accessibility Program Web site at
http://www.oracle.com/accessibility/
Accessibility of Code Examples in Documentation
Screen readers may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, some screen readers may not always read a line of text that consists solely of a bracket or brace.
Accessibility of Links to External Web Sites in Documentation
This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.
TTY Access to Oracle Support Services
Oracle provides dedicated Text Telephone (TTY) access to Oracle Support Services within the United States of America 24 hours a day, seven days a week. For TTY support, call 800.446.2398.
Oracle Secure Enterprise Search Installation Guide, 10g Release 1 (10.1.8) for Microsoft Windows (32-Bit)
B32263-01
Copyright © 2006, Oracle. All rights reserved.
The Programs (which include both the software and documentation) contain proprietary information; they are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright, patent, and other intellectual and industrial property laws. Reverse engineering, disassembly, or decompilation of the Programs, except to the extent required to obtain interoperability with other independently created software or as specified by law, is prohibited.
The information contained in this document is subject to change without notice. If you find any problems in the documentation, please report them to us in writing. This document is not warranted to be error-free. Except as may be expressly permitted in your license agreement for these Programs, no part of these Programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose.
If the Programs are delivered to the United States Government or anyone licensing or using the Programs on behalf of the United States Government, the following notice is applicable:
U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the Programs, including documentation and technical data, shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement, and, to the extent applicable, the additional rights set forth in FAR 52.227-19, Commercial Computer Software--Restricted Rights (June 1987). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.
The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup, redundancy and other measures to ensure the safe use of such applications if the Programs are used for such purposes, and we disclaim liability for any damages caused by such use of the Programs.
Oracle, JD Edwards, PeopleSoft, and Siebel are registered trademarks of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.
The Programs may provide links to Web sites and access to content, products, and services from third parties. Oracle is not responsible for the availability of, or any content provided on, third-party Web sites. You bear all risks associated with the use of such content. If you choose to purchase any products or services from a third party, the relationship is directly between you and the third party. Oracle is not responsible for: (a) the quality of third-party products or services; or (b) fulfilling any of the terms of the agreement with the third party, including delivery of products or services and warranty obligations related to purchased products or services. Oracle is not responsible for any loss or damage of any sort that you may incur from dealing with any third party.