Skip Headers
Oracle® Secure Enterprise Search Installation and Upgrade Guide
11g Release 2 (11.2.2.2) for IBM AIX on POWER Systems (64-Bit)

E35068-07
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

  PDF · Mobi · ePub

Oracle® Secure Enterprise Search

Installation and Upgrade Guide

11g Release 2 (11.2.2.2) for IBM AIX on POWER Systems (64-Bit)

E35068-07

September 2014

This document describes how to install or upgrade to Oracle Secure Enterprise Search (Oracle SES) 11g Release 2 (11.2.2.2).

This document contains the following sections:

Installing Oracle SES

This section provides the information and procedures for performing an installation of Oracle SES. This section contains the following topics:

Preinstallation Tasks

This section describes the requirements and tasks to complete before installing Oracle SES and contains the following topics:

For additional preinstallation tips, see the following Oracle SES tutorial:

http://www.oracle.com/pls/topic/lookup?ctx=E35215-01&id=tut_ses_administration

Oracle SES AIX Certifications

Oracle SES is certified to run on the following AIX operating systems:

  • AIX 6.1 TL 02 SP1 ("6100-02-01), 64-bit kernel

  • AIX 7.1 TL 0 SP1 ("7100-00-01-1037"), 64-bit kernel

Oracle SES Browser Support

The Oracle SES administration application and the default query application support the following browsers:

  • Firefox 3.x and later

  • Internet Explorer 7.x and later

  • Safari 4.x and later

General Information and Requirements for Installing Oracle Software

This section describes the general requirements for installing Oracle SES 11.2.2.2 software and contains these sections:

Oracle SES Installation Modes

Oracle SES 11.2.2.2 software can be installed in one of the following three modes:

Note:

  • Oracle SES 11.2.2.2 supports only Oracle Database 11.2.0.3.x and 11.2.0.4.x (Enterprise Edition) as database server and WebLogic Server 10.3.6.0.x as middle tier server because Oracle SES depends on certain features that are only provided by these software products.

  • Oracle SES support for Oracle Database 11.2.0.3.x ends in February 2015, so you must upgrade to Oracle Database 11.2.0.4.0 before the support ends for Oracle Database 11.2.0.3.x. Refer to the Oracle SES Release Notes section "Mandatory Upgrade to Oracle Database 11.2.0.4.0" for the steps to upgrade from Oracle Database 11.2.0.3.x to Oracle Database 11.2.0.4.0.

Procedure for Logging in to the System as the root User

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

Note:

Unless you intend to complete a silent installation, you must install the software from an X Window System workstation, an X terminal, or a PC or other system with X server software installed.

Install the Software from an X Window System Workstation or X Terminal

  1. Start a local terminal session, for example, an X terminal (xterm).

  2. If you are not installing the software on the local system, then enter the following command to enable the remote host to display X applications on the local X server:

    xhost fully_qualified_remote_host_name
    

    For example:

    xhost somehost.us.example.com
    
  3. If you are not installing the software on the local system, then use the ssh, rlogin, or telnet command to connect to the system on which you want to install the software:

    telnet full_qualified_remote_host_name
    
  4. If you are not logged in as the root user, then enter the following command to switch user to root:

    su - root
    

Install the Software from a PC or Other System with X Server Software

  1. Start the X server software.

  2. Configure the security settings of the X server software to permit remote hosts to display X applications on the local system.

  3. Connect to the remote system on which you want to install the software and start a terminal session on that system, for example, an X terminal (xterm).

  4. If you are not logged in as the root user on the remote system, then enter the following command to switch user to root:

    su - root
    
Creating Required Operating System Group and User

Depending on if this is the first time Oracle software is being installed on this system and on the products that you are installing, you may need to create the following group and user account:

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 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 exist, and if necessary, to create them, follow the procedure in this section.

To check if oinstall group exists 

  1. 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 /etc/oraInst.loc
    

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

    inventory_loc=/u01/app/oraInventory
    inst_group=oinstall
    

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

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

    1. Enter the following command:

      # smit security
      
    2. Choose the appropriate menu items to create the Oracle Inventory (oinstall) group.

    3. Press F10 to exit.

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

    # id 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.

  4. If necessary, complete one of the following actions:

    • If the oracle user exists, but its primary group is not oinstall, then perform the following steps:

      • Enter the following command:

        # smit security
        
      • Choose the appropriate menu items to modify the oracle user.

      • In the Primary GROUP field, specify the Oracle Inventory group, for example oinstall.

      • In the Group SET field, specify the required secondary groups.

      • Press F10 to exit.

    • 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 create it as follows:

      • Enter the following command:

        # smit security
        
      • Choose the appropriate menu items to create the oracle user.

      • In the Primary GROUP field, specify the Oracle Inventory group, for example oinstall.

      • In the Group SET field, specify the required secondary groups, if any.

      • Press F10 to exit.

      • Set the password of the oracle user:

        # passwd oracle
        

Checking the Hardware Requirements

The system must meet the following minimum hardware requirements:

Note:

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

The memory requirement for installing Oracle SES 11.2.2.2 is as follows:

  • At least 3 GB of physical RAM, if you want to install Oracle SES software along with the Oracle Database and the WebLogic Server middle tier.

  • At least 2 GB of physical RAM if you want to install Oracle SES software on an existing Oracle Database or an existing WebLogic Server middle tier.

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

# /usr/sbin/lsattr -E -l sys0 -a realmem

If the size of the 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 2 GB and 16 GB Equal to the size of the RAM
More than 16 GB 16 GB

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

    # /usr/bin/getconf HARDWARE_BITMODE
    

    The expected output of this command is 64. If you do not see the expected output, then you cannot install the software on this system.

  • To determine if the system is started in 64-bit mode, enter the following command:

    # bootinfo -K
    

    The result of this command must be 64, indicating that the 64-bit kernel is enabled.

    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.

    Note:

    Oracle Secure Enterprise Search 11g Release 2 supports 64-bit kernel and does not provide support for 32-bit kernel applications.
  • To determine the size of the configured swap space, enter the following command:

    # /usr/sbin/lsps -a
    

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

Disk Space Requirement

The disk space requirement for installing Oracle SES software depends upon the Oracle SES installation mode that you select.

  • Oracle SES software installed along with the Oracle Database and the WebLogic Server middle tier, requires at least 15.5 GB of disk space.

  • Oracle SES software installed along with the WebLogic Server middle tier, on an existing Oracle Database, requires at least 5 GB of disk space.

  • Oracle SES software installed alone, on an existing WebLogic Server middle tier and an existing Oracle Database, requires at least 3 GB of disk space.

Redo Log File Size Requirement

When Oracle SES application is installed along with the Oracle Database and WebLogic Server middle tier, 200MB of disk space gets allocated for the redo log file. This redo log file size is sufficient to crawl up to 300GB of text.

If you are going to install Oracle SES application on an existing Oracle Database, then make sure that at least 200MB of disk space is allocated for the redo log file.

See Also:

Oracle Secure Enterprise Search Administrator's Guide for information about how to increase the redo log file size.
Additional Hardware Requirements

Additional hardware requirements are based on the amount of data that you expect to search.

For example, to index 100,000 documents:

  • 13 GB disk space

  • 4 GB RAM

To index 1,000,000 documents:

  • 38 GB disk space

  • 8 GB RAM

Note:

The above hardware requirements for the specific number of documents to index are based on an assumption that an average document size is 100KB and the documents to index contain a mix of various document types, such as, HTML, PDF, DOC, and PPT.

Checking the Software Requirements

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

Operating System and Browser Requirements

The operating system and browsers must be among those listed in "Oracle SES AIX Certifications" of this document.

Operating System Filesets

The following operating system filesets are required for AIX 6.1:

  • bos.adt.base

  • bos.adt.lib

  • bos.adt.libm

  • bos.perf.libperfstat 6.1.2.1 or later

  • bos.perf.perfstat

  • bos.perf.proctools

  • xlC.aix61.rte:10.1.0.0 or later

  • xlC.rte.10.1.0.0 or later

The following operating system filesets are required for AIX 7.1:

  • bos.adt.base

  • bos.adt.lib

  • bos.adt.libm

  • bos.perf.libperfstat

  • bos.perf.perfstat

  • bos.perf.proctools

  • xlC.aix61.rte.10.1.0.0 or later

  • xlC.rte.10.1.0.0 or later

  1. To determine the distribution and version of AIX installed, enter the following command:

    # oslevel -s
    

    For AIX 6.1: If the operating system version is lower than AIX 6.1 Technology Level 2 SP 1, then upgrade your operating system to this, or a later, level.

    For AIX 7.1: If the operating system version is lower than AIX 7.1 Technology Level 0 plus SP 1, then upgrade your operating system to this, or a later, level.

    AIX maintenance packages are available from the following Web site:

    http://www-933.ibm.com/support/fixcentral/

  2. To determine whether the required filesets are installed and committed, enter a command similar to the following:

    # lslpp -l bos.adt.base bos.adt.lib bos.adt.libm bos.perf.perfstat \
    bos.perf.libperfstat bos.perf.proctools
    
  3. To determine the supported kernel mode, enter a command similar to the following:

    # getconf KERNEL_BITMODE
    

    Note:

    • The expected output of this command is 64. If you do not see the expected output, then you cannot install the software on this system.

    • Oracle Secure Enterprise Search 11g Release 2 supports 64-bit kernel and does not provide support for 32-bit kernel applications.

Patch Requirements

The following, or later, patches are required for Oracle Secure Enterprise Search 11g Release 2 for AIX Based Systems:

Note:

  • AIX APAR numbers are tied to AIX versions and technology levels. Download and install the APAR that matches your AIX versions and Technology Levels from the IBM fix central web site at the following URL:

    http://www-933.ibm.com/support/fixcentral/

  • If you are using a later TL level than the minimum level listed for this release, then check with IBM to determine if the required APARs listed here are included in the TL level that you have on your system. If they are included, then you do not have to install them. If they are not included, then you must install the equivalent APAR for the appropriate TL level.

Installation Type or Product Requirement
All installations Authorized Problem Analysis Reports (APARs) for AIX 6.1:

If you are using the minimum operating system TL level for AIX 6.1 listed above, then install all AIX 6.1 Authorized Problem Analysis Reports (APARs) for AIX 6.1 TL 02 SP1, and the following AIX fixes:

  • IZ41855

  • IZ51456

  • IZ52319

  • IZ97457

  • IZ89165

These 6.1 fixes are present in the following TL levels:

  • AIX 6.1 TL-02 SP-04 and later

  • AIX 6.1 TL-03 SP-02 and later

  • AIX 6.1 TL-04

Authorized Problem Analysis Reports (APARs) for AIX 7.1:

If you are using the minimum operating system TL level for AIX 7.1 listed above, then install all AIX 7.1 Authorized Problem Analysis Reports (APARs) for AIX 7.1 TL 0 SP1, and the following AIX fixes:

  • IZ87216

  • IZ87564

  • IZ89165

  • IZ97035


The following procedure describes how to check these requirements:

  • To determine whether an APAR is installed, enter a command similar to the following:

    # /usr/sbin/instfix -i -k "IZ41855 IZ51456 IZ52319 IZ97457 IZ89165"
    

    If an APAR is not installed, then download it from the following Web site and install it:

    http://www-933.ibm.com/support/fixcentral/

Configure Shell Limits and System Configuration Parameters

Oracle recommends that you set shell limits and system configuration parameters as described in this section.

Note:

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

For AIX, it is the ulimit settings that determine process memory related resource limits. Verify that the shell limits displayed in the following table are set to the values shown:

Shell Limit (As Shown in smit) Recommended Value
Soft FILE size -1 (Unlimited)
Soft CPU time -1 (Unlimited)

Note: This is the default value.

Soft DATA segment -1 (Unlimited)
Soft STACK size -1 (Unlimited)
Soft Real Memory size -1 (Unlimited)
Processes (per user) -1 (Unlimited)

Note: This limit is available only in AIX 6.1 or later. Refer to "Configure System Configuration Parameters" for information on configuration of processes per user limits.


To view the current value specified for these shell limits, and to change them if necessary:

  1. Enter the following command:

    # smit chuser
    
  2. In the User NAME field, enter the user name of the Oracle software owner, for example oracle.

  3. Scroll down the list and verify that the value shown for the soft limits listed in the previous table is -1.

    If necessary, edit the existing value.

  4. When you have finished making changes, press F10 to exit.

Configure System Configuration Parameters

If you cannot use the Fixup scripts, then verify that the kernel parameters shown in the following table are set to values greater than or equal to the minimum value shown. If the current value for any parameter is greater than the value listed in this table, then the Fixup scripts do not change the value of that parameter.

Parameter Recommended Value
maxuprocs 16384
ncargs 128
tcp_ephemeral_low 32768
tcp_ephemeral_high 65535
udp_ephemeral_low 32768
udp_ephemeral_high 65535

The following procedure describes how to verify and set the values manually.

  • To verify that the maximum number of processes allowed per user is set to 16384 or greater, use the following steps:

    Note:

    For production systems, this value should be at least 128 plus the sum of the PROCESSES and PARALLEL_MAX_SERVERS initialization parameters for each database running on the system.
    1. Enter the following command:

      # smit chgsys
      
    2. Verify that the value shown for Maximum number of PROCESSES allowed per user is greater than or equal to 16384.

      If necessary, edit the existing value.

    3. When you have finished making changes, press F10 to exit.

  • To verify that long commands can be executed from shell, use the following steps:

    Note:

    Oracle recommends that you set the ncargs system attribute to a value greater than or equal to 128. The ncargs attribute determines the maximum number of values that can be passed as command line arguments.
    1. Enter the following command:

      # smit chgsys
      
    2. Verify that the value shown for ARG/ENV list size in 4K byte blocks is greater than or equal to 128.

      If necessary, edit the existing value.

    3. When you have finished making changes, press F10 to exit.

Running the rootpre.sh Script

Note:

Do not run the rootpre.sh script if you have software with version later than Oracle Secure Enterprise Search 11g Release 2 installed on this system.

Run the rootpre.sh script:

  1. Switch user to root:

    $ su -
    password:
    #
    
  2. Complete one of the following steps, depending on the location of the installation files:

    • If the installation files are on disc, enter a command similar to the following, where directory_path is the disc mount point directory or the path of the db directory on the DVD:

      # /directory_path/rootpre.sh 
      
    • If the installation files are on the hard disk, change the directory to the location where rootpre.sh exists and enter the following command:

      # ./rootpre.sh
      
  3. Exit from the root account:

    # exit
    

Installing Oracle SES on a Port Number less than 1024

During installation of Oracle SES, you specify a middle tier port number. This port number is included in the URL for accessing Oracle SES application (Oracle SES Administration application and Oracle SES Query application. Oracle SES Query application is also referred to as Search URL or Search application in this document). For example, if you specify 7777 as the port number, then the Search URL will look like this:

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

If you want 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:

http://example.com/search/query/search.jsp

On Linux and UNIX systems, only root users can bind to ports less than 1024. Since Oracle SES must be installed by a non-root user, you must install Oracle SES on port 1024 or higher and then change it later.

To change the port number later, after installation: 

  1. During installation, specify a port greater than or equal to 1024.

  2. After the installation is complete, follow the instructions in "(Optional) Changing the Oracle SES Middle Tier Port" to change the port to a number less than 1024.

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 crawl the multibyte files and paths. 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 restart the Oracle SES server instance.

Installing Mandatory Oracle Database Patches

If you are going to install Oracle SES 11.2.2.2 software on an existing Oracle Database 11.2.0.3.x or 11.2.0.4.x, then you must download the following patches from My Oracle Support Web site https://support.oracle.com and apply them over the existing Oracle Database instance before you proceed with the Oracle SES software installation.

Note:

These database patches are also available in the database_patches directory present under the top-level directory of the Oracle SES 11.2.2.2 software distribution.
  • Patches for Oracle Database 11.2.0.3.x: 13404129, 12985184, 14256211, 13366199, 19049016, 12401111, 16059292, 16272008, 12919564, and 18997672. If the existing database is an Oracle RAC Database, then apply the additional patches 16921832 and 13387392.

  • Patches for Oracle Database 11.2.0.4.x: 19238601, 13073613, and 19249319. Apply these patches using Oracle OPatch utility.

After applying all the database patches, run the following SQL command as the SYS user to recompile all the invalid database objects.

SQL> exec utl_recomp.recomp_serial('CTXSYS');

Installing Mandatory WebLogic Server Patches

If you are going to install Oracle SES 11.2.2.2 software on an existing WebLogic Server 10.3.6.0.x middle tier, then you must download the patch 13583235 from My Oracle Support Web site https://support.oracle.com and apply it over the existing WebLogic Server instance before you proceed with the Oracle SES software installation.

Note:

This WebLogic Server patch is also available in the weblogic_patches directory present under the top-level directory of the Oracle SES 11.2.2.2 software distribution.

Installation Tasks

This section contains the following topics:

For supplementary instructions on installing Oracle SES, see the Oracle SES tutorial:

http://www.oracle.com/pls/topic/lookup?ctx=E35215-01&id=tut_ses_administration

Oracle SES Installation Procedure

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

To obtain the software and start the installer: 

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

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

  3. 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.)
  4. Unzip the Oracle SES software.

    • There will be more than one zip archive, typically four.

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

  5. Navigate to the top-level directory of the Oracle SES software distribution where the zip archives were unzipped.

  6. Start Oracle SES installer from your system prompt using the following command:

    ./runInstaller
    

    The Oracle SES install Wizard is displayed.

  7. Follow the pages of the installation wizard as described in section "Oracle SES Configuration during Installation".

  8. When the Finish wizard page is displayed, click Close to exit from the Oracle SES installer.

