4 Installing Products

This chapter includes the following sections:

Checking Prerequisites Before Installation

Before installation, Oracle Universal Installer checks the environment to see whether it meets the requirements for successful installation. Early detection of problems with the system setup reduces the chances of encountering problems during installation; for instance, problems with insufficient disk space, missing patches, inappropriate hardware, and so on.

Oracle Universal Installer is required to perform all prerequisite checks defined for the installation before installing any software, whether they are Oracle Universal Installer-specific tests, or tests defined for a specific product. Specific prerequisite checks are defined for each operating system on which Oracle Universal Installer runs. All prerequisite check parameters must be defined in the oraparam.ini file (or another *.ini file that you define). All the results are logged in the install Actions<timestamp>.log file.

You can perform prerequisite checking automatically when you run the Oracle Universal Installer executable during an installation. Simply run Oracle Universal Installer to perform all predefined prerequisite checks.

Inputs to the checker are listed in the prerequisite.xml file. After running the checker, you can find the results, along with the predefined inputs, in the prerequisite_results.xml file. These files are located in the oraInventory/logs directory. You can reuse the prerequisite_results.xml file as an input file for subsequent executions of the checker.

Installing Oracle Products

The following sections describe how to start Oracle Universal Installer and install an Oracle product. Specifically, this section describes:

Getting Help While Installing Oracle Products

At any time while installing your product, click Help for information about the screens specific to your installation.

Oracle Universal Installer provides two kinds of online help

  • Generic online help provided with every copy of Oracle Universal Installer

    These topics describe the screens and dialog boxes that all Oracle Universal Installer users see, regardless of the product they are installing.

  • Online help specific to a particular installation

    These topics are created by the product developer and describe the screens and dialog boxes specific to the product you are installing. For example, the help topic for the Installation Types page is often a custom help topic the installation developer creates that describes the specific installation types for the product you are installing.

After you view an online help topic, choose Navigator from the Tools menu to display the navigator pane. From the navigator pane, you can browse the table of contents, select other topics, or search for a particular word or phrase in the online help.


Only generic help topics are available in the navigator or table of contents. You can only access custom help topics by clicking the Help button on the dialogs or windows they describe.

About the ORAPARAM.INI File

The oraparam.ini file is the initialization file for Oracle Universal Installer. This file includes information that defines the behavior of certain Oracle Universal Installer features. Each product installation possesses a unique oraparam.ini file.

Generally, you should not have to edit the contents of this file, but in certain situations, understanding the contents of this file can help you troubleshoot problems and understand certain aspects of the Oracle Universal Installer product.

For example, for most installations, Oracle Universal Installer provides a default value on the File Locations page that points to the location of the product's installation kit or stage. This default value is stored in the oraparam.ini file. The oraparam.ini file also identifies the location of the Java Runtime Environment (JRE) required for the installation.

In the staging area, it is located in the same directory as the executable file. For example:

For UNIX systems:


For Windows systems:


In the staging area, the default OUI_LOCATION is relative to the location of the oraparam.ini file, as follows:


Once installed, the oraparam.ini file is located in the /oui directory.

Table 4-1 describes the parameters in the oraparam.ini file and how to use them.

Table 4-1 Parameters in oraparam.ini

Section/Parameter Description


This section contains various parameters related to your installation.


Set to TRUE if the oraparam.ini file is on a distribution medium. A distribution medium can be a CD-ROM or a Web server. Once installed, this parameter is set to FALSE.


Location of your staging area (the products.xml file). This location is relative to the directory where oraparam.ini exists.


Location of a text file for License information. This location is relative to the directory where oraparam.ini exists. The legal terms file should be a plain text file.If you specify the LICENSE_LOCATION variable, Oracle Universal Installer asks for license acceptance after you click the Next button on the "Welcome" screen. Oracle Universal Installer lets you proceed only after the license is accepted. This parameter is ignored if the file is not found.


The value of this variable displays as the title of the license agreement. Oracle Universal Installer only reads this value if the license dialog is displayed; that is, if the LICENSE_LOCATION variable has a valid value.


Location of the Java Runtime Environment (JRE) that the Oracle Universal Installer uses.

