About the location of Oracle SES 11g Release 1 (11.1.2.0.0) software

ORACLE_BASE is the root of the directory structure where Oracle SES software and its supporting infrastructure software are installed. This directory path is typically stored in an environment variable. On Linux and UNIX systems, you can reference the variable as $ORACLE_BASE. (On Windows, the equivalent is %ORACLE_BASE%.)

ORACLE_HOME refers to the path ORACLE_BASE/seshome. The path is typically stored in an environment variable. On Linux and UNIX systems, you can reference the variable as $ORACLE_HOME. (On Windows, the equivalent is %ORACLE_HOME%.)

In previous releases, the base path of Oracle SES was referred to as ORACLE_HOME. In Oracle SES release 11g, the base path is referred to as ORACLE_BASE. This represents the Software Location that you specify at the time of installing Oracle SES.

Therefore, for Oracle SES, ORACLE_HOME now refers to the path ORACLE_BASE/seshome.

There are many other directories (or folders) under ORACLE_BASE, which are created by the installation of Fusion Middleware components such as WebLogic. The most important directories for you to be aware of are:

wlserver. The WebLogic home.

Oracle_WC. A portlet or portal component.

oracle_common. The location of a set of Java Required Files.

Procedures for Logging In to the System as root

Before you install Oracle software, you must complete several tasks as the root user. For logging in as the root user, complete one of the following procedures:

A single Oracle Inventory group is required for all installations of Oracle software on the system. After the first installation of Oracle software, you must use the same Oracle Inventory group for subsequent Oracle software installations on that system.

Note:

As an alternative to creating local users and groups, you can create them in a directory service, for example, Network Information Services (NIS). Contact your system administrator, or refer to your operating system documentation for information about using directory services.

Oracle Inventory Group (oinstall)

You must create the Oracle Inventory group the first time you install Oracle software on the system. The usual name chosen for this group is oinstall. This group owns the Oracle inventory, which is a catalog of all Oracle software installed on the system. If Oracle software is already installed on the system, then the existing Oracle Inventory group must be the primary group of the oracle user. Oracle recommends that you use the group name oinstall for the Oracle Inventory group.

Oracle Software Owner (oracle)

You must create the Oracle software owner user the first time you install Oracle software on the system. The usual name chosen for this user is oracle. This user owns all of the software installed during a given installation. This user must have the Oracle Inventory group as its primary group.

In Oracle documentation, the Oracle software owner user is referred to as oracle.

Determining Oracle Inventory Group and Oracle Software Owner User

To determine whether the Oracle Inventory group and the Oracle software owner already exist, and if necessary, to create them, follow these steps:

When you install Oracle software on the system for the first time, Oracle Universal Installer creates the oraInst.loc file. This file identifies the name of the Oracle Inventory group and the path of the Oracle Inventory directory. To determine whether the oinstall group exists, enter the following command:

# more /var/opt/oracle/oraInst.loc

If the output of this command shows the oinstall group name, then the group already exists. For example, if the output is similar to the following, then oinstall already exists:

inventory_loc=/u01/app/oraInventory
inst_group=oinstall

The inst_group parameter shows the name of the Oracle Inventory group, oinstall.

If necessary, enter the following command to create the oinstall group:

/usr/sbin/groupadd oinstall

To determine whether the oracle user exists and belongs to the Oracle Inventory group, enter the following command:

# id -a oracle

If the oracle user exists, then this command displays information about the groups to which the user belongs. The output should be similar to the following, indicating that oinstall is the primary group:

uid=440(oracle) gid=200(oinstall) groups=201(dba),202(oper)

If the output includes a groups= clause, then it specifies secondary groups.

If necessary, complete one of the following actions:

If the oracle user exists, but its primary group is not oinstall, then enter the following command:

/usr/sbin/usermod -g oinstall oracle

If you wish, you can include the -G option to specify secondary groups:

/usr/sbin/usermod -g oinstall -G dba[,oper] oracle

If the oracle user exists, but you want to use another existing user as the Oracle software owner or you want to create a new Oracle software owner, then ensure that the user's primary group is the Oracle Inventory group.

Note:

You may need to contact your system administrator before using or modifying an existing user.

If the oracle user does not exist, then enter the following command to create it:

/usr/sbin/useradd -g oinstall oracle

This command creates the oracle user and specifies oinstall as the primary group. You can also include the -G option to specify secondary groups:

/usr/sbin/useradd -g oinstall -G dba[,oper] oracle

Enter the following command to set the password of the oracle user:

# passwd -r files oracle

Checking the Hardware Requirements

The number of CPUs on the server host will affect the performance of concurrent queries over a prolonged period of time. Oracle recommends that you use systems with two or more CPUs for production deployments that serve 1000 or more users.