Oracle SES Configuration during Installation

The Oracle SES installer wizard displays multiple pages containing the configuration information about the various Oracle SES software components, such as database and middle tier.

The Oracle SES 11.2.2.2 installation software contains the following software components:

  • Oracle SES version 11.2.2.2

  • Oracle Database version 11.2.0.3.0

  • Oracle WebLogic Application Server version 10.3.6.0.0

  • Oracle Fusion Middleware Application Developer version PS5 (11.1.1.6.0)

  • Perl v5.10.0

Note:

Oracle Fusion Middleware Application Developer consists of software components that provide common functionality for Oracle business applications and application frameworks. These software components include, Java Required Files (JRF), Oracle Web Services Manager (OWSM), Oracle Metadata Services (MDS), Oracle Enterprise Manager (OEM), Oracle Enterprise Scheduler, and Oracle Portlet Developer Kit (PDK). These software components are installed in the WebLogic Server middle tier directory mw_home/oracle_common.

The Oracle SES installer provides the following three options for installing Oracle SES:

Note:

The Oracle SES installer will prompt you to run the following scripts as the root user at the end of the installation process:
  • root.sh script present in the DB home directory, only if you have chosen the option of installing Oracle SES along with the database and the middle tier.

  • orainstRoot.sh script present in the inventory directory, only if this is the first Oracle product installation on the system.

The information about the option selected during Oracle SES installation is stored in the file ses_home/install/install.properties.

Install and Configure Oracle Secure Enterprise Search with Database and Middle Tier

Select this option to install Oracle SES 11.2.2.2 along with the Oracle Database 11.2.0.3.0 and Oracle WebLogic Server 10.3.6.0.0 middle tier.