Note: For a single installation to point to two different JRE versions, move the oraparam.ini file one level below its original location and then specify the individual platform's JRE location. For example, if the original location is in the Disk1/install directory, move it to the Disk1/install/win32 or the Disk1/install/solaris directory, and then specify the individual platform's JRE location.


Points to the location of Oracle Universal Installer files used for interactive mode (GUI-based). This parameter is optional; if DISTRIBUTION=TRUE, Oracle Universal Installer computes this value using the OUI_VERSION parameter.Use this parameter if you want to override the default value:



Points to the location used for silent mode. This parameter is optional; If DISTRIBUTION=TRUE, then Oracle Universal Installer computes this value using the OUI_VERSION parameter.Use this parameter if you want to override the default value:



Set the version of Oracle Universal Installer that you are using. You must properly set the version for the BOOTSTRAP to work.


Set to FALSE to suppress the display of the version of top-level components in the Installation Type dialog during installation.


Set these to increase the initial heap threshold for JRE. For example, -mx48m.


Location of the default Oracle home.


The default name for the Oracle home. Use this parameter only if the installation occurs on a host with no previous Oracle installations.


Lists directories that you do not want to browse, which are typically large directories that require a long time to view. For example, /net, /nfs.


Set to TRUE for Oracle Universal Installer to enable NLS support. Set to FALSE to disable the installation session translations. Oracle Universal Installer displays in English even if you run on a non-English system.


Set to TRUE or FALSE. This parameter instructs Oracle Universal Installer to attempt a bootstrap. Set to TRUE before cutting CDs, but set to FALSE after you have copied the staging area to the hard disk.


Use this parameter to set the size the temporary space requires when BOOTSTRAP is set to TRUE. For example, when you install Oracle Universal Installer, it sets the value of this parameter to the temporary space required by both Oracle Universal Installer and the JRE.By default, if this entry is not set, Oracle Universal Installer assumes 45 MB for Win32, 52 MB for Win64, and 69 MB for Solaris. However, these values could vary from one major release to the other, based on the space required by newer versions of JRE.If the shiphome contains advertisement images, installation developers should add the space taken by the images to this value. Oracle Universal Installer checks the temp space requirements before starting up and produces an error if there is not enough space for Oracle Universal Installer to run in bootstrap mode.


Use this parameter to control whether or not Oracle Universal Installer considers the build number of the component when determining whether or not to overwrite a previous version or copy of a component. Note that this parameter is intended to be used in pre-production shiphomes only.


Use this parameter when you want your users to specify the location of an Oracle Applications top (APPL_TOP) directory. When this parameter is set to TRUE, the File Locations page includes fields for selecting an APPL_TOP directory. This is an optional parameter for use with Apps installs only. If not specified, the default is assumed to be FALSE.


This parameter is the URL where the user is directed from the Product Registration page in Oracle Universal Installer. The REGISTRATION_KEY parameter is validated at this site. Set this parameter along with the REGISTRATION_KEY parameter to invoke the Product Registration page. Both are required.


This key is validated against an encrypted key at the REGISTRATION_URL location. Set this parameter along with the REGISTRATION_URL parameter to invoke the Product Registration page. Both are required.


This section lists the images associated with an installation. To show advertisements during an installation, specify each image as a separate variable.

Modes of Installation

You can use Oracle Universal Installer to install Oracle products in any of the three following modes:

  • Interactive: Use Oracle Universal Installer's interactive mode to use the graphical user interface to walk through the installation, providing information in the installation dialogs when prompted. This method is most useful when installing a small number of products in different setups on a small number of hosts.

  • Suppressed: Use Oracle Universal Installer's suppressed mode to supply the necessary information by using a combination of a response file or command line entries with certain interactive dialogs. You can choose which dialogs to suppress by supplying the information at the command line when you invoke Oracle Universal Installer. This method is most useful when an installation has a common set of parameters that can be captured in a response file, in addition to custom information that must be input by hand.

  • Silent: Use Oracle Universal Installer's silent installation mode to bypass the graphical user interface and supply the necessary information in a response file. This method is most useful when installing the same product multiple times on multiple hosts. By using a response file, you can automate the installation of a product for which you know the installation parameters. For more information, see Chapter 3, "Customizing and Creating Response Files", for detailed information on using response files and installing in silent mode.


    You can use the -noConsole flag on the Windows platform to suppress the display of messages in the console.

Installation Media

For each of these three installation modes, you can install from three different media:


On Windows, when you start the installer from a shared drive, you need to map the shared drive and then invoke the installer from the shared drive.

The following sections discuss these different installation approaches.


When you invoke runInstaller (UNIX) or setup.exe (Windows), you should invoke it from the directory where this command is present, or you must specify the complete path to runInstaller (UNIX) or setup.exe (Windows).

Installing from a Single CD-ROM

While installing Oracle products contained on a single CD-ROM, start Oracle Universal Installer by running the executable file, setup.exe or runInstaller.sh, located in:


Where <platform> represents Win32, Win64, Solaris, Linux, and so on.

For UNIX systems, run the script by typing ./runInstaller at the command line.


Oracle Universal Installer for win64 functions like Oracle Universal Installer for win32. However, the startup directory on the CD is "win64" instead of "win32." Launching Oracle Universal Installer from the win32 directory launches Oracle Universal Installer in 32-bit mode, used for installing 32-bit software. Use win64 for installing 64-bit software.

When you install both 32-bit and 64-bit Oracle Universal Installer on a 64-bit machine, two different inventories are created and maintained. However, you cannot install 64-bit software in a 32-bit home, and vice versa.

Installing from Multiple CD-ROMs

If you are creating a multiple-CD installation on UNIX, you might need to launch runInstaller in the background using the following command:

./runInstaller &

By launching runInstaller in the background, you can change your current directory after you launch Oracle Universal Installer, enabling you to eject the CD. (It may also help to launch runInstaller as a foreground process from a different directory.)

You may want to create a shell script that launches Oracle Universal Installer in the background and then exits. If you choose to create a shell script, remember to also pass all parameters that you passed to the shell script to runInstaller in the event that you want to install silently using a response file.

TEMP/TMP Directory

On both UNIX and Windows installations, temporary copies of Oracle Universal Installer and JRE are placed in the TEMP or TMP directory in a subdirectory named /OraInstall<timestamp> so that these applications can be launched when you change CD-ROMs. Note that temporary files are created for single-CD installations as well. On both UNIX and Windows, Oracle Universal Installer looks for %TEMP% then %TMP%. If neither is set, Oracle Universal Installer defaults to /tmp on UNIX and c:\temp on Windows


.The TEMP/TMP directory should not be a cluster file system or a shared location.
Unmounting a CD

On UNIX, if you have trouble installing a product from multiple CD-ROMs, try using the following procedure to unmount the first CD-ROM and mount the second CD-ROM. If you still have problems, refer to the documentation links at the end of this topic.

In most cases, the following procedure helps with any problems you experience while switching to a second CD-ROM while installing Oracle software. If you inadvertently run the installer while the current working directory is in the CD-ROM, follow these steps to mount the next CD-ROM:

  1. Change to the root directory of your system and log in as the root user by using the following commands:

    $ cd /
    $ su root
  2. Unmount and remove the CD-ROM from the drive with the following command:

    # umount cdrom_mount_point_directory
  3. Insert and mount the next CD-ROM into the drive by using the following command:

    # mount options device_name cdrom_mount_point_directory
  4. Enter the correct mount point in the Installation dialog box.

  5. Click OK to continue.

If after attempting this procedure you are still having problems, see the section on installing from multiple CD-ROMs in the Oracle Database Installation Guide, which is available from the Oracle Technology Network:


Installing from a staged HTTP location

With Oracle Universal Installer, you can install products from the Web. You can publish your staging area from a Web server and then in the Oracle Universal Installer's Source location, specify the HTTP location for the products.xml file.

For example, you can enter:


The Oracle Universal Installer recognizes a Web staging area just like a local, network, or CD-ROM stage.

System administrators of large customers who may want to deploy Oracle software to more than one target can use a combination of the Web installation and response file features:

  1. Copy the staging area to a shared file system and make it accessible on the Intranet or a Web server.

  2. Include predetermined response files on the same location. (Different groups of users might rely on different response files.)

  3. Clients run Oracle Universal Installer locally and use the local response file that is mailed or downloaded so they can perform a silent installation.

The Web installation capability relies on some guidelines that must be followed at installation development time. Check the installation guide for your product to see if the installation of your product is certified for Web installation.

To test if your stage is Web-enabled, you can try the following procedure:

  1. Copy the stage to your Web server.

  2. Start the Oracle Universal Installer locally and point to the location of the products.xml file. For example:


Special Instructions for UNIX Users

The following sections describe special instructions that apply when you are installing certain products on a UNIX system.

Failed to Connect to Server Error

If you receive an Xlib error or a "Failed to connect to Server" error when you are running Oracle Universal Installer on the Solaris operating system, do the following:

  1. Define the following environment variable on the host computer where you are running Oracle Universal Installer:

    %setenv DISPLAY <machine name>:0.0
  2. Replace <machine name> with the name of the computer that will display Oracle Universal Installer.

  3. On the computer that will display Oracle Universal Installer, enter the following command, which enables other computers to display information on the computer's monitor:

    %xhost +
  4. Rerun the runInstaller script after you have set the DISPLAY environment variable.


You can run Oracle Universal Installer without specifying the DISPLAY variable by running in silent mode using a response file.

Providing a UNIX Installer Location with Root Privileges

You must have root privileges to perform various installation operations on the UNIX platform. For example, you must have root privileges to be able to create the Oracle Universal Installer inventory.

If you are installing Oracle Universal Installer for the first time, you are prompted to run a shell script from another terminal window before proceeding with the installation. Oracle Universal Installer prompts you to run root.sh after installation completes only if the script is required to be run as root before configuration assistants are run. Otherwise, you are prompted to run root.sh as root later.


When running Oracle Universal Installer in silent mode, if root.sh is required prior to configuration assistants, Oracle Universal Installer skips configuration assistants during the installation. You must run root.sh as root and then run the skipped configuration assistants after the silent installation is complete.

To successfully run the required shell script:

  1. Leave the Oracle Universal Installer window open and open another terminal window.

  2. In the new terminal window, use the substitute user command to log in with root privileges:

    su -root
  3. Change directory to the Oracle home into which you are currently installing your Oracle software product.

  4. Run the shell script ./root.sh.

  5. When the script is finished and you are returned to the command prompt, exit from the new terminal window and return to Oracle Universal Installer to continue the installation.


    Do not exit the installation to run the shell script. Exiting the installation removes this script.

    You are prompted to run the script only the first time you install.

Providing a UNIX Group Name

If you are installing a product on a UNIX system, the Installer also prompts you to provide the name of the group that owns the base directory.

You must choose a UNIX group name that has permissions to update, install, and remove Oracle software. Members of this group must have write permissions to the base directory chosen.

Only users who belong to this group are able to install or remove software on this host.

Deinstalling Oracle Products

You can only deinstall Oracle products by using the Deinstallation tool. For more information, see see "Removing Oracle Database Software" in the Oracle® Database Installation Guide 11g for Linux.

Running Oracle Universal Installer After Installation

The following sections describe the different ways that Oracle Universal Installer can be used after installation. Specifically, this section describes:

Starting Oracle Universal Installer

OUI is installed in the Oracle home and is available for both Windows and Unix under:

<Oracle home>/oui/bin

For all platforms, the executable file (setup.exe or runInstaller.sh) is located in the following directory:


A new version of Oracle Universal Installer replaces its older version.

To start Oracle Universal Installer:

  • On Windows platforms, select Start, Programs, Oracle Installation Products, Oracle Universal Installer.

  • On UNIX, execute ./runInstaller from the directory where it is installed.

    For example: if the Oracle home is /u01/app/oracle/, OUI will be located at OH/oui/u01/app/oracle/oui.

A runInstaller.sh script is also available, so that you can launch Oracle Universal Installer directly from a different directory.

When Oracle Universal Installer is first installed and run, it checks for the JRE path (the location from which it runs), using the location specified in the oraparam.ini file's JRE_LOCATION parameter. If Oracle Universal Installer cannot find the JRE specified, an error is returned.

Command Line Arguments

Following is the output from the runInstaller -help command, which gives you the full list of command line options and their descriptions, as well as command line variables usage:

runInstaller [-options] [(<CommandLineVariable=Value>)*]
Where options include:
-clusterware oracle.crs,<crs version> Version of Cluster ready services installed.
-crsLocation <Path> Used only for cluster installs, specifies the path to the crs home
location. Specifying this overrides Oracle Clusterware information obtained from central inventory.
-invPtrLoc <full path of oraInst.loc> Unix only. To point to a different inventory location.The orainst.loc file contains:

inventory_loc=<location of central inventory>
-jreLoc <location> Path where Java Runtime Environment is installed. OUI cannot be run
 without it.
-logLevel <level> To filter log messages that have a lesser priority level than <level>.
 Valid options are: severe, warning, info, config, fine, finer, finest, basic, general,
 detailed, trace. The use of basic, general, detailed, trace is deprecated.
-paramFile <location of file> Specify location of oraparam.ini file to be used by OUI.
-responseFile <Path> Specifies the response file and path to use.
-sourceLoc  <location of products.xml> To specify the shiphome location.
-addLangs To add new languages to an already installed product.
-addNode For adding node(s) to the installation.
-attachHome For attaching homes to the OUI inventory.
-cfs Indicates that the Oracle home specified is on cluster file system
(shared). This is mandatory when '-local' is specified so that Oracle
Universal Installer can register the home appropriately into the inventory.
-clone For making an Oracle Home copy match its current environment.
-debug For getting the debug information from OUI.
-detachHome For detaching homes from the OUI inventory without deleting
inventory directory inside Oracle home.
-enableRollingUpgrade Used in cluster environment, to enable upgrade of a product on a
subset of nodes (on which the product was installed).
-executeSysPrereqs Execute system prerequisite checks and exit.
-force Allowing silent mode installation into a non-empty directory.
-help Displays above usage.
-ignorePatchConflicts Ignore all conflicts with existing interim patches during an
upgrade. The conflicting interim patches are removed from the home.
-ignoreSysPrereqs For ignoring the results of the system prerequisite checks.
-local Performs the operation on the local node irrespective of the
cluster nodes specified.
-printdiskusage Log debug information for disk usage.
-printmemory Log debug information for memory usage.
-printtime Log debug information for time usage.
-removeAllPatches Remove all interim patches from the home
-silent For silent mode operations, the inputs can be a response file or a
list of command line variable value pairs.
-updateNodeList For updating node list for this home in the OUI inventory.
-waitforcompletion For windows. setup.exe will wait for completion instead of
spawning the java engine and exiting.
-nobackground Do not show background image
-noclusterEnabled No cluster nodes specified.
-noconsole For suppressing display of messages to console. Console is not
-nowarningonremovefiles To disable the warning message before removal of home directory.
-nowait For windows. Do not wait for user to hit Enter on the console
after the task (install etc.) is complete.
-formCluster To install the Oracle clusterware in order to form the cluster.
-remotecp <Path> Unix specific option. Used only for cluster installs, specifies
the path to the remote copy program on the local cluster node.
-remoteshell <Path> Unix specific option. Used only for cluster installs, specifies
the path to the remote shell program on the local cluster node.

Command Line Variables Usage
Command line variables are specified using <name=value>; for example:
[ session: | compName: | compName:version: ]variableName="valueOfVariable"]

Session/Installer variables are specified using:
Ex 1: session:ORACLE_HOME="OraHome"
Ex 2: ORACLE_HOME="OraHome"
The lookup order is session:varName then just varName).
The session prefix is used to avoid ambiguity.

Component variables are specified using:
Ex 1: oracle.comp1:1.0.1:varName="VarValue"
Ex 2: oracle.comp1:varName="VarValue"
Ex 2: oracle.comp1:varName="VarValue"
The lookup order is compInternalName:Version:varName, then compInternalName:varName, then just varName.

Using Oracle Universal Installer Exit Codes

If you are starting and stopping Oracle Universal Installer programmatically (for example, by invoking Oracle Universal Installer using a response file), you may need to consider the exit codes Oracle Universal Installer generates, and perform a particular action depending on the code Oracle Universal Installer returns.

Oracle Universal Installer returns one of the following exit codes:

Code Description
0 All installations were successful.
1 All installations were successful, but some optional configuration tools failed.
2 Local installations were successful, but some remote operations failed.
3 All installations were successful, but some recommended configuration tools failed.
4 The installation was stopped.
6 The installation was successful after you proceeded by disregarding a few prerequisite checks or warnings.
-1 At least one installation failed.
-2 The installation failed. One or more validation of variables failed.
-3 The attempted installation encountered a prerequisite failure. Some of the optional prerequisites have not been met. See the logs for details.

You can ignore this code if the prerequisite is optional.

Note that:

  • This feature does not work if Oracle Universal Installer is running in "bootstrap" mode. In this case, setup.exe/runInstaller just launches the JRE process and returns immediately without waiting for the exit code. Oracle Universal Installer runs in "bootstrap" mode if the following line exists in the oraparam.ini file:

  • If you exit without installing any products (for example, if you exit from the "Welcome" screen), the exit code is -1.

Cloning Considerations

You can copy an existing Oracle home, then configure it for its new environment. This process is called "cloning."


Patching and deinstallation on a cloned Oracle home act the same as a regularly installed Oracle home. You can directly patch a cloned installation.

Invoke Oracle Universal Installer in clone mode using the following command:

./runInstaller -clone ORACLE_HOME="<target location>" [-responseFile <full path>]

Use setup.exe instead of runInstaller for Windows machines. The -responseFile parameter is optional. You can supply clone-time parameters on the command line or through the response file named on the command line.

Clone-time activity is logged in the cloneActions<timestamp>.log file at installation time.

For more information on cloning see Chapter 6, "Cloning Oracle Software".


Because most cloning is done in silent mode, when cloning an Oracle home onto a "clean" host (one that has no oraInst.loc file), Oracle Universal Installer creates a Central Inventory in the location specified by the INVENTORY_LOCATION variable. If this variable is not specified, Oracle Universal Installer creates the Central Inventory in the <cloned_home>/oraInventory directory.

After cloning is finished, you must run oraInstRoot.sh as root to move oraInventory to the final, desired location.

About Oracle Universal Installer Log Files

When you install or deinstall products using Oracle Universal Installer, important information about each installation is saved not only in the inventory, but also in a series of log files located in the following directory:


You can use these log files to troubleshoot installation problems. These files are also crucial for removing and configuring the various software components you install on your Windows or UNIX computer. Oracle Universal Installer displays the name and location of the current session's log file on the Install page. Each installation or configuration utility provides a separate folder containing the installActions<timestamp>.log files inside the $ORACLE_HOME/cfgtoollogs folder.

Many exceptions can possibly occur and consequently appear in a log file, depending on the product, as shown in the following example:

globalVarQueries2.  getGlobalVariable[[.variable = oracle.assistants.server.launchNETCA]] 
[2009-09-07T01:17:46.646+00:00] [OUI] [NOTIFICATION] [] [OUI] [tid: 21] 
[ecid: 0000IEI4dFFDScApJ^^Ayf1Ad5uS00000C,0] 
[[Query Exception: VariableNotFoundException 
Query Exception Class: class oracle.sysman.oii.oiil.OiilQueryException]]

You can ignore the exception traces in the logs if the installation has subsequently continued.

Action logs are written on a per-session basis. The installer action log is created each time a new install session is started. What each action does and whether it occurred during installation or deinstallation is logged for every action in the installer action log. Each session is saved in the file, installActionstime_stamp.log, where time_stamp is of the form:


The .err and .out files also use the time stamp in their file names, making it easier to keep track of these files for each session.

Product Removal Logs vs. Action Logs

Note that the logs used to remove products are different from the installActions<timestamp>.log file generated during the installation process. The installActions<timestamp>.log is easier to read and can be used to view the operations performed during installation.


Many exceptions can possibly occur and consequently appear in a log file, depending on the product, as shown in the following example:

globalVarQueries2.  getGlobalVariable[[.variable = oracle.assistants.server.launchNETCA]] 
[2009-09-07T01:17:46.646+00:00] [OUI] [NOTIFICATION] [] [OUI] [tid: 21] 
[ecid: 0000IEI4dFFDScApJ^^Ayf1Ad5uS00000C,0] 
[[Query Exception: VariableNotFoundException 
Query Exception Class: class oracle.sysman.oii.oiil.OiilQueryException]]

You do not need to take any action if the text that follows the exception message appears to ignore the exception.