Memory Requirements

The memory requirements are determined by the physical memory consumed by the database and by services such as the WebLogic server. The memory requirements for installing Oracle SES 11g Release 1 (11.1.2.0.0) are as follows:

At least 1 GB of RAM

To determine the physical RAM size, enter the following command:

# /usr/sbin/prtconf | grep "Memory size"

If the size of the physical RAM is less than the required size, then you must install more memory before continuing.

Available RAM and Swap Space Requirement

The following table describes the relationship between installed RAM and the configured swap space requirement:

Available RAM

Swap Space Required

Between 1024 MB and 2048 MB

1.5 times the size of RAM

Between 2049 MB and 8192 MB

Equal to the size of RAM

More than 8192 MB

0.75 times the size of RAM

To determine whether the system architecture can run the software, enter the following command:

# /bin/isainfo -kv

Note:

This command displays the processor type. Verify that the processor architecture matches the Oracle software release that you want to install. If you do not see the expected output, then you cannot install the software on this system.

To determine the size of the configured swap space, enter the following command:

# /usr/sbin/swap -s

If necessary, refer to the operating system documentation for information about how to configure additional swap space.

To determine the available RAM and swap space, enter the following command:

# sar -r i n

where, n is the number of seconds to delay for the next iterations and i is the number of iterations you want to test.

Checking the Software Requirements

A system must meet the minimum software requirements described in this section.

Package Requirements

The following are the list of packages required for Oracle SES 11.1.2.0.0:

If a package is not installed, then install it. Refer to your operating system or software documentation for information about installing packages.

Configuring Kernel Parameters

Verify that the kernel parameters shown in the following table are set to values greater than or equal to the minimum value shown on Oracle Solaris 9 operating systems. The procedure following the table describes how to verify and set the values.

Note:

The kernel parameter and shell limit values shown in the following section are minimum values only. For production database systems, Oracle recommends that you tune these values to optimize the performance of the system. Refer to your operating system documentation for more information about tuning kernel parameters.

Configuring Kernel Parameters On Oracle Solaris 9

On Oracle Solaris on SPARC (64-Bit) installations running Oracle Solaris 9, verify that the kernel parameters shown in the following table are set to values greater than or equal to the minimum value:

Parameter

Minimum Value

noexec_user_stack

1

semsys:seminfo_semmni

100

semsys:seminfo_semmns

1024

semsys:seminfo_semmsl

256

semsys:seminfo_semvmx

32767

shmsys:shminfo_shmmax

4294967296

shmsys:shminfo_shmmni

100

Use the following procedure to view the current value specified for resource controls, and to change them if necessary:

To display the current values of these parameters, enter the following commands:

Open the /etc/system file in any text editor and, if necessary, add lines similar to the following (edit the lines if the file already contains them):

set noexec_user_stack=1
set semsys:seminfo_semmni=100
set semsys:seminfo_semmns=1024
set semsys:seminfo_semmsl=256
set semsys:seminfo_semvmx=32767
set shmsys:shminfo_shmmax=4294967296
set shmsys:shminfo_shmmni=100

Enter the following command to restart the system:

# /usr/sbin/reboot

When the system restarts, log in and switch user to root.

Repeat this procedure on all other nodes in the cluster.

Configuring Kernel Parameters On Oracle Solaris 10

On Oracle Solaris 10, verify that the kernel parameters shown in the following table are set to values greater than or equal to the minimum value shown. The table also contains the resource controls that replace the /etc/system file for a specific kernel parameter. As Oracle SES does not set project information when starting proceses, some /etc/system processes that are deprecated but not removed must still be set for Oracle SES.

Note:

In Oracle Solaris 10, you are not required to make changes to the /etc/system file to implement the System V IPC. Oracle Solaris 10 uses the resource control facility for its implementation. However, Oracle recommends that you set both resource control and /etc/system/ parameters. Operating system parameters not replaced by resource controls continue to affect performance and security on Oracle Solaris 10 systems. For further information, contact your Sun vendor.

Parameter

Replaced by Resource Control

Minimum Value

noexec_user_stack

NA

1

semsys:seminfo_semmni

project.max-sem-ids

100

semsys:seminfo_semmns

NA

1024

semsys:seminfo_semmsl

process.max-sem-nsems

256

semsys:seminfo_semvmx

NA

32767

shmsys:shminfo_shmmax

project.max-shm-memory

4294967296

shmsys:shminfo_shmmni

project.max-shm-ids

100

On Oracle Solaris 10, use the following procedure to display the current value specified for resource controls, and to change them if necessary:

To display the current values of the resource control, enter the following commands:

When you use the prctl command (Resource Control) to change system parameters, you do not need to restart the system for these parameter changes to take effect. However, the changed parameters do not persist after a system restart.

Use the following procedure to modify the resource control project settings, so that they persist after a system restart:

By default, Oracle instances are run as the oracle user of the dba group. A project with the name group.dba is created to serve as the default project for the oracle user. Run the command id to verify the default project for the oracle user:

Installing on a Port Number Less Than 1024

During installation of Oracle SES, you specify a middle tier port number. This number is included in the URL for accessing Oracle SES. For example, if you specify 7777 as the port number, then the search URL will look like this:

http://<example.com.com>:7777/search/query/search.jsp

If you wish to hide the port number in the search URL, then the port must be set to 80, which is the default port for HTTP connections. For example, if you change the middle tier port shown in the previous example to 80, then the search URL does not need to include the port number as shown in the following example:

Checking the Oracle Base Directory

The Oracle home directory is generally a subdirectory of the Oracle base directory. Before installing Oracle SES, check to see if the ORACLE_BASE environment variable is set. If it is set, then ensure that you have write permission to that location. ORACLE_BASE should not reside within another user's directory structure.

Setting the Correct Locale

The correct environment parameters (LANG, NLS_LANG and LC_ALL) should be set before Oracle SES is installed. For file sources to successfully crawl and display multibyte environments, the locale of the system that starts the Oracle SES server must be the same as the target file system. This way, the Oracle SES crawler can "see" the multibyte files and paths. If the locale is different in the installation environment, then Oracle SES needs to be restarted from the environment with the correct locale. For example, for a Korean environment: Either set LC_ALL to ko_KR, or set both LC_LANG and LANG to ko_KR.KSC5601, then run searchctl restartall from an xterm. The command searchctl restartall will take about two and one half minutes to complete. This is because of the midtier start and stop logic, and because of the WebLogic node manager and domain server, all of which are new in this release.

Installation Tasks

Oracle SES is provided through electronic download (preferred) or on physical media. Either way, the installable product image is the same.

To obtain the software and start the installer

Ensure that you have checked all the minimum requirements, as described in "Preinstallation Tasks" of this document.

Log on to the system on which you are performing the installation as the user who will install Oracle SES. Oracle SES must be installed by a non-root user.

Download the Oracle SES software distribution.

Note:

If you received the software for this release on DVD, then mount the DVD on your system as you normally would and continue with these procedures. (The DVD contains the same archives as available for electronic download.)

Unzip the Oracle SES software.

There will be more than one zip archive, typically two.

After you download each archive, extract all from each zip archive into the same destination directory. Preserve the path information when you extract the zip files.

Change to the directory into which you unzipped the zip archives.

Start Oracle Universal Installer from your system prompt with the following command:

Oracle Universal Installer provides the Specify Installation Details page for setting parameters for the location and home for Oracle SES. You must specify the administrative password. The remaining values are set to a default, but they can be overridden.

Search Server Name: Name for your search server. To connect multiple Oracle SES instances to the same directory (authorization) server, each instance must have a distinct name.

Administrative Password and Confirm Password: The password that you will later use to log on to the Oracle SES administration tool. This password must be at least eight characters long with at least one alpha character and one number.

HTTP Port: The port on which the Oracle SES middle tier will listen. For example, if you install Oracle SES on host example.com and you specify port 7777, then your search page URL will be as follows:

Data Storage Location: The default is ORACLE_BASE/oradata. This is the location where Oracle SES will store its data. The data storage location should not be within the Oracle SES software installation directory. Data storage should be outside of the ORACLE_BASE/seshome directory so that it will not be deleted during a future upgrade.

The following URLs indicate a successful installation:

Search application: http://host:port/search/query/search

Administration tool: http://host:port/search/admin/index.jsp (Log on using the password specified during installation.)

Mounting Disks

On most Oracle Solaris systems, the disk mounts automatically when you insert it into the installation media. If the disk does not mount automatically, then follow these steps to mount it:

Switch user to root:

$ sudo sh
password:

If necessary, enter the following command to eject the currently mounted disc, then remove it from the drive:

# eject

Insert the appropriate disc into the disc drive.

To verify that the disc mounted automatically, enter the following command:

# ls /dvd/dvd0

If this command fails to display the contents of the disc, enter a command similar to the following to mount it:

# /usr/sbin/mount -r -F hsfs /dev/dsk/cxtydzs2 /dvd

In this example, /dvd is the disc mount point directory and /dev/dsk/cxtydzs2 is the device name for the disc device, for example /dev/dsk/c0t2d0s2.

If Oracle Universal Installer is displaying the Disk Location dialog box, enter the disc mount point directory path, for example:

Disc mounted automatically:

/dvd/dvd0

Disc mounted manually:

/dvd

Installing on a System with an Existing Oracle SES Installation

You can install this release (or previous releases) of Oracle SES more than once on the same system as long as each installation is installed in a separate Oracle home. Follow the procedures under Performing a Fresh Installation for Oracle SES. Use different values for Search Server Name, HTTP Port, and Software Location parameters.

Silent Installation Tasks

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 the same installation parameters on more than one computer. Additionally, you can use silent installation from the command line to push the installation of Oracle SES from a remote location to various computers in the organization.

The SES Home Location for Oracle SES software is $ORACLE_BASE/seshome. Do not specify Oracle home as the location of Oracle SES. However, the silent response file must also ask for ORACLE_HOME to support the current OUI architecture.

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. Response files like (server.rsp) are located in the /response directory of the Oracle SES product image. Edit the response file according to your requirements for silent installation.

To use a response file, you must first extract server.rsp to your system from the Oracle SES tar or zip archive that comprises the software distribution for this release. There may be two compressed archives and you may need to look in each to find the /response directory. For example:

Response files like server.rsp are located in the /response directory of the Oracle SES product image.

Editing the Response File

Use any text editor to edit the response file to include information specific to 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.

The values that are given as <ValueRequired> must be specified for silent installation.

Specifying ORACLE_HOME Properly in Response Files

You must ask for ORACLE_HOME in the silent response file due to the current OUI release 11.1 architecture. Therefore, you have to ask for both ORACLE_HOME and ORACLE_BASE. This is different from GUI behavior where you only need to ask for ORACLE_BASE (Software Location).

If you do not ask for both Oracle homes in the response file, then at install time users will need to make sure to input ORACLE_HOME as ORACLE_BASE + /seshome manually. An error pops up if users do not specify ORACLE_HOME properly.

The explanation for this is in the comment section of the response file examples.

Specifying a Response File and Starting the Installation

Before you specify a response file, ensure that all 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 as follows:

./runInstaller -silent -responseFile absolute_path_and_filename

Caution:

During installation, response files may be copied to subdirectories in the Oracle home. Oracle recommends that you do not hard-code passwords and confidential information in your response files. You should prompt the user to enter passwords and anything confidential or that might pose a security risk.

If you must provide passwords or other sensitive information in your response files, then for security purposes, delete them after completing and verifying the installation.

Silent Installation Log Files

The success or failure of silent installations is logged in the installActions.log file. Additionally, the silent installation creates the silentInstall.log file. The log files are created in the /oraInventory/logs directory. The silentInstallDate_Time.log file contains the following line if the installation was successful:

Security Tips for Silent Installations

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

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, then the installation will fail.

Postinstallation Tasks

This section describes the tasks to perform after installing Oracle SES and contains the following topics:

Check for Critical Patches

After installing Oracle SES, check for a patch set or critical patch update (CPU). A CPU is a collection of patches for security vulnerabilities. It also includes non-security fixes required (because of interdependencies) by those security patches. CPUs are cumulative, and they are provided quarterly on Oracle Technology Network. For more information about CPUs, see https://support.oracle.com

Deinstallation Tasks

This section provides the procedure for deinstalling Oracle SES. Deinstallation of Oracle SES removes the contents of the oradata directory. Refer also to "Removing the Oracle SES 10g Home" in this document.

To deinstall Oracle SES

Connect as the Oracle SES installation user.

Shut down the middle tier and the database.

$ORACLE_HOME/bin/searchctl stopall

Run the deinstallation script as follows:

$ORACLE_HOME/install/deinstall_ses

If the Oracle SES instance was bound to a port less than 1024 and the middle tier ran as the root user, then after deinstallation there could be files left under $ORACLE_HOME. After the deinstall completes, log on as the root user and delete those remaining files.

Upgrading Oracle Secure Enterprise Search

This section provides the information and procedures for upgrading from a previous release of Oracle SES to Oracle Secure Enterprise Search 11g Release 1 (11.1.2.0.0). Also discussed are preupgrade and postupgrade tasks.

Note:

If you are running a release of Oracle SES earlier than 10.1.8.4.0, then you must first upgrade to release 10.1.8.4.0.

For index optimization, this release sets smart defaults for clean installations. Since the user setting for upgrade scenarios cannot be modified, Oracle SES preserves the default settings in release 10g for the upgrade process.

After you upgrade to this release, the two identity plug-ins Oracle E-Business Suite release 11i and Oracle E-Business Suite release 12 are consolidated into one identity plug-in named Oracle E-Business Suite. Similarly, the two source types Oracle E-Business Suite 11i and Oracle E-Business Suite release 12 are consolidated into one source type named Oracle E-Business Suite.

Confirm that Free Memory and Disk Space Requirements are Met

Before performing the upgrade tasks for this release of Oracle SES, at least 2 GB of free RAM and 10 GB of free disk space must be available on the system.

Note:

Depending on the number of documents to process and how many custom attributes are meta-tagged, extra space might be needed.

Apply Mandatory One-Off Patches

The patches described in this section are required before performing the upgrade tasks.

Apply patch 5632264 to the Oracle SES 10.1.8.4.0 instance. Patch 5632264 updates the database time zone files to version 4. The timezone files for Oracle Database 11g must be version 4 or greater. After applying the patch, you must restart the Oracle SES 10.1.8.4.0 instance before upgrading to 11g Release 1 (11.1.2.0.0). Patch 5632264 is available on My Oracle Support (formerly OracleMetaLink) at https://support.oracle.com.

Important:

If the required one-off patches are not applied to the Oracle SES 10.1.8.4.0 instance, then the Oracle SES 11.1.2.0.0 upgrade will fail during Oracle Search Upgrade Assistant with the following error:

Upgrade OracleAS Portal Server (Optional)

If you are using the portlet feature in Oracle SES Release 10.1.8.4.0, then you must upgrade to OracleAS Portal Server 10.1.4.2.0, and apply Patch Set Exception (PSE) 7560661 to OracleAS Portal Release 10.1.4.2.0.

Common Preupgrade Tasks

This section contains information and procedures for preupgrade tasks for all upgrades from previous releases of Oracle SES.

Setting JOB_QUEUE_PROCESSES To Zero

During upgrading of Oracle SES, scheduled jobs should not be started, and crawl and optimization processes should not be running in the background. To prevent scheduled jobs from executing, set the JOB_QUEUE_PROCESSES parameter to 0.

To set the JOB_QUEUE_PROCESSES parameter to 0

Start SQL*Plus and connect as the EQSYS user.

Check the current value of JOB_QUEUE_PROCESSES, so that you can later restore it. By default, JOB_QUEUE_PROCESSES is 10, but it may be set differently in this database. Execute this query to obtain the value of JOB_QUEUE_PROCESSES.

Ensuring Adequate Disk Space and Optimizing Indexes

You must confirm that multiple factors of free space are available prior to performing the upgrade processes. In addition to the disk space required for a second installation, you will need sufficient resources for postupgrade index migration and other space-intensive reconfiguration. To maximize performance, you can optimize indexes and reduce fragmentation to near 0% before upgrading.

Ensuring Adequate Memory

When upgrading, if you have changed the SGA size manually, then follow the steps in this section to confirm that Oracle SES has enough memory.

Note:

You must allocate at least 2GB free memory for upgrading to Oracle SES release 11.1.2.

To confirm that available memory for Oracle SES meets the requirements

Verify that Automatic Shared Memory Management is turned on by confirming that SGA_TARGET is greater than 0. If SGA_TARGET is set to 0, then you must restore the value to the original (which is smaller one either 40% of the physical memory size or 1536M). If you change the SGA_TARGET parameter value, then restart Oracle SES to reflect the change and to check if the Oracle SES instance can be started without any problem.

SGA_TARGET specifies the total size of all SGA components. If SGA_TARGET is specified as a number greater than zero, then several of the memory pools in the SGA are automatically sized. If any of those automatically tuned memory pools are individually set to nonzero values, then those values are used as minimum levels by Automatic Shared Memory Management. Other memory pools are not affected by Automatic Shared Memory Management.

Upgrading Oracle Single Sign-On Server (Optional)

If you previously configured Oracle SES release 10.1.8.4.0 with Oracle Single Sign-On, then you must upgrade to Oracle Single Sign-On 10.1.4.0.1 before you upgrade to Oracle SES release 11.1.2. After you complete the upgrade procedures for Oracle SES 11.1.2, you will need to reconfigure Oracle SES with Single Sign-On server. Schedule downtime accordingly during the upgrade process.

Upgrading Oracle HTTP Server (Optional)

If you have enabled Oracle Single Sign-On for Oracle SES release 10.1.8.4.0, then ensure that the Oracle HTTP server is release 10.1.3 or 11g.

If you have enabled SSL for Oracle SES release 10.1.8.4.0, then ensure the Oracle HTTP server is release 11g.

Upgrading on a Port Number Less than 1024

This step is only necessary if the release of Oracle SES that you are upgrading is bound to a port number less than 1024. You must change the port to a number greater than or equal to 1024 before starting the upgrade. After the upgrade completes, you can change the port back to a number less than 1024. Follow the instructions in "Changing the Oracle SES Middle Tier Port (Optional)" in this document.

Upgrade Tasks

This section contains the procedures for upgrading Oracle SES to release 11.1.2.0.0.

When the installation process detects the existing Oracle SES instance on the computer, it will give you the option of either upgrading the existing installation or creating a fresh installation.

Choose to upgrade the existing installation.

Follow the prompts to select:

The location where the Oracle SES 10.1.8.4.0 software is installed

The administrative password that was set in the Oracle SES 10.1.8.4 installation

The location where the new Oracle SES 11.1.2.0.0 software will be installed. This location must be different from the release 10.1.8.4.0 location. You cannot install Oracle SES 11g Release 1 (11.1.2.0.0) inside the Oracle home for Oracle SES release 10.1.8.4.0.

Restoring Oracle SES If Upgrading Fails

If the upgrade fails, then restore the previous Oracle SES release from your backup.

To restore Oracle SES from backup using the tar command

Delete the Oracle home, oradata, and oraInventory directories.

If you are not already logged in as root, then enter the following command to become the root user:

su - root

Execute the following commands using the full path to the Oracle SES release 10.1.8.4.0 home:

tar xvf ses_orahome.tar
tar xvf ses_orainv.tar
tar xvf ses_oradat.tar

After restoring the previous release, you can retry the Oracle SES upgrade.

Note:

If you use zip instead of tar for the backup, then create separate archives for Oracle home, inventory, and data directories.

Silent Upgrade Tasks

A silent upgrade has no graphical output and no input by the user. To perform a silent upgrade, you provide Oracle Universal Installer with a response file and specify the -silent flag on the command line. Response files are located in the /response directory of the Oracle SES software distribution. You must edit the response file according to your upgrade requirements.

To use a response file

Go to the /response directory.

Copy the upgrade.rsp file to your system hard drive. For example:

cp upgrade.rsp /private/ses/response/upgrade.rsp

Using any text editor, replace each variable in the response file with the value specific to your system. The variables are clearly marked with the text <ValueRequired>. Each variable has an associated comment that identifies the variable type. For example:

During upgrade, response files may be copied to subdirectories in the Oracle home directory. If you provided passwords or other sensitive information in your response files, then delete any copies of the response files that remain in your file system.

Postupgrade Tasks

This section describes the procedures that must be performed after the upgrade process completes.

The script enable_SES1112_improve.sql must be executed immediately after the Oracle SES upgrade is completed. Do not start a crawl or an optimization before enable_SES1112_improve.sql completes.

The Data Storage Location specified in Oracle SES installation is shared by the previous Oracle SES release from which you are upgrading. For example, the 10.1.8.4.0 and 11.1.2.0.0 releases of Oracle SES use the same data storage area. If this data storage directory is inside the release 10.1.8.4.0 Oracle home, then be very careful nottoremove this directory after upgrading to release 11.1.2.0.0.

If index migration is interrupted and fails to complete, then Searchable Content Stats will be inaccurate. Failed or abandoned attempts to migrate an index and its data will result in inaccurate reporting about what is available for search in the Oracle SES instance. In this case, this is expected behavior until a proper cleanup is performed with eq_idx_mig.cleanup. See Oracle Secure Enterprise Search Administrator's Guide for procedures.

Running Postupgrade Migration Scripts

Oracle SES 11g Release 1 (11.1.2.0.0) introduces new features that provide search performance improvements. These features are incorporated automatically in fresh installations of Oracle SES. To incorporate these features in Oracle SES after upgrading, you must run the following scripts:

enable_SES1112_improve.sql to activate performance enhancements in the new release. You must run this script with administrator privileges after upgrading to Oracle SES 11g Release 1 (11.1.2.0.0). See the section "enable_SES1112_improve.sql" for more information.

(Optional) enable_Japanese_bigram.sql to activate search performance enhancements for Japanese text. You only need to run this script if your Oracle SES includes Japanese text, or if you anticipate future searches of Japanese text. See "enable_Japanese_bigram.sql" for more information.

enable_SES1112_improve.sql may take several hours to run, depending on the size of the index, number of documents to be indexed, and the number of custom attributes. Also, the enable_SES1112_improve.sql script generates log files enable_bigio.log and zone_to_field.log under the $ORACLE_HOME/ctx/log directory. First, enable_bigio.log is generated, and then zone_to_field.log is generated.

Important:

The enable_SES1112_improve.sql script has significant disk space requirements. You may need to allocate additional tablelspace before you run the script. The script will give you a warning message if there is not enough free space. At that point, you can cancel, allocate additional space, and rerun the script. If there is insufficient temporary tablespace, the script will display an error message. If this should occur, you should add a temp file to OES_TEMP tablespace and rerun the script. To add a temp file to OES_TEMP tablespace:

enable_Japanese_bigram.sql

This script enables bi-gram token generation for Japanese text. Bi-gram lexing improves the performance of Japanese document indexing. If there is no Japanese text in your SES instance, or if cache files are not preserved, the script updates index metadata to use the bi-gram lexer for future Japanese indexing.

Important:

The enable_Japanese_bigram.sql script will re-index Japanese documents only if cache files are preserved. Before running this script, you should ensure that cache files exist for all crawled Japanese documents and that the "clear cached files after indexing" crawling option is disabled. If cache files are not preserved and there are Japanese documents in your SES instance, you must run a full recrawl after the script completes. Otherwise Japanese search will not work. The script will list all the data sources that need a full crawl. Please run a full crawl for these data sources. At the end of the script, you may be advised to check the CTXSYS.CTX_INDEX_ERRORS view to see if indexing encountered any errors. If some of your documents do not have cached files, then indexing raises ORA-22288 and the error is logged in the view. However, you can ignore the error because these data sources need to be crawled again.

To run enable_Japanese_bigram.sql

Ensure that JOB_QUEUE_PROCESSES is set to 0, as described in "Preupgrade Tasks" in this document.

Start SQL*Plus as the EQSYS user.

Run $ORACLE_HOME/search/admin/scripts/enable_Japanese_bigram.sql

The script will check if all the cached files exist for crawled Japanese documents. If there are missing files, enable_Japanese_bigram.sql will show a warning message that displays the number of missing cached files. If you choose to proceed, enable_Japanese_bigram.sql will re-index the cached files only. You cannot search Japanese documents while enable_Japanese_bigram.sql is running.

Restoring JOB_QUEUE_PROCESSES

To prepare for the upgrade process, the JOB_QUEUE_PROCESSES parameter was set to 0 prior to the upgrade. After you run the migration scripts, as described in "Running Postupgrade Migration Scripts", you must restore the original value of the JOB_QUEUE_PROCESSES parameter. (You will need the original value of this parameter that existed before the preupgrade steps in order to complete this procedure.)

To reset the JOB_QUEUE_PROCESSES parameter

Start SQL*Plus and connect as the EQSYS user.

Execute the following SQL statement, and specify the original value of JOB_QUEUE_PROCESSES for n.

SQL> ALTER SYSTEM SET job_queue_processes=n scope=both;

Note:

If you do not restore JOB_QUEUE_PROCESSES after running the postupgrade scripts, crawling and optimization will fail.

Updating Configure Search Results List for CSS and XSLT (Optional)

This section describes how to modify your custom CSS and XSLT if you made changes in Oracle SES release 10.1.8.4.

In Advanced Configuration under Global Settings and then Configure Search Results List, the default CSS now includes the CSS classname ses-results-list at the beginning of each selector.

Note that in the following examples the dot (.) before a name denotes a class selector in CSS syntax.

To update CSS that has been previously customized in an earlier release of Oracle SES:

Prepend the class ses-results-list to the beginning of each selector.

For example, if a previously customized CSS rule uses two selectors as in this example:

.infoSrcGroup,
.infoSrcPath
{
font-size: 12pt;
}

then each selector should have .ses-results-list prepended as follows:

Configuring Secure Sockets Layer for Oracle SES (Optional)

When Oracle SES is fronted by an Oracle HTTP Server, Oracle recommends that Oracle SES be configured to require Secure Sockets Layer (SSL) with client-side authentication for communication with the Oracle HTTP Server. If you have configured SSL for Oracle SES release 10.1.8.4, then you must manually reconfigure SSL for Oracle Secure Enterprise Search 11g Release 1 (11.1.2.0.0). You configure SSL through the admin console in WebLogic. The steps for configuring SSL are described in Oracle Secure Enterprise Search Administrator's Guide.

After upgrading, you must manually reconfigure SSO for Oracle Secure Enterprise Search 11g Release 1 (11.1.2.0.0). You configure SSO through the admin console in WebLogic. The steps for configuring SSO are described in Oracle Secure Enterprise Search Administrator's Guide.

Migrating to Secure Cache

In Oracle SES release 10g, the document cache is stored in plain text in disk files managed by the operating system. In Oracle SES release 11g, the cache files are stored as LOBs within Oracle Database in the Secure Cache storage area. (One exception is the Mailing List data source, which still uses storage managed by the operating system.)

Important:

The Mailing List data source uses storage on the operating system. Therefore, all new Mailing List sources must use the same cache location as the default parent Mailing List source.

The default location of the Secure Cache is the OES_ASSM2 tablespace. When you upgrade to Oracle SES 11g, the cache files for data sources created in Oracle SES 10g are not automatically migrated to the Secure Cache. Oracle SES continues to store the cache for earlier data sources within the file system, but uses the Secure Cache for all new data sources. To migrate Oracle SES 10g data sources to the Secure Cache, you must run several migration routines. The migration process works on one data source at a time. During migration, crawling operations are suspended, but query services are uninterrupted. When migration is complete, the cache files for the data source are deleted from the file system.

To migrate to Secure Cache

You can use the GET_CACHE_LOCATION function to determine which data sources are cached in the file system and which are cached in the database Secure Cache. The function returns the cache location for a given data source. Supply the numeric identifier of the data source as an argument.

return_value := EQ_CACHE.GET_CACHE_LOCATION(dsid)

The return values of EQ_CACHE.GET_CACHE_LOCATION are:

Return Value (VARCHAR2)

Description

OS

The cache for this data source is in the file system.

DB

The cache for this data source is in the database Secure Cache.

Execute the EQ_CACHE.PREPARE_MIGRATION procedure to set up a migration status tracking table. This procedure only needs to be called once for all cache migrations. You can query the migration status table to find the status of cache migration. The migration status table is described in Table 1, "EQ$CACHE_MIGRATION Migration Status Table" in this document.

Stop the schedule for the data source you want to migrate.

Execute the MIGRATE_TO_SECURE_CACHE function to migrate a data source. Supply the numeric identifier of the data source as an argument.

return_value := EQ_CACHE.MIGRATE_TO_SECURE_CACHE (dsid)

The return values of EQ_CACHE.MIGRATE_TO_SECURE_CACHE are:

Return Value (NUMBER)

Description

0

The migration was successful.

1

This data source has already been migrated. No action is taken.

2

The schedule is running for this data source. No action is taken.

Repeat steps 3 and 4 for each data source that was created before you upgraded to this release of Oracle SES.

When all data sources have been migrated, run the CLEANUP_MIGRATION procedure to drop the status tracking table for cache migration.

The Migration Status Table

The EQ_CACHE.PREPARE_MIGRATION procedure creates a table called eq$cache_migration, which contains status information about the migration process. The columns of the table are described in Table 1.

Removing the Oracle SES 10g Home

After you have verified that the upgraded Oracle SES release 11g instance is working, you may remove the Oracle SES release 10g home.

To remove the Oracle SES 10g home

If oradata is not within the Oracle SES 10g home:

Go to the Oracle SES 11g home and shut down the Oracle SES instance (to facilitate the execution of the deinstallation script).

Go to the Oracle SES 10g home and run the deinstall_ses script in the install directory.

If oradata is within the Oracle SES 10g home:

Go to the Oracle SES 10g home and enter this command from the oui/bin directory:

runInstaller -detachHome $ORACLE_HOME=your_SES_10g_ORACLE_Home

Run an operating system command to remove all the directories from the Oracle SES 10g home except for the path that holds oradata.

Important:

If oradata is located under the Oracle SES 10g home, then you should not remove the 10g home. Even after upgrade, the location of oradata does not change.

Starting and Stopping Oracle Secure Enterprise Search

The command for starting and stopping the search engine in Oracle SES is searchctl. The executable is located in the $ORACLE_HOME/bin directory:

$ORACLE_HOME/bin/searchctl

The command syntax is as follows.

Command

Description

searchctl start

Start Oracle SES middle tier

searchctl startall

Start Oracle SES middle tier and database

searchctl stop

Shut down Oracle SES middle tier

searchctl stopall

Shut down Oracle SES middle tier and database

searchctl restart

Restart Oracle SES middle tier

searchctl restartall

Restart Oracle SES middle tier and database

On Linux and UNIX platforms, you must supply the Oracle SES administrative password when running searchctl commands. If you have shut down both the database and the middle tier with the searchctl stopall command, then to successfully start them both, run searchctl startall. If the Middle Tier Port is less than 1024, then the following commands must be run by the root user:

searchctl start/stop

searchctl startall

searchctl stopall

searchctl restartall

Note:

The root user must belong to the DBA group to properly run the searchctl startall/stopall/restartall command.

What To Do Next

To become familiar with Oracle Secure Enterprise Search, Oracle suggests that you complete the following tasks:

Log on to the Oracle SES administration tool using the user name and password set in the installation. Click the Help link in the top right corner of any page in the administration tool for context-sensitive help. 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

In a production environment, where a load balancer or other monitoring tools are used, Oracle SES can also be 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. If Oracle Secure Enterprise Search is not available, then the URL returns either a connection error or the HTTP error code 503.

Additional Resources

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 for OTN is free and can be done at

Oracle Support Services

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 My Oracle Support (formerly OracleMetaLink), the Oracle Support Services Premier Web Support offering. My Oracle Support (formerly 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.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.

Scripting on this page enhances content navigation, but does not change the content in any way.