1 Planning the Oracle Unified Directory Installation

This chapter describes the planning you should do, including information you should consider, before installing Oracle Unified Directory.

This chapter includes the following sections:

1.1 Checking the System Requirements for Oracle Unified Directory

Before you install Oracle Unified Directory or any related products, check the certification matrix and system requirements to ensure that your environment meets the minimum requirements for the products you are installing. The following documents are available on the Oracle Technology Network (OTN):

1.1.1 Pre-Installation System Notes

Pre-installation considerations for Oracle Unified Directory include the following:

  • On Windows systems you must have administrator privileges to install the Oracle Unified Directory software.

  • Before running the installer, set the DISPLAY environment variable on your system.

  • On UNIX and Linux systems, installation as the root user is not supported.

  • The Oracle Unified Directory software treats global, full local, and sparse zones as an independent physical system. Installing Oracle Unified Directory in any type of Solaris zone is therefore like installing on an independent system. Oracle Unified Directory does not share services or file locations with other zones.

1.1.2 Running the Oracle Identity and Access Management Health Checker

The Health Checker is a tool you can run to test various configurations in an Oracle Identity and Access Management environment. You can run the Health Checker at the post-configuration stage of an Oracle Unified Directory deployment.

The Health Checker retrieves data from your environment and compares this data with the Oracle recommended values for the various configuration settings. The Health Checker then generates a report that provides detailed information about each of the items that it checked.

For more information, including how to run the Health Checker, see the Oracle Fusion Middleware Verifying Your Oracle Identity and Access Management Environment.

This guide also provides manual checklists for deploying Oracle identity and Access Management components in production, including a checklist for Oracle Unified Directory.

1.2 Selecting an Oracle Unified Directory Server Role

Oracle Unified Directory can function in the following three modes or roles:

The following sections describe which Oracle Unified Directory mode you should use, based on your requirements.

As a general rule, the use of the generic term server can apply to the directory server, proxy server, or replication gateway.

1.2.1 About Oracle Unified Directory as a Directory Server

To create an LDAP directory server that contains directory data, set up Oracle Unified Directory as a directory server. For more information, see Chapter 3, "Setting Up Oracle Unified Directory as a Directory Server."

1.2.2 About Oracle Unified Directory as a Proxy Server

When you set up Oracle Unified Directory as an LDAP proxy server, the server acts as an interface between the client and a remote LDAP server containing the data. The proxy server manages the client requests through load balancing, data distribution, or both. The proxy does not contain any data. The proxy can also manipulate the data sent by the client or received from the remote LDAP servers (for example, DN renaming, RDN changing, transformation, or Enterprise User Security).

When you use the Oracle Unified Directory proxy, your data is stored in one or more remote LDAP servers or data centers, which can be any LDAPv3-compliant directory server such as Oracle Unified Directory directory server or Oracle Directory Server Enterprise Edition.

For more information, see Chapter 4, "Setting Up Oracle Unified Directory as a Proxy Server."

1.2.3 About Oracle Unified Directory as a Replication Gateway

When you set up Oracle Unified Directory as a replication gateway, the server acts as a gateway that enables replication between Oracle Directory Server Enterprise Edition and Oracle Unified Directory.

For more information, see Chapter 5, "Setting Up Oracle Unified Directory as a Replication Gateway."

1.3 Setting the JAVA_HOME Environment Variable

You must provide Oracle Unified Directory with information about the location of the Java installation by setting the JAVA_HOME environment variable. The setup scripts will not work if the JAVA_HOME environment variable is not set or does not point to a supported Java installation (JRE 7 or JDK 7).

For example, on UNIX or Linux systems, run a command similar to the following, depending on your shell:

$ export JAVA_HOME=/usr/lang/JAVA/jre1.7

Or, on Windows systems:

  1. Right click the Computer icon on your Desktop and select Properties.

  2. In the System window select Advanced system settings in the left pane.

  3. In the System Properties window select the Advanced tab and click Environment Variables.

  4. In the Environment Variables window, click New under the User variables pane.

  5. In the New User Variable window, enter the following information:

    • Variable name: Enter JAVA_HOME

    • Variable value: Enter the path to a supported Java installation (JRE 7 or JDK 7). For example:

      C:\Program Files\Java\jdk1.7.0
  6. Click OK.


You can also set the JAVA_HOME by running a command similar to the following:
set JAVA_HOME=C:\Program Files\Java\jdk1.7.0

1.4 Understanding the Oracle Unified Directory Installation Directories

During the software installation, you are asked to specify several installation directories. It is helpful to have an understanding of those directories and what they contain when installation is complete. The following directories are created:

1.4.1 Oracle Middleware Home Location

Oracle Middleware home is the directory under which Oracle Unified Directory, Oracle WebLogic Server, and Oracle Application Development Framework are installed. Oracle WebLogic Server and the Application Development Framework must be installed if you plan to manage Oracle Unified Directory using Oracle Directory Services Manager (ODSM).


If you are planning to install Oracle Unified Directory, Oracle WebLogic Server, and Oracle ADF, you must install all three components using the same Middleware home directory.

1.4.2 Oracle Home Directory

An Oracle home contains installed files necessary to host a specific product. The Installer installs the files required to host the component, such as binaries and libraries, in the Oracle Home directory. It contains the Oracle Unified Directory setup files to set up individual instances. Also contains the default schema files for all server instances associated with that OUD_ORACLE_HOME.

An Oracle home resides within the directory structure of the Middleware home. Each Oracle home can be associated with multiple Oracle instances or Oracle WebLogic Server domains.

The default OUD_ORACLE_HOME directory is Oracle_OUD1.

1.4.3 Oracle Common Directory

The installer creates this directory under the location you enter in the Oracle Middleware Home Location field. This directory contains the Application Development Framework.

The default directory is oracle_common.

1.4.4 Oracle WebLogic Domain Directory

A WebLogic domain includes a special WebLogic Server instance called the Administration Server, which is the central point from which you configure and manage all resources in the domain.

Usually, you configure a domain to include additional WebLogic Server instances called Managed Servers. You deploy Java components, such as Web applications, EJBs, and Web services, and other resources to the Managed Servers and use the Administration Server for configuration and management purposes only.

The directory structure of a domain is separate from the directory structure of the WebLogic Server home. It can reside anywhere; it need not be within the Middleware home directory. A domain is a peer of an Oracle instance.

By default, the Oracle Fusion Middleware Configuration Wizard creates a domain as subdirectory in a directory named user_projects under your Middleware Home directory (MW_HOME).

1.4.5 Oracle Unified Directory Installation Directory Structure

The following example shows the directory structure of an Oracle Unified Directory installation on a single host using all of the default values.

In this example, install-directory can be any directory on your system. This directory is empty before you install Oracle Unified Directory.

Example 1-1 Oracle Unified Directory Installation Directory Structure



If you are planning to manage Oracle Unified Directory with Oracle Directory Services Manager (ODSM), you must also install Oracle WebLogic Server and Oracle ADF. You must specify the same Middleware home directory to install all three products.