When this installation option is selected, Oracle SES installer provides the Wizard pages for installing and configuring the following Oracle SES components:

  • Database Details

    Provide the following details for installing Oracle Database and Oracle SES schema:

    • DB Oracle Base: The root directory where all the Oracle Database products are installed. This directory path is displayed by default. You can change this path by clicking the Browse button and then selecting a different directory path. In this document, this directory is referred to as oracle_base.

      Note:

      The members of the oraInventory group must have write permission to the DB Oracle Base directory.
    • DB Oracle Home: The Oracle home directory where the database component of Oracle SES software is installed. The default is oracle_base/product/11.2.0/sesdb_1. You can change this path by either clicking the Browse button and then selecting a different directory path, or entering the directory path in the text box (the directory path must not contain spaces). In this document, this directory is referred to as oracle_home.

    • Data File Location: The directory where Oracle SES database stores its data files. The default is oracle_base/oradata. You can change this directory path by clicking the Browse button and then selecting a different directory path. The data storage location must be outside of the Oracle home directory, so that it will not be deleted during upgrade process in future.

    • Global DB Name: The name for the database that uniquely identifies it from the other databases in the network. Specify it in the format: database_unique_name.database_domain_name, where database_unique_name is the name of the database. It can contain a maximum of 30 characters, as long as the first eight characters are unique. (alphanumeric, underscore (_), dollar ($), and pound (#)). Database domain name is the computer environment used for the database. It should not contain more than 128 characters (alphanumeric, underscore (_), and pound (#)), inclusive of all periods. Global DB Name value should not exceed 128 characters.

      Example: sales.us.example.com, where the database unique name is sales and the database domain name is us.example.com.

    • Search Schema Password: Password for the Oracle SES schema. The password should contain minimum of 8 characters and maximum of 30 characters. Oracle recommends that the password should contain at least one lowercase letter, one uppercase letter, and one digit.

      The Search schema password is the common password used for SEARCHSYS, SYS, SEARCH_ESS, SEARCH_MDS, and SYSTEM users.

      Note:

      For the Oracle SES 11.2.2.2 release, the Oracle SES administrative user is SEARCHSYS. For the earlier Oracle SES release (11.1.2.2), the Oracle SES administrative user is EQSYS.
    • Confirm Password: Re-enter password for the Oracle SES schema.

    • Language: Select all the languages to be installed for the database. English is a must, and it is selected by default.

    Note:

    The Advanced Compression Option feature of Oracle Database is enabled by default. The Advance Compression Option substantially reduces the crawler cache file space requirement on the system where Oracle SES database is installed.
  • Middle Tier Details

    Provide the following details for installing the middle tier:

    • Middleware Home: The home directory of Oracle SES middle tier. This directory path is displayed by default. You can change this path by clicking the Browse button and then selecting a different directory path. The middleware home directory cannot be under the oracle_base directory. In this document, this directory is referred to as mw_home.

    • Domain Home: The home directory of WebLogic Server domain. A domain is the basic administration unit for WebLogic Server. It consists of one or more WebLogic Server instances and logically related resources and services that are managed collectively, as one unit.

      The default Domain Home directory is mw_home/user_projects/domains. You can change this path by clicking the Browse button and then selecting a different directory path. It is recommended to have the Domain Home directory under the Middleware Home directory. In this document, this directory is referred to as wls_domain_home.

    • Domain Name: The name of the WebLogic Server domain used by the Oracle SES server. It is search_domain by default, and the directory with this name is created under the Domain home. In this document, this directory is referred to as ses_domain_name.

      The domain name can include only alphanumeric characters, hyphen ('-'), and underscore character ('_'). The domain name must contain at least one letter or digit.

    • WLS Admin Port: The WebLogic Server administration port. Its default value is the first available port starting 7001. You can specify any other available port. The specified port must be within a valid range, for example, for Linux and UNIX systems, it must be within the range of 1024 to 65535.

    • Search HTTP Port: The port on which the Oracle SES server will listen. For example, if you install Oracle SES server on host example.com and you specify port 7777, then your Search URL will be http://example.com:7777/search/query/search.

      Its default value is the first available port starting 5720. You can specify any other available port. The specified port must be within a valid range, for example, for Linux and UNIX systems, it must be within the range of 1024 to 65535.

    • Search Admin Password: The Oracle SES administrator (SEARCHSYS) password. This is a common password used by the SEARCHSYS LDAP user and WebLogic administrator. This is the password that you will later use to log on to the Oracle SES administration tool.

      The password should contain minimum of 8 characters and maximum of 30 characters. Oracle recommends that the password should contain at least one lowercase letter, one uppercase letter, and one digit.

    • Confirm Password: Re-enter the Search Admin password.

      Note:

      After the successful installation of Oracle SES, the directory Oracle_SES1 gets created under the SES middle tier home directory. This is the SES home directory, referred to as ses_home in this document.
Install and Configure Oracle Secure Enterprise Search with Middle Tier (on an Existing Database)

Select this option to install Oracle SES 11.2.2.2 and WebLogic Server 10.3.6.0.0 middle tier on a system, when you already have installed Oracle Database 11.2.0.3.x or 11.2.0.4.x (Enterprise Edition).

Note:

  • Oracle SES application must be installed on a system that is in the same network where Oracle Database is installed.

  • Oracle Database having the Edition-Based Redefinition (EBR) feature enabled is not supported.

  • Oracle Database instance must have the following components:

    • Oracle Text

    • Oracle JVM

    • Oracle XML DB

  • Oracle SES supports installing Patch Set Updates (PSUs) for Oracle Database base releases 11.2.0.3.0 and 11.2.0.4.0, as long as the set of mandatory Oracle Database patches listed on the Oracle support website is adhered to. For example, you can install PSU 11.2.0.3.11 over the Oracle Database base release 11.2.0.3.0 only and PSU 11.2.0.4.3 over the Oracle Database base release 11.2.0.4.0 only. For more information about installing PSUs, refer to the section "Applying Critical Patch Updates (CPUs) and Patch Set Updates (PSUs)".

  • Oracle SES support for Oracle Database 11.2.0.3.x ends in February 2015, so you must upgrade to Oracle Database 11.2.0.4.0 before the support ends for Oracle Database 11.2.0.3.x. Refer to the Oracle SES Release Notes section "Mandatory Upgrade to Oracle Database 11.2.0.4.0" for the steps to upgrade from Oracle Database 11.2.0.3.x to Oracle Database 11.2.0.4.0.

The Oracle Database can be either in a single node configuration or in an Oracle RAC configuration. The Oracle Database must be configured to use the AL32UTF8 character set. The SEARCHSYS, SEARCH_ESS, and SEARCH_MDS schemas must not be present in the database. All the required database patches for Oracle SES must be applied on it. Refer to section "Installing Mandatory Oracle Database Patches" for more information about applying the database patches.

When this installation option is selected, the Oracle SES installer provides Wizard pages for installing and configuring the following Oracle SES components:

  • Existing Database Details

    Provide the following details for the existing Oracle Database and for the new Oracle SES schema:

    • DB Host Name: The system host name where the Oracle Database is installed. For Oracle RAC Database, specify SCAN name as DB host name.

    • DB Port: The Oracle Database Listener port. The Oracle Database and the corresponding Listener should be up and running, and should be ready to accept database connections.

    • DB Service Name: The Oracle Database service name. This is generally the Global database name.

    • DB SYS Password: The Oracle Database SYS user password.

    • Search Schema Password: Password for the Oracle SES schema. The password should contain minimum of 8 characters and maximum of 30 characters. Oracle recommends that the password should contain at least one lowercase letter, one uppercase letter, and one digit.

      The Search schema password is the common password used for SEARCHSYS, SEARCH_ESS, and SEARCH_MDS users.

      Note:

      For the Oracle SES 11.2.2.2 release, the Oracle SES administrative user is SEARCHSYS. For the earlier Oracle SES release (11.1.2.2), the Oracle SES administrative user is EQSYS.
    • Confirm Password: Re-enter password for the Oracle SES schema.

    • Advanced Compression Option: Select this option if you have the license for the Advanced Compression Option feature.

      Note:

      Selecting the Advance Compression Option substantially reduces the crawler cache file space requirement on the system where Oracle SES database is installed.
    • Oracle Partitioning Option: Select this option if you have the license for the Oracle Partitioning Option feature.

  • Middle Tier Details

    Provide the following details for installing the middle tier:

    • Middleware Home: The home directory of Oracle SES middle tier. This directory path is displayed by default. You can change this path by clicking the Browse button and then selecting a different directory path. The middleware home directory cannot be under the oracle_base directory. In this document, this directory is referred to as mw_home.

    • Domain Home: The home directory of WebLogic Server domain. A domain is the basic administration unit for WebLogic Server. It consists of one or more WebLogic Server instances and logically related resources and services that are managed collectively, as one unit.

      The default Domain Home directory is mw_home/user_projects/domains. You can change this path by clicking the Browse button and then selecting a different directory path. It is recommended to have the Domain Home directory under the Middleware Home directory. In this document, this directory is referred to as wls_domain_home.

    • Domain Name: The name of the WebLogic Server domain used by the Oracle SES server. It is search_domain by default, and the directory with this name is created under the Domain home. In this document, this directory is referred to as ses_domain_name.

      The domain name can include only alphanumeric characters, hyphen ('-'), and underscore character ('_'). The domain name must contain at least one letter or digit.

    • WLS Admin Port: The WebLogic Server administration port. Its default value is the first available port starting 7001. You can specify any other available port. The specified port must be within a valid range, for example, for Linux and UNIX systems, it must be within the range of 1024 to 65535.

    • Search HTTP Port: The port on which the Oracle SES server will listen. For example, if you install Oracle SES server on host example.com and you specify port 7777, then your Search URL will be http://example.com:7777/search/query/search.

      Its default value is the first available port starting 5720. You can specify any other available port. The specified port must be within a valid range, for example, for Linux and UNIX systems, it must be within the range of 1024 to 65535.

    • Search Admin Password: The Oracle SES administrator (SEARCHSYS) password. This is a common password used by the SEARCHSYS LDAP user and WebLogic administrator. This is the password that you will later use to log on to the Oracle SES administration tool.

      The password should contain minimum of 8 characters and maximum of 30 characters. Oracle recommends that the password should contain at least one lowercase letter, one uppercase letter, and one digit.

    • Confirm Password: Re-enter the Search Admin password.

      Note:

      After the successful installation of Oracle SES, the directory Oracle_SES1 gets created under the SES middle tier home directory. This is the SES home directory, referred to as ses_home in this document.

(Optional) Postinstallation Step - Register XML DB Protocol Port

This postinstallation step allows for WebDAV/HTTP(S) access to the Oracle XML DB repository data. Perform this step only if you want to use WebDAV protocol to customize the skin bundle.

For WebDAV/HTTPS(S) access to the Oracle XML DB repository, you need to register the XML DB protocol port. Perform this operation when Oracle SES is installed on an existing Oracle Database on a system that is different from the one where Oracle SES middle tier is installed.

Perform the following steps to register the XML DB protocol port:

  1. Log on to the system where the Oracle SES database is installed.

  2. Run the following commands at the command line:

    setenv ORACLE_HOME path_of_the_DB_Oracle_Home
    setenv ORACLE_SID  Oracle_Database_SID
    
    $ORACLE_HOME/bin/sqlplus ”sys/password as sysdba”
    
    SQL> exec dbms_xdb.sethttpport(port)
    

    Here, port can be any free port greater than 1024.

    You can verify the successful registration of the XML DB protocol port by running the following command:

    SQL> SELECT dbms_xdb.gethttpport() FROM dual;
    

Postinstallation Step - Configure LDAP-based Identity Store and OPSS Security Store (When WebLogic Server Middle Tier is Deployed Across Multiple Systems)

When the WebLogic Server middle tier is deployed across multiple systems, then you must configure an LDAP-based identity store and an Oracle Platform Security Services (OPSS) security store. Refer to the following Oracle Fusion Middleware documentation for more information:

Install Oracle Secure Enterprise Search Software Only (on an Existing Database and an Existing Middle Tier)

Select this option to install only the Oracle SES software on a system, when you already have installed:

  • Oracle Database 11.2.0.3.x or Oracle Database 11.2.0.4.x (Enterprise Edition)

    Oracle SES application must be installed on a system that is in the same network where Oracle Database 11.2.0.3.x or 11.2.0.4.x is installed. The Oracle Database can be either in single node configuration or in Oracle RAC configuration. The Oracle Database must be configured to use the AL32UTF8 character set. The SEARCHSYS, SEARCH_ESS, and SEARCH_MDS schemas must not be present in the database. All the required database patches for Oracle SES must be applied on it. Refer to section "Installing Mandatory Oracle Database Patches" for more information about applying the mandatory database patches.

    Note:

    • Oracle Database with Edition-Based Redefinition (EBR) feature enabled is not supported.

    • Oracle Database instance must have the following components:

      • Oracle Text

      • Oracle JVM

      • Oracle XML DB

    • Oracle SES supports installing Patch Set Updates (PSUs) for Oracle Database base releases 11.2.0.3.0 and 11.2.0.4.0, as long as the set of mandatory Oracle Database patches listed on the Oracle support website is adhered to. For example, you can install PSU 11.2.0.3.11 over the Oracle Database base release 11.2.0.3.0 only and PSU 11.2.0.4.3 over the Oracle Database base release 11.2.0.4.0 only. For more information about installing PSUs, refer to the section "Applying Critical Patch Updates (CPUs) and Patch Set Updates (PSUs)".

    • Oracle SES support for Oracle Database 11.2.0.3.x ends in February 2015, so you must upgrade to Oracle Database 11.2.0.4.0 before the support ends for Oracle Database 11.2.0.3.x. Refer to the Oracle SES Release Notes section "Mandatory Upgrade to Oracle Database 11.2.0.4.0" for the steps to upgrade from Oracle Database 11.2.0.3.x to Oracle Database 11.2.0.4.0.

  • Oracle WebLogic Server 10.3.6.0.x

    Oracle SES application must be installed on the same system where WebLogic Server is installed. All the required WebLogic Server patches for Oracle SES must be applied on it. Refer to section "Installing Mandatory WebLogic Server Patches" for more information about applying the mandatory WebLogic Server patches.

    Note:

When this installation option is selected, the Oracle SES installer provides the Wizard pages for installing and configuring the following Oracle SES components:

  • Existing Middle Tier Details

    Provide the following details for the existing WebLogic Server middle tier:

    • Middleware Home: The home directory of an existing middle tier installation containing the WebLogic Server software. In this document, this directory is referred to as mw_home.

    • Search Home Directory: The name of the home directory where Oracle SES must be installed. This directory is created under the Middleware home (mw_home), and is also referred to as SES home. In this document, this directory is referred to as ses_home.

Postinstallation Steps

You must execute the following postinstallation steps when you install Oracle SES on an existing middle tier and an existing database:

  1. Load Oracle SES schema in the database:

    1. Set the environment variable JRE_DIR to point to the JDK installation directory used by the existing WebLogic Server middle tier.

      setenv JRE_DIR wls_server_java_home_directory
      
    2. Run the Repository Creation Utility (RCU) tool to load the Oracle SES schema into the database.

      cd ses_home/rcu/bin
      ./rcu
      

      Note:

      For detailed information about creating database schema using RCU, refer to Oracle Fusion Middleware Repository Creation Utility User's Guide at http://docs.oracle.com/cd/E23943_01/doc.1111/e14259/rcu.htm#CHDGJCGJ.
    3. In the Welcome screen, click Next.

    4. In the Create Repository screen, select Create, and click Next.

    5. In the Database Connection Details screen, enter the information related to the existing Oracle Database and user credentials of the sys user. Click Next.

    6. In the Select Components screen, select Create a new Prefix option and enter SEARCH string as prefix. Select the schemas SEARCHSYS, MDS, and ESS, and click Next.

      Note:

      For the Oracle SES 11.2.2.2 release, the Oracle SES administrative user is SEARCHSYS. For the earlier Oracle SES release (11.1.2.2), the Oracle SES administrative user is EQSYS.
    7. In the Schema Passwords screen, select Use same passwords for all schemas option, and enter common password for the selected schemas. Click Next.

    8. In the Custom Variables screen, enter Y for Advance Compression Option and Oracle Partitioning Option, if you have license for these features; else enter N. Click Next.

      Note:

      Selecting the Advance Compression Option substantially reduces the crawler cache file space requirement on the system where Oracle SES database is installed.
    9. In the Map Tablespaces screen, you may choose to use the existing tablespaces, and click Next.

    10. In the Summary screen, verify the database details information provided by you, and click Create. This will create the Oracle SES schema in the existing database specified by you.

  2. Create WebLogic domain:

    If you want to use an existing WebLogic domain that is already used by applications, such as, Fusion Middleware Webcenter or Peoplesoft or others, then go to step 3.

    If you want to create a new WebLogic domain, then execute the following steps.

    Note:

    For detailed information about creating a new WebLogic domain, refer to Oracle Fusion Middleware Creating Domains Using the Configuration Wizard guide at http://docs.oracle.com/cd/E28280_01/web.1111/e14140/newdom.htm
    1. Run the WebLogic configuration tool using the following command:

      mw_home/oracle_common/common/bin/config.sh
      
    2. In the Welcome screen, select Create a new WebLogic domain option and click Next.

    3. In the Select Domain Source screen, the template "Basic Weblogic Template" is selected by default. Click Next.

    4. In the Specify Domain Name and Location screen, enter the domain name and domain location information, and click Next.

    5. In the Configure Administrator User Name and Password screen, enter the WebLogic Server administrator user name and password, and click Next.

    6. In the Configure Server Start Mode and JDK screen, select the Production Mode option, specify the installation directory for JDK 1.6 or later versions, and click Next.

    7. Click Create to create the new WebLogic domain.

  3. Extend the WebLogic domain with SES, ESS, and EM templates:

    After you create a new WebLogic domain as explained in the earlier step, or if you already have an existing WebLogic domain that you want to use, then you should extend this WebLogic domain with SES, ESS, and EM templates by executing the following steps.

    Note:

    For detailed information about extending a WebLogic domain, refer to Oracle Fusion Middleware Creating Domains Using the Configuration Wizard guide at http://docs.oracle.com/cd/E28280_01/web.1111/e14140/exten.htm
    1. Run the WebLogic configuration tool using the following command:

      mw_home/oracle_common/common/bin/config.sh
      
    2. In the Welcome screen, select Extend an existing WebLogic domain option and click Next.

    3. In the Select a WebLogic Domain Directory screen, select the domain name that you want to extend for Oracle SES, and click Next.

    4. In the Select Extension Source screen, select Extend my domain automatically to support the following added products option, select the following check boxes, and click Next.

      - Oracle Secure Enterprise Search ESS Core Hosting Application–11.2.2.2.0 [ORACLE_SES1]

      - Oracle Secure Enterprise Search–Standalone Mode 11.2.2.2.0 [ORACLE_SES1]

      - Oracle Enterprise Scheduler Service Basic–11.1.1.0 [ORACLE_SES1]

      - Oracle Enterprise Manager Plugin for ESS–11.1.1.0 [ORACLE_SES1]

      - Oracle Enterprise Manager–11.1.1.0 [oracle_common]

    5. In the Configure JDBC Component Schema screen, select all the schemas, enter the following database connection information, and click Next.

      - Vendor: Oracle

      - DBMS/Service: Database service name

      - Driver: Oracle's Driver (Thin) for service connections

      - Host Name: Name of the database server host for non-Oracle RAC database or SCAN Name for Oracle RAC database

      - Schema Owner: Name of the database schema

      - Port: Database server listener port

      - Schema Password: Database schema password

      Note:

      When entering the schema owner, make sure that MDS and ESS have the prefix name SEARCH as part of the schema owner, for example, SEARCH_MDS and SEARCH_ESS. There must not be any prefix for SEARCHSYS. There must not be a schema by the name DEV_ORAESS.
    6. In the Test JDBC Component Schema screen, click Test Connections button to verify that all the schema details entered are correct.

    7. In the Select Optional Configuration screen, select Managed Servers, Deployments and Services check box.

    8. In the Configure Managed Servers screen, enter the listen port numbers for ESS and SEARCH servers. Note down the port for the SEARCH server. This information will be used in the URLs for accessing the Oracle SES Administration and Query applications.

    9. Continue clicking Next button until you reach the Target Services to Clusters or Servers screen.

    10. Select search_server1 in the left panel.

    11. In the right panel, select Service > JDBC > JDBC System Resource.

    12. Select EssDS, EssXADS, EssInternalDS, mds-ESS_MDS_DS, and mds-owsm.

      Note:

      All the JDBC system resources under Service should have ess_server1 and search_server1 as targets. The mds-owsm should have AdminServer, ess_server1, and search_server1 as targets.
    13. Click Extend to extend the domain.

  4. Configure nodemanager.properties file:

    1. Go to mw_home/wlserve/common/nodemanager.

    2. Open the nodemanager.properties file in a text editor.

    3. Set StartScriptEnabled=true.

    4. Save and close the nodemanager.properties file.

  5. Start WebLogic Server, ESS managed server, and Search managed server:

    1. Start WebLogic Admin Server by navigating to the WebLogic domain directory and running the startWeblogic.sh script.

      wls_domain_home/ses_domain_name/startWebLogic.sh
      
    2. Start SES and ESS managed servers by executing the following commands:

      wls_domain_home/ses_domain_name/bin/startManagedWebLogic.sh ess_server1
      
      wls_domain_home/ses_domain_name/bin/startManagedWebLogic.sh search_server1
      
  6. If you are not using an external LDAP server, then execute step 6A, else execute step 6B.

    6A. If you are not using an external LDAP server, create users FUSION_APPS_SEARCH_APPID, and SEARCHSYS in the WebLogic Server domain:

    1. Log on to the WebLogic Console (http://host:port/console) as an administrator user.

    2. Navigate to Security Realms > myRealm > Users and Groups.

    3. Click NEW and create a new user FUSION_APPS_SEARCH_APPID. Provide a password for this user.

    4. Save the changes.

    5. Click NEW and create new user SEARCHSYS. Provide a password for this user.

    6. Save the changes.

    6B. If you are using an external LDAP server, then create two users in the external LDAP server. One user must be an internal user (for example, APPID user) and is needed for the Oracle SES crawler to work with the Oracle Enterprise Schedule Service (ESS) application. The other user must be an Oracle SES administrator (for example, ADMIN user).

  7. Create CSF entries SES_ADMIN-KEY and SEARCH_DATABASE:

    Run the script mw_home/oracle_common/common/bin/wlst.sh, and execute the following WLST commands:

    1. wls:/offline>connect()

      Enter the user name, password, and the appropriate connection information of the WebLogic console.

      Make sure the domain run-time server is enabled, that is, the prompt will become "wls:/>".

    2. If you are not using an external LDAP server, then execute the command:

      wls:/>createCred(map="oracle.apps.security", key="FUSION_APPS_SEARCH_APPID-KEY", user="FUSION_APPS_SEARCH_APPID", password="password")

      Provide password for FUSION_APPS_SEARCH_APPID-KEY in the password field.

      If you are using an external LDAP server, then execute the above command by replacing the FUSION_APPS_SEARCH_APPID user credentials with the APPID user of the external LDAP server.

    3. If you are not using an external LDAP server, then execute the command:

      wls:/>createCred(map="oracle.apps.security", key="FUSION_APPS_ECSF_SES_ADMIN-KEY", user="searchsys", password="password")

      Provide password for the database user SEARCHSYS in the password field.

      If you are using an external LDAP server, then execute the above command by replacing the searchsys user credentials with the ADMIN user credentials of the external LDAP server.

    4. wls:/>createCred(map="oracle.search", key="SEARCH_DATABASE", user="SES_DB_JDBC_Connect_String", password="SES_DB_Password")

      Provide appropriate value for the SES_DB_Connect_String field in the format jdbc:oracle:thin:@host:port:SID.

      Note:

      For the Oracle Database in Oracle RAC configuration, you should use Oracle RAC SCAN name and fully qualified service name in the value for the SES_DB_Connect_String field in the following format:
      jdbc:oracle:thin:@RAC_SCAN_name:port/fully_qualified_service_name
      

      To know the Oracle RAC SCAN name, run the command:

      oracle_home/bin/srvctl config scan
      

      The Oracle RAC SCAN name is also available in the file oracle_home/network/admin/tnsnames.ora.

    After successfully completing this task, you can exit the wlst.sh script.

  8. Configure ESS standalone job type:

    Run the script ses_home/common/bin/wlst.sh, and execute the following WLST commands:

    1. wls:/offline>connect()

      Enter the user name, password, and the appropriate connection information of the WebLogic console.

      Make sure the domain run-time server is enabled, that is, the prompt will become "wls:/>".

    2. wls:/>essManageRuntimeConfig("SearchEss","APP",operation="add",name="SEARCH_TOP",val="search_top_location")

      Replace search_top_location with the absolute file path of the Oracle SES home directory (that is, ses_home directory).

    3. wls:/>essManageRuntimeConfig("SearchEss","ESS", operation="add",name="PerlCommand",val="perl_location")

      Replace perl_location with the absolute file path of the perl executable: ses_home/perl/bin/perl.

    After completing this task, exit the wlst.sh script.

  9. Grant admin user role to SEARCHSYS/ADMIN user:

    Run the script mw_home/oracle_common/common/bin/wlst.sh, and execute the following WLST commands:

    1. wls:/offline>connect()

      Enter the user name, password, and the appropriate connection information of the WebLogic console.

      Make sure the domain run-time server is enabled, that is, the prompt will become "wls:/>".

    2. If you are not using an external LDAP server, then execute the command:

      wls:/>grantAppRole(appStripe="search",appRoleName="SearchAdminSuperUserRole", principalClass="weblogic.security.principal.WLSUserImpl", principalName="searchsys")

      If you are using an external LDAP server, then execute the above command by replacing the searchsys user with the ADMIN user of the external LDAP server.

    After successfully completing this task, exit the wlst.sh script.

  10. Set default index optimization frequency:

    For the index optimizer to work properly, the following command must be executed:

    ses_home/bin/searchadmin -u searchsys -p password -c http://sesAdminHost:sesAdminPort/search/api/admin/AdminService update indexOptimizer -i ses_home/search/data/config/weekly_optimize.xml -a overwrite
    

    where,

    password= SEARCHSYS user password (This user is created during step 5)

    sesAdminHost = SES Server Host

    sesAdminPort= SES Server Port

  11. (Optional) Register XML DB protocol port:

    This postinstallation step allows for WebDAV/HTTP(S) access to the Oracle XML DB repository data. Perform this step only if you want to use WebDAV protocol to customize the skin bundle.

    For WebDAV/HTTPS(S) access to the Oracle XML DB repository, you need to register the XML DB protocol port. Perform this operation when Oracle SES is installed on an existing database on a system that is different from the one where Oracle SES middle tier is installed.

    Perform the following steps to register the XML DB protocol port:

    1. Log on to the system where Oracle SES database is installed.

    2. Run the following commands at the command line:

      setenv ORACLE_HOME path_of_DB_Oracle_home
      setenv ORACLE_SID  Oracle_Database_SID
      
      $ORACLE_HOME/bin/sqlplus ”sys/password as sysdba”
      
      SQL> exec dbms_xdb.sethttpport(port)
      

      Here, port can be any free port greater than 1024.

    You can verify the successful registration of the XML DB protocol port by running the following command:

    SQL> SELECT dbms_xdb.gethttpport() FROM dual;
    
  12. Configure LDAP-based Identity Store and Security Store for WLS deployed across multiple systems:

    When the WebLogic Server middle tier is deployed across multiple systems, then you must configure an LDAP-based identity store and an Oracle Platform Security Services (OPSS) security store. Refer to the following Oracle Fusion Middleware documentation for more information:

Verification of Successful Installation of Oracle SES

To verify whether Oracle SES 11.2.2.2 is properly installed on your system, check the following things:

  • In the WebLogic Server Console, navigate to Services > Data Sources, and verify that the following targets have the appropriate values:

    • EssDS: ess_server1, search_server1

    • EssInternalDS: ess_server1, search_server1

    • EssXADS: ess_server1, search_server1

    • mds-ESS_MDS_DS: ess_server1, search_server1

    • mds-owsm: AdminServer, ess_server1, search_server1

  • Check the following URLs in a Web browser:

    • Oracle SES Query application: http://ses_host:ses_port/search/query/search

    • Oracle SES Administration application: http://ses_host:ses_port/search/admin/index.jsp (Log on using the searchsys admin user and its password specified during the Oracle SES installation.)

Note:

The information about the options selected during the Oracle SES installation is stored in the ses_home/install/install.properties file.

Important Oracle SES Directories

This document uses the following names for describing various directories of Oracle SES 11.2.2.2 software components:

Directory Name Description
oracle_base The directory where all the Oracle Database products are installed.
oracle_home The directory where the Oracle Database component specific to Oracle SES software is installed. The default oracle_home directory is oracle_base/product/11.2.0/sesdb_1.
mw_home The middleware home directory where the middle tier components of Oracle SES software (that is, WebLogic Server, Oracle SES server, Oracle Fusion Middleware common files) are installed.
wls_home The directory where the WebLogic Server is installed. The default wls_home directory is mw_home/wlserver.
wls_domain_home The directory where multiple instances of a WebLogic Server middle tier are created. The default wls_domain_home directory is mw_home/user_projects/domains.
ses_domain_name The directory where the WebLogic Server instance specific to Oracle SES is created under wls_domain_home directory. The default ses_domain_name directory is search_domain.
ses_home The directory where the Oracle SES server is installed. The ses_home directory is created under the mw_home directory. When Oracle SES 11.2.2.2 software is installed along with the WebLogic Server middle tier, the ses_home directory is mw_home/Oracle_SES1.

Installation Log Files

The installation process generates following log files in the oraInventory_directory/logs directory:

  • installActionstimestamp.log: Contains all informational messages generated during the installation. This log is created for both silent and interactive installations. For a successful installation, this message appears at the end of the log file:

    *** End of Installation Page***
    The installation of Oracle Secure Enterprise Search was successful.
    
  • OPatchtimestamp.log: Contains an inventory of installed software following installation of an interim patch. One log file is created for each patch.

Installation of Multiple Oracle SES Instances

You cannot install multiple Oracle SES instances (current release or a previous release) that use the same database or the same middle tier. But, you can configure multiple Oracle SES servers and Oracle ESS servers in a clustered environment.

Oracle SES Database Users Password Expiration Policy

Oracle SES uses three Oracle SES application specific schemas SEARCHSYS, SEARCH_ESS, and SEARCH_MDS. When Oracle SES is installed along with the database, the password for these three schemas never expire. When Oracle SES is installed on an existing database, then the password expiry for these three schemas follows the Oracle Database default password expiry policy. Refer to the Oracle Database 2 Day DBA guide for more information about the default password expiry policy for an Oracle Database.

Silent Installation Tasks

A silent installation has no graphical output and no input by the user. It is accomplished by supplying Oracle SES installer with a response file and specifying the -silent flag on the command line. Use silent installation when you want to use the same Oracle SES installation configuration on more than one system.

Performing Silent Installation

To perform the silent installation of Oracle SES:

  1. Download and unzip the installation files, as described in steps 1 to 5 of "Oracle SES Installation Procedure".

  2. Edit the response file in a text editor, such as Windows Notepad, as described in the section "Editing a Response File". Ensure that all the values in the response file are correct.

    Note:

    Values for variables that are of the wrong context, format, or type are treated as if no values 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 SES installer encounters an error, such as insufficient disk space, then the installation will fail.

    Caution:

    If you must provide passwords or other sensitive information in your response files, then for the security purpose, delete them after completing and verifying the installation.
  3. Navigate to the top level directory of the Oracle SES software distribution and run the following command to start the silent installation:

    ./runInstaller -silent -responseFile response_file_name_with_absolute_path
    
  4. Check the status of silent installation by referring to the log file oraInventory_directory/logs/installActionsDate_Time.log

    On successful completion of the silent installation, the installer displays the message "Successfully Setup Software." on the command line.

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

There are two ways to use a response file:

  • Use the response file that was generated during the earlier installation of Oracle SES on a different system. The summary page of Oracle SES installer contains Save Response File button that can be used to save the Oracle SES installation settings to a response file.

  • Use the response file template after editing it according to your requirement. Oracle SES provides three response file templates that you can use depending upon the Oracle SES installation option that you choose. The following response file templates are located in the directory install/response under the top level directory of the Oracle SES software distribution:

    • search_standalone.rsp

      Use this response file template when installing Oracle SES along with the database and the middle tier.

    • search_midtier.rsp

      Use this response file template when installing Oracle SES along with the middle tier (on an existing database).

    • search_swonly.rsp

      Use this response file template when installing Oracle SES only (on an existing middle tier and an existing database).

Use any text editor to edit one of the above response files to include information specific to your system. You must specify values for variables in your response file.

Note:

You need to specify values to all the variables in a response file, except for INVENTORY_LOCATION and UNIX_GROUP_NAME, which are required only during the first time installation of an Oracle product on a system. The response file also 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.

Postinstallation Tasks

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

Applying Mandatory Oracle SES Patches

After installing Oracle SES 11.2.2.2, apply the mandatory Oracle SES patches mentioned in the section "Mandatory Software Patches" of Oracle Secure Enterprise Search Release Notes.

Applying Critical Patch Updates (CPUs) and Patch Set Updates (PSUs)

After installing Oracle SES, apply the latest Patch Set Updates (PSUs) and Critical Patch Updates (CPUs) for Oracle products.

Critical Patch Updates (CPUs) are collections of security fixes for Oracle products. They are available to customers with valid support contracts. To check the latest Critical Patch Updates, visit the Oracle Technology Network website:

http://www.oracle.com/technetwork/topics/security/alerts-086861.html

Patch Set Updates (PSUs) are proactive cumulative patches containing recommended bug fixes for Oracle products. To check the latest Patch Set Updates for Oracle products, see the support note 854428.1, Patch Set Updates for Oracle Products on My Oracle Support website: https://support.oracle.com.

To locate the support note 854428.1:

  1. Log on to My Oracle Support website.

  2. Enter 854428.1 in the search field and click the Search icon.

Checking for Additional Documentation and Support Services

Up-to-date Release Notes are posted on Oracle Technology Network (OTN). You must register online before using OTN. Registration is free and can be done at http://www.oracle.com/technetwork/community/join/index.html

If you have a user name and password for OTN, then you can go directly to the documentation section of OTN at http://www.oracle.com/technetwork/indexes/documentation/index.html

(Optional) Changing the Oracle SES Middle Tier Port

Perform these steps only if, after installation, you find that there is a port number conflict requiring you to change the port number of the Oracle SES middle tier.

If needed, you can change the Oracle SES middle tier port as described in this section. There are two methods to change the Search HTTP port, depending upon whether the port that you want to change to is greater than or equal to 1024, or is less than 1024.

To change the Search HTTP port to a value greater than or equal to 1024: 

  1. In the WebLogic Server Administration Console, select Servers > search_server1.

  2. Select Configuration > General.

  3. Click Lock & Edit in the Change Center.

  4. Enter the port number that you want to change to in the Listen Port box.

  5. Click Save.

  6. Restart the Oracle SES managed server, that is, search_server1.

To change the Search HTTP port to a value less than 1024, execute the following additional steps after executing the above mentioned steps: 

  1. In the Change Center of the Administration Console, click Lock & Edit.

  2. In the left pane of the Console, expand Environment and select Machines.

  3. Click New.

  4. Enter a name for the new system in the Name attribute field. This name is used to identify the system within the WebLogic Server domain. This name does not have to correspond to the system's network name.

  5. Select UNIX in the Machine OS field.

  6. Click OK. The new system name is displayed in the Machines table.

  7. Select the name of the system you just created.

  8. Select Configuration > General.

    1. To specify a non-privileged user account under which the server instance runs, place a check mark in the Enable Post-bind UID field and enter the user ID in the Post-Bind UID field. The user ID that you enter must have read, write, and execute privileges within the Oracle Middleware directory, the WebLogic Server product directory tree, and your domain directory.

      The default value of the Post-Bind UID field, nobody, is a standard UNIX account that provides the least possible privileges. While the nobody account is acceptable for use in a development environment, in a production environment, Oracle recommends that you create an operating-system user account specifically for running instances of WebLogic Server.

    2. To specify a non-privileged group instead of (or in addition to) providing a user ID, place a check mark in the Enable Post-bind GID field and enter the group ID in the Post-Bind GID field.

  9. Click Save.

  10. Click Activate Changes in the Change Center.

  11. Restart the Oracle SES managed server, that is, search_server1.

Deinstalling Oracle SES

This section provides the procedure for deinstalling Oracle SES. The Oracle SES deinstallation process depends upon the installation option that you chose while installing Oracle SES.

Before you deinstall Oracle SES, you must stop all the crawler schedules and the index optimizer by using either Administration GUI or Administration API.

To stop all the crawler schedules and the index optimizer using Administrator GUI: 

  1. Log in to the Administration GUI.

  2. Stop the crawler schedules:

    1. Navigate to Home > Schedules.

    2. Select each schedule and click Stop.

  3. Stop the index optimizer:

    1. Navigate to Global Settings > Index Optimization.

    2. Click Stop Index Optimizer button.

To stop all the crawler schedules and the index optimizer using Administrator API: 

  1. Get the list of all the schedules:

    ses_home/bin/searchadmin -u searchsys -p password -c http://sesAdminHost:sesAdminPort/search/api/admin/AdminService getAllObjectKeys schedule
    
  2. Stop each of the schedules returned by the above command:

    ses_home/bin/searchadmin -u searchsys -p password -c http://sesAdminHost:sesAdminPort/search/api/admin/AdminService stop schedule --NAME="source_name"
    
  3. Stop the index optimizer:

    ses_home/bin/searchadmin -u searchsys -p password -c http://sesAdminHost:sesAdminPort/search/api/admin/AdminService stop indexOptimizer
    

Run the following deinstallation scripts depending upon the installation option that you chose while installing Oracle SES.

To deinstall Oracle SES when Oracle SES is installed along with the database and the middle tier: 

  1. Connect to the system where Oracle SES is installed as the Oracle SES installation user.

  2. Run the middle tier deinstallation script:

    ses_home/deinstall/deinstall.sh
    
  3. Run the database deinstallation script:

    oracle_home/deinstall/deinstall
    

To deinstall Oracle SES when Oracle SES is installed along with the middle tier (on an existing database): 

  1. Connect to the system where Oracle SES is installed as the Oracle SES installation user.

  2. Run the middle tier deinstallation script:

    ses_home/deinstall/deinstall.sh
    

To deinstall Oracle SES when only Oracle SES is installed (on an existing middle tier and an existing database): 

  1. Connect to the system where Oracle SES is installed, as the Oracle SES installation user.

  2. Stop the Oracle ESS managed servers:

    wls_domain_home/ses_domain_name/bin/stopManagedWebLogic.sh server_name admin_URL user_name password
    
  3. Stop the Oracle SES managed servers:

    wls_domain_home/ses_domain_name/bin/stopManagedWebLogic.sh server_name admin_URL user_name password
    
  4. Stop the WebLogic Server:

    wls_domain_home/ses_domain_name/bin/stopWeblogic.sh
    
  5. Drop the Oracle SES and Oracle ESS schemas (make sure that the environment variable JRE_DIR is already set to the JDK installation directory):

    ses_home/rcu/bin/rcu
    
  6. Run the middle tier deinstallation script:

    ses_home/deinstall/deinstall.sh
    

Directories to Remove Manually

After deinstalling Oracle SES, you must manually remove the following directory, if it exists:

  • data/cache/mail directory present under the DB Oracle home on the system where the database is installed.

Upgrading Oracle SES

This section provides the information and procedures for upgrading from Oracle SES 11.1.2.2 to Oracle SES 11.2.2.2. Also discussed are pre-upgrade and post-upgrade tasks.

Note:

  • You must already have installed both the Oracle SES versions - Oracle SES 11.1.2.2 and Oracle SES 11.2.2.2 - on the same system or on different systems before starting the upgrade process. Both the Oracle SES instances must be present on the same operating system, that is, cross-platform upgrade is not supported.

  • All the database patches and the middle tier patches should be applied on the Oracle SES 11.2.2.2 instance before starting the upgrade process. Refer to the sections "Installing Mandatory Oracle Database Patches" and "Installing Mandatory WebLogic Server Patches" of this guide for more information about the database and the middle tier patches for the Oracle SES 11.2.2.2 software.

This section contains the following topics:

Pre-upgrade Tasks

This section provides the information and tasks specific to preparing an upgrade from Oracle SES 11.1.2.2 to Oracle SES 11.2.2.2.

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.

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

Back Up the existing Oracle SES Instance

You must create a backup copy of the existing Oracle SES 11.1.2.2 instance, so that you can restore it back in case you face any major issue while upgrading to Oracle SES 11.2.2.2.

To back up Oracle SES using the copy command: 

  • Create a copy of the following directories:

    oracle_base: Oracle products installation directory.
    oracle_home: Oracle SES 11.1.2.2 database directory.
    oradata: repository for data files, control files, and log files.
    oraInventory: central inventory for all the Oracle homes. Its location is specified in /etc/oraInst.loc

To back up Oracle SES using the tar command: 

  1. Shut down the Oracle SES instance using the following command:

    ses_home/bin/searchctl stopall
    
  2. If you are not logged in as root, then enter the following command to become the root user:

    su - root
    
  3. Change (cd) into the backup location of the operating system and execute the following commands:

    tar cvf ses_orabase.tar  {full path to Oracle base} 
    tar cvf ses_orahome.tar  {full path to Oracle home} 
    tar cvf ses_orainv.tar   {full path to oraInventory} 
    tar cvf ses_oradat.tar   {full path to oradata}
    

Export the existing Oracle SES Crawler Schedules

You must export all the crawler schedules of the existing Oracle SES 11.1.2.2 instance, so that you can import them back into the Oracle SES 11.2.2.2 instance while upgrading to Oracle SES 11.2.2.2.

To export all the Oracle SES 11.1.2.2 crawler schedules: 

  1. In the Oracle SES 11.2.2.2 instance, open the script file ses_home/search/admin/upgrade/11.1.2.2/pre_11122_export.sh in a text editor, specify Oracle SES 11.1.2.2 Administration URL and password, and copy this file to the Oracle home directory of the Oracle SES 11.1.2.2 instance. See that ORACLE_HOME variable is defined in the Oracle SES 11.1.2.2 instance.

  2. Start the Oracle SES 11.1.2.2 instance using the searchctl startall command:

    $ORACLE_HOME/bin/searchctl startall
    
  3. In the Oracle SES 11.1.2.2 instance, run the script file pre_11122_export.sh that was copied in step 1:

    sh pre_11122_export.sh
    

    This script exports two files, all_schedules.xml and index_optimizer.xml, to the directory ses_home/search/data/config. These two XML files need to be imported into the Oracle SES 11.2.2.2 instance as described in the section "Running Upgrade Scripts".

Stop All the Scheduled Jobs

During the upgrade of Oracle SES 11.1.2.2 instance, 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: 

  1. Run sqlplus and connect as eqsys user.

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

    SQL> SELECT name, value FROM v$parameter WHERE name='job_queue_processes';
    
  3. Execute this SQL statement to set JOB_QUEUE_PROCESSES to zero.

    SQL> ALTER SYSTEM SET job_queue_processes=0 scope=both
    

(Optional) Change the Search Service HTTP Port if less than 1024

This step is necessary only if the Oracle SES instance 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 "(Optional) Changing the Oracle SES Middle Tier Port" of this document.

Shut down Oracle SES 11.1.2.2 and Oracle SES 11.2.2.2 Middle Tiers

Shut down the middle tiers for both the Oracle SES instances - 11.1.2.2 and 11.2.2.2, before continuing with the upgrade process.

  • Shut down the Oracle SES 11.1.2.2 middle tier using the following command:

    ses_home/bin/searchctl stop
    

Apply the Database Patches 8353098 and 9581727 for Oracle SES 11.1.2.2 Instance

Download the Oracle Database 11.1.0.7.0 patches 8353098 and 9581727 from My Oracle Support Web site https://support.oracle.com and apply them over the Oracle SES 11.1.2.2 database instance.

Upgrade Tasks

This section contains the procedures for upgrading Oracle SES 11.1.2.2 to Oracle SES 11.2.2.2. This section contains the following topics that should be followed in the same sequence:

Note:

The scripts for upgrade are located in the ses_home /search/admin/upgrade/11.1.2.2 directory of the Oracle SES 11.2.2.2 instance.

Exporting Oracle SES 11.1.2.2 Tablespaces

This section describes the steps for exporting Oracle SES 11.1.2.2 tablespaces using the expdp command.

Prepare Directory and Tablespaces for Export
  1. Copy prepare_11122_export.sql file from Oracle SES 11.2.2.2 instance to Oracle SES 11.1.2.2 instance. This file is located in the directory ses_home /search/admin/upgrade/11.1.2.2 in the Oracle SES 11.2.2.2 instance.

  2. Connect to the Oracle SES 11.1.2.2 database as administrator using sqlplus.

    oracle_home/bin/sqlplus sys/SES_admin_password as sysdba
    
  3. Run the prepare_11122_export.sql file from the sqlplus prompt:

    SQL> @prepare_11122_export.sql dump_dir_name dump_dir_path
    

    where, dump_dir_name is the name of the directory where the exported files will be stored, and dump_dir_path is the absolute path of the dump_dir_name directory that already exists on the system.

    After running the prepare_11122_export.sql file, the dump_tts.info file is generated under the dump_dir_path directory. This file contains the information required to run the expdp command.

    The contents of a sample dump_tts.info file are as follows:

    (1) expdp options for tablespaces:
    oracle_home/bin/expdp system/password dumpfile=expTTS.dmp directory=DUMP logfile=expTTS.log
    transport_tablespaces=OES_PUSH,OES_ITAB,OES,OES_ASSM,OES_ASSM2
    
    (2) expdp options for sequences:
    oracle_home/bin/expdp system/password SCHEMAS=EQSYS,EQ_TEST INCLUDE=SEQUENCE dumpfile=expSEQ.dmp directory=DUMP logfile=expSEQ.log
    
    (3) expdp options for views:
    oracle_home/bin/expdp system/password SCHEMAS=EQSYS,EQ_TEST INCLUDE=VIEW dumpfile=expVIEW.dmp directory=DUMP logfile=expVIEW.log
    
    (4) expdp options for types:
    oracle_home/bin/expdp system/password SCHEMAS=EQSYS,EQ_TEST INCLUDE=TYPE dumpfile=expTYPE.dmp directory=DUMP logfile=expTYPE.log
    
    (5) Tablespace file names:
    oradata_directory/ses/OES_01.dbf
    oradata_directory/ses/OES_02.dbf
    oradata_directory/ses/OES_ASSM.dbf
    oradata_directory/ses/OES_ASSM2.dbf
    oradata_directory/ses/OES_ITAB.dbf
    oradata_directory/ses/OES_PUSH.dbf
    
Export Tablespaces, Sequences, Views, and Types

Run the expdp command in the Oracle SES 11.1.2.2 instance to export the Oracle SES 11.1.2.2 tablespaces, views, sequences, and types. Refer to the expdp options sections in the dump_tts.info file before running the following commands.

Note:

In case you get the error message "ORA-28001: the password has expired" while running the expdp commands, then reset the SYSTEM password using the following SQL scripts:
oracle_home/bin/sqlplus sys/password as sysdba

SQL> ALTER user SYSTEM identified by new_sytem_user_password;
  • Export tablespaces

    oracle_home/bin/expdp system/SES_admin_password dumpfile=expTTS.dmp directory=db_directory_object transport_tablespaces=OES,OES_ASSM,OES_ASSM2,OES_ITAB,OES_PUSH,SA1,SA2 logfile=expTTS.log
    
  • Export sequences

    oracle_home/bin/expdp system/SES_admin_password SCHEMAS=EQSYS,EQ_TEST INCLUDE=SEQUENCE dumpfile=expSEQ.dmp directory=db_directory_object logfile=expSEQ.log
    
  • Export views

    oracle_home/bin/expdp system/SES_admin_password SCHEMAS=EQSYS,EQ_TEST INCLUDE=VIEW dumpfile=expVIEW.dmp directory=db_directory_object logfile=expVIEW.log
    
  • Export types

    oracle_home/bin/expdp system/SES_admin_password SCHEMAS=EQSYS,EQ_TEST INCLUDE=TYPE dumpfile=expTYPE.dmp directory=db_directory_object logfile=expTYPE.log
    

Note:

After running the expdp command, the Oracle SES 11.1.2.2 tablespaces are set to read only. If you want to use the Oracle SES 11.1.2.2 instance, then you will have to set these tablespaces to read write using the following SQL command after importing the tablespaces into the Oracle SES 11.2.2.2 instance as described in the section "Importing Oracle SES 11.1.2.2 Tablespaces into Oracle SES 11.2.2.2 Instance":
SQL> ALTER TABLESPACE tablespace_name read write;

Exporting Oracle SES 11.1.2.2 Skin Bundle Resources

Run the exp command of Oracle sqlplus in the Oracle SES 11.1.2.2 instance to export the Oracle SES 11.1.2.2 Skin Bundle resources from the XDB repository.

oracle_home/bin/exp \'sys/password as sysdba\' tables=eqsys_resource_dump file=skin_bundle_resource.dmp log=exp_resource.log

where,

skin_bundle_resource.dmp is the name of the Skin Bundle resource dump file along with its full file path.

exp_resource.log is the name of the log file along with its full file path that is generated by the export operation.

Importing Oracle SES 11.1.2.2 Tablespaces into Oracle SES 11.2.2.2 Instance

This section describes the steps for importing Oracle SES 11.1.2.2 tablespaces into Oracle SES 11.2.2.2 database.

Create Directory and Cleanup Tablespaces for Import
  1. Connect to the Oracle SES 11.2.2.2 database as administrator using sqlplus.

    oracle_home/bin/sqlplus sys/SES_admin_password as sysdba
    
  2. Run the prepare_11222_import.sql file present in the directory ses_home /search/admin/upgrade/11.1.2.2 in the Oracle SES 11.2.2.2 instance:

    SQL> @prepare_11222_import.sql SES_admin_password dump_dir_name dump_dir_path
    

    where, dump_dir_name is the name of the directory where the dump files to be imported should be stored, and dump_dir_path is the absolute path of the dump_dir_name directory that already exists on the system.

  3. Shut down the SES managed server search_server1 and ESS managed server ess_server1.

Transfer Data Files
  1. Transfer all the dump files (expTTS.dmp, expSEQ.dmp, expVIEW.dmp, and expTYPE.dmp) to the import directory that was created after running the prepare_11222_import.sql file.

  2. Transfer all the DBF files listed in the dump_tts.info file to the Oracle SES 11.2.2.2 database DBF file location.

Import Tablespaces, Sequences, Views, and Types
  1. Set the DBFDIR environment variable to the absolute path of the directory containing the DBF files. For example, if the DBF files are in the directory /scratch/aime/ses11222/oradata, then run the following command:

    setenv DBFDIR /scratch/aime/ses11222/oradata
    
  2. Run the impdp command in the Oracle SES 11.2.2.2 instance to import Oracle SES 11.1.2.2 tablespaces, views, sequences, and types into the Oracle SES 11.2.2.2 database.

    1. Import tablespaces

      oracle_home/bin/impdp system/SES_admin_password dumpfile=expTTS.dmp
      directory=db_directory_object
      REMAP_SCHEMA=EQSYS:SEARCHSYS,EQ_TEST:SEARCHSYS
      transport_datafiles=$DBFDIR/OES_01.dbf,$DBFDIR/OES_02.dbf,$DBFDIR/OES_ASSM.dbf,
      $DBFDIR/OES_ASSM2.dbf,$DBFDIR/OES_ITAB.dbf,$DBFDIR/OES_PUSH.dbf,$DBFDIR/SA1.dbf,$DBFDIR/SA2.dbf logfile=impTTS.log
      
    2. Import sequences

      oracle_home/bin/impdp system/SES_admin_password
      REMAP_SCHEMA=EQSYS:SEARCHSYS,EQ_TEST:SEARCHSYS dumpfile=expSEQ.dmp
      directory=db_directory_object logfile=impSEQ.log
      
    3. Import views

      oracle_home/bin/impdp system/SES_admin_password
      REMAP_SCHEMA=EQSYS:SEARCHSYS,EQ_TEST:SEARCHSYS dumpfile=expVIEW.dmp
      directory=db_directory_object logfile=impVIEW.log
      
    4. Import types

      oracle_home/bin/impdp system/SES_admin_password
      REMAP_SCHEMA=EQSYS:SEARCHSYS,EQ_TEST:SEARCHSYS dumpfile=expTYPE.dmp
      directory=db_directory_object logfile=impTYPE.log
      

Note:

After you run the impdp command, you will see hundreds of error messages in the log files impTTS.log, impTYPE.log, and impVIEW.log. You can safely ignore these error messages. The following are some of the error messages that will be shown in the log files:
ORA-39082: Object type .... created with compilation warnings
ORA-39083: Object type .... failed to create with error:
ORA-31684: Object type .... already exists
ORA-39111: Dependent object type OBJECT_GRANT:.... skipped, base object .... already exists
ORA-01775: looping chain of synonyms
ORA-00942: table or view does not exist

Importing Oracle SES 11.1.2.2 Skin Bundle Resources into Oracle SES 11.2.2.2 Instance

Copy the exported Skin Bundle resource dump file (skin_bundle_resource.dmp) from the Oracle SES 11.1.2.2 instance to the Oracle SES 11.2.2.2 instance.

Run the imp command of Oracle sqlplus in the Oracle SES 11.2.2.2 instance to import the Oracle SES 11.1.2.2 Skin Bundle resources into the Oracle SES 11.2.2.2 instance.

oracle_home/bin/imp userid=\'sys/password as sysdba\' file=skin_bundle_resource.dmp fromuser=sys touser=searchsys log=imp_resource.log

where,

skin_bundle_resource.dmp is the name of the Skin Bundle resource dump file with its full file path.

imp_resource.log is the name of the log file along with its full file path that is generated by the import operation.

Running Upgrade Scripts

After importing Oracle SES 11.1.2.2 tablespaces into Oracle SES 11.2.2.2, run the following scripts to upgrade the schemas, reload types and packages, recreate views and triggers, and repopulate the initial data in the Oracle SES 11.2.2.2 instance:

  1. Set the SES_HOME environment variable to the absolute path of the SES home directory. For example, if the SES home directory absolute path is /scratch/aime/ses11222/middlware_home/Oracle_SES1, then run the following command:

    setenv SES_HOME /scratch/aime/ses11222/middleware_home/Oracle_SES1
    
  2. Connect to the Oracle SES 11.2.2.2 database as the sys user by using sqlplus.

    oracle_home/bin/sqlplus sys/SES_admin_password as sysdba
    
  3. Run the SQL script eq0upgrade-11-122.sql present in the Oracle SES 11.2.2.2 instance directory ses_home/search/admin/upgrade/11.1.2.2.

    SQL> @eq0upgrade-11-122.sql ’SEARCHSYS'
    

    Note:

    The EQ$UPG_STATUS_11222 table stores the status of running the script eq0upgrade-11-122.sql. The status shows COMPLETE for the event type of TASK when the script is executed successfully.
  4. Connect to the Oracle SES 11.2.2.2 database as Oracle SES administrator using sqlplus.

    oracle_home/bin/sqlplus searchsys/SES_admin_password
    
  5. Run the SQL script equ11-122-skinrc.sql present in the Oracle SES 11.2.2.2 instance directory ses_home/search/admin/upgrade/11.1.2.2. Running this script completes the migration of Skin Bundle resources from Oracle SES 11.1.2.2 instance to Oracle SES 11.2.2.2 instance.

    SQL> @equ11-122-skinrc.sql
    
  6. Copy all_schedules.xml and index_optimizer.xml files that were exported from Oracle SES 11.1.2.2 instance as described in the section "Export the existing Oracle SES Crawler Schedules", to the Oracle SES 11.2.2.2 directory ses_home/search/data/config.

  7. Open the script file ses_home/search/admin/upgrade/11.1.2.2/post_11222_import.sh in a text editor and specify Oracle SES 11.2.2.2 Administration URL and password.

  8. Check that the Oracle SES 11.2.2.2 instance is up by accessing the Oracle SES Administration URL.

  9. Run the script file post_11222_import.sh:

    sh post_11222_import.sh
    

Note:

In Oracle SES 11.1.2.2, the crawler job is a database job. In Oracle SES 11.2.2.2, the crawler job is an Oracle ESS job. Due to this difference, after migrating the crawler schedules from Oracle SES 11.1.2.2 instance to Oracle SES 11.2.2.2 instance, all the migrated jobs have the status Scheduled in Oracle SES 11.2.2.2 instance.

Applying Patch 17246573

Download patch 17246573 from My Oracle Support Web site https://support.oracle.com and apply it over the Oracle SES 11.2.2.2 database instance.

Manually Configuring Oracle SES 11.2.2.2 Instance

After executing the upgrade scripts, you must manually configure the Oracle SES 11.2.2.2 instance to complete the upgrade process.

Copy Oracle SES 11.1.2.2 Plug-in Files to Oracle SES 11.2.2.2 Instance

All the JAR files and configuration files of the Oracle SES 11.1.2.2 plug-ins that are not shipped out-of-box must be copied to the directories accessible from the Oracle SES 11.2.2.2 instance. The configuration information about these plug-ins should then be updated using the Oracle SES 11.2.2.2 Administration application (Administration GUI or Administration API). The following are the plug-in types for which you should verify the configuration information in the Oracle SES 11.2.2.2 instance:

  • Source Types

  • Identity Plug-in

  • Authorization Plug-in

  • Document Service Plug-in

  • UrlRewriter

Copy Oracle SES 11.1.2.2 Identity Plug-in Truststore Files to Oracle SES 11.2.2.2 Instance

Verify the Truststore location file paths of the following Identity plug-ins using the Oracle SES 11.2.2.2 Administration GUI page Global Settings - Identity Management Setup and make sure that the file paths specified in the configuration parameter Truststore location for SSL of these Identity plug-ins are accessible from the Oracle SES 11.2.2.2 instance.

  • OpenLDAP Directory

  • Sun Java System Directory Server

  • Active Directory

Configure Oracle SES 11.2.2.2 Data Source Types

Verify various file paths of the following data source types using the Oracle SES 11.2.2.2 Administration GUI page Home - Sources - Edit - Source Configuration and make sure that these file paths are accessible from the Oracle SES 11.2.2.2 instance.

The following table lists various data source types with their file path configuration parameters in the Oracle SES 11.2.2.2 Administration GUI.

Data Source Types Configuration Parameters
Database, Siebel 7.8, Siebel 7.8 (Public) Query File
Oracle Fusion, PeopleSoft, Oracle WebCenter, Oracle Content, Oracle E-Business, Siebel 8 Configuration, Scratch Directory
E-mail Archive
Federated User Authorization Remote Cache Config File

Configure Oracle SES 11.2.2.2 Single Sign-On Settings

If Oracle SES 11.1.2.2 instance was configured for single sign-on, then apply the same settings to Oracle SES 11.2.2.2 instance using the Administration GUI page Global Settings - Configure Single Sign-On Settings.

Configure Other Oracle SES 11.2.2.2 Settings

The configuration settings that are stored in the following files in Oracle SES 11.1.2.2 are no longer stored in files in Oracle SES 11.2.2.2 and are stored in database instead:

  • oracle_home/search/data/config/crawler.dat

  • oracle_home/search/webapp/config/search.properties

  • oracle_home/search/webapp/config/ranking.xml

  • oracle_home/search/tools/weblogic/deploy/plans/QueryPlan.xml

Oracle SES 11.2.2.2 contains the following object types corresponding to the above mentioned Oracle SES 11.1.2.2 configuration files.

Oracle SES 11.2.2.2 Object Type Corresponding Oracle SES 11.1.2.2 Configuration File Description
crawlerSetting crawler.dat Crawler configuration
queryUiConfig, clustering search.properties Query application configuration
relevanceRanking ranking.xml Query ranking configuration

The following are the steps to copy the configuration settings from the above Oracle SES 11.1.2.2 configuration files to Oracle SES 11.2.2.2 instance:

  1. Run the searchadmin command of Oracle SES 11.2.2.2 Admin API to export XML files for the object types - queryUiConfig, clustering, crawlerSetting, and relevanceRanking.

    ses_home/bin/searchadmin -u username -p password -c http://ses_admin_url/search/api/admin/AdminService export objectType -o filename.xml
    

    where,

    objectType is one of the object types - queryUiConfig, clustering, crawlerSetting, or relevanceRanking.

    filename.xml is the name of the XML file to which the specified object type configuration setting are exported to.

  2. Update the exported XML configuration file with the settings in the Oracle SES 11.1.2.2 configuration files.

    See Also:

    Oracle Secure Enterprice Search Administration Java API Guide for information about the configuration settings of the Oracle SES 11.2.2.2 object types.
  3. Run the searchadmin command of Oracle SES 11.2.2.2 Admin API to store the updated object type configuration settings in the Oracle SES 11.2.2.2 database.

    ses_home/bin/searchadmin -u username -p password -c http://ses_admin_url/search/api/admin/AdminService update objectType -i filename.xml -a overwrite
    

    where,

    objectType is the name of the object type and filename.xml is the name of the updated XML file for that object type.

  4. Repeat the steps 1, 2, and 3 for the object types - queryUiConfig, clustering, crawlerSetting, and relevanceRanking.

  5. To copy the configuration settings from the Oracle SES 11.1.2.2 configuration file QueryPlan.xml to Oracle SES 11.2.2.2 instance, go to the Oracle SES 11.2.2.2 Administration GUI page Global Settings - Query UI Configuration and update the appropriate configuration settings.

Restoring Oracle SES 11.1.2.2 if Upgrade Fails

If the upgrade fails, then restore the previous Oracle SES release (11.1.2.2) instance from the backup.

To restore Oracle SES from backup using the tar command: 

  1. Delete the Oracle home, oradata, and oraInventory directories.

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

    su - root
    
  3. Execute the following commands using the full path to the Oracle SES 11.1.2.2 home:

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

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

Note:

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

Post-upgrade Tasks

This section describes the steps to be performed after the upgrade process completes.

This section contains the following topics:

(Optional) Running the SQL Script eq0flat_attr.sql

You may run the optional post-upgrade SQL script eq0flat_attr.sql to improve the crawler performance. Make sure that no crawling process or query is running when this script is being executed.

To run the SQL script eq0flat_attr.sql: 

  1. Connect to the Oracle SES 11.2.2.2 database as Oracle SES administrator using sqlplus:

    oracle_home/bin/sqlplus searchsys/SES_admin_password as sysdba
    
  2. Run the SQL script eq0flat_attr.sql present in the directory ses_home/search/admin/scripts.

    SQL> @eq0flat_attr.sql
    

Note:

The SQL script eq0flat_attr.sql may take several minutes to complete. You can monitor the progress of this script by opening another sqlplus session as SES admin user and periodically checking the output of the script:
SQL> SELECT count(*) FROM eq$attr_val_tab;

(Optional) Configuring Secure Sockets Layer for Oracle SES

As Oracle SES uses Oracle HTTP Server, Oracle recommends that Oracle SES be configured to use Secure Sockets Layer (SSL) with the client-side authentication for communication with the Oracle HTTP Server. If you have configured SSL for Oracle SES 11.1.2.2, then you must manually reconfigure SSL for Oracle SES 11.2.2.2. You can configure SSL using the WebLogic Administration Console. Refer to the section "SSL and HTTPS Support in Oracle Secure Enterprise Search" of Oracle Secure Enterprise Search Administrator's Guide for the steps to configure SSL for Oracle SES.

(Optional) Configuring Oracle Single Sign-On for Oracle SES

If you have configured Oracle Single Sign-On (SSO) for Oracle SES 11.1.2.2, then after upgrading to Oracle SES 11.2.2.2, you must manually reconfigure SSO for Oracle SES 11.2.2.2. You can configure SSO using the WebLogic Server Administration Console. Refer to the section "Configuring Secure Search with OracleAS Single Sign-On" of Oracle Secure Enterprise Search Administrator's Guide for the steps to configure SSO for Oracle SES.

Starting and Stopping Oracle SES Instance

You can start and stop the Oracle SES instance (Oracle SES server, Oracle ESS server, WebLogic server, and Oracle Database server) using any of the following methods:

Using WebLogic Administration Console

You can start and stop the Oracle SES middle tier components (WebLogic Server, Oracle ESS Server, and Oracle SES Server) using the WebLogic Administration Console.

Using WebLogic Server Scripts

You can use the following WebLogic Server scripts to start and stop the Oracle SES middle tier components (WebLogic Server, Oracle ESS Server, and Oracle SES Server):

WebLogic Server Script Description
wls_domain_home/ses_domain_name/startWebLogic.sh Start the WebLogic Server middle tier
wls_domain_home/ses_domain_name/bin/stopWeblogic.sh Stop the WebLogic Server middle tier
wls_domain_home/ses_domain_name/bin/startManagedWebLogic.sh ess_server_name Start the Oracle ESS server
wls_domain_home/ses_domain_name/bin/stopManagedWebLogic.sh ess_server_name admin_URL user_name password Stop the Oracle ESS server
wls_domain_home/ses_domain_name/bin/startManagedWebLogic.sh ses_server_name Start the Oracle SES server
wls_domain_home/ses_domain_name/bin/stopManagedWebLogic.sh ses_server_name admin_URL user_name password Stop the Oracle SES server

Using searchctl Command

You can use the searchctl command for starting and stopping the Oracle SES instance only when both the Oracle Database and the WebLogic Server middle tier are installed by selecting the Oracle SES installation option Install and configure Oracle Secure Enterprise Search with Database and Middle Tier.

Note:

The searchctl command is not supported by Oracle SES, if the Oracle SES software is installed by selecting the installation option Install and configure Oracle Secure Enterprise Search with Middle Tier or Install Oracle Secure Enterprise Search software only.

The searchctl executable is located in the ses_home/bin directory. The searchctl command syntax is as follows:

Command Description
searchctl start Start Oracle SES server
searchctl stop Shut down Oracle SES server
searchctl restart Restart Oracle SES server
searchctl start_midtier Start WebLogic Server middle tier
searchctl stop_midtier Shut down WebLogic Server middle tier
searchctl restart_midtier Restart WebLogic Server middle tier
searchctl start_backend Start Oracle Database server
searchctl stop_backend Shut down Oracle Database server
searchctl restart_backend Restart Oracle Database server
searchctl startall Start Oracle SES server, WebLogic Server middle tier, and Oracle Database server
searchctl stopall Stop Oracle SES server, WebLogic Server middle tier, and Oracle Database server
searchctl restartall Restart Oracle SES server, WebLogic Server middle tier, and Oracle Database server

Note:

You must provide the Oracle SES administrator password when running the searchctl command on Linux and UNIX systems. If the middle tier port is less than 1024, then the searchctl command for starting or stopping the WebLogic Server middle tier must be run by the root user.

What To Do Next

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

  • Follow the Oracle SES tutorial:

    http://www.oracle.com/pls/topic/lookup?ctx=E35215-01&id=tut_ses_administration

  • Log on to the Oracle SES Administration GUI, using the user name and password set during the installation. With the Administration GUI you can:

    • Define sources to search

    • Configure and schedule the crawling of the sources

    • Monitor the status and performance of crawling and search operations

    Click the Help link on the top right corner of any page in the Administration GUI 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 using the URL: http://host:port/monitor/check.jsp. When the Oracle SES instance is available, the URL displays the message:

    Oracle Secure Enterprise Search instance is up.
    

    Note:

    This message is not translated to other languages, because system monitoring tools may byte-compare this string.

    If the Oracle SES instance is not available because the database server is down, but the WebLogic Server middle tier is running, then the URL displays the message:

    Oracle Secure Enterprise Search instance is down !!!
    

    If the Oracle SES instance is not available because the WebLogic Server middle tier is down, then the URL displays either the 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

http://www.oracle.com/technetwork/community/join/index.html

If you have a user name and password for OTN, then you can go directly to the documentation section of OTN at

http://www.oracle.com/technetwork/indexes/documentation/index.html

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

http://www.oracle.com/support

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

My Oracle Support options include:

  • Service Request (SR) access

  • Patch downloads

  • Bug database query access

  • Product life-cycle information

You can access My Oracle Support at

https://support.oracle.com

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.


Oracle Secure Enterprise Search Installation and Upgrade Guide, 11g Release 2 (11.2.2.2) IBM AIX on POWER Systems (64-Bit)

E35068-07

Copyright © 2006, 2014, Oracle and/or its affiliates. All rights reserved.

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.