Skip Headers
Oracle® Identity Manager Installation and Configuration Guide for JBoss Application Server
Release 9.1.0

Part Number E10369-04
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
View PDF

4 Installing and Configuring a Database For Oracle Identity Manager

Oracle Identity Manager requires a database. You must install and configure your database before you begin the Oracle Identity Manager installation. Refer to the topic that applies to your database:

4.1 Using an Oracle Database for Oracle Identity Manager

To use Oracle Database as your database, you must perform the tasks described in the following sections:

4.1.1 Installing Oracle Database

Install Oracle9i Database or Oracle Database 10g release 2 by referring to the documentation delivered with Oracle Database. See Oracle Identity Manager Release Notes for the specific supported versions. Oracle recommends using the Basic installation.

Note:

If you choose the Custom installation, you must include the JVM option, which is required for XA transaction support.

4.1.2 Creating an Oracle Database

You must create a new Oracle database instance for Oracle Identity Manager. When creating the database, ensure that you configure the Oracle JVM feature and enable query rewrite.

You can use the Database Configuration Assistant (DBCA) tool to create the database. To configure the Oracle JVM feature, select the Oracle JVM feature on the Standard Database Features page of the DBCA.

To enable the database for query rewrite, set the initialization parameters QUERY_REWRITE_ENABLED to TRUE and QUERY_REWRITE_INTEGRITY to TRUSTED in the All Initialization Parameters field of the DBCA.

Note:

For the Oracle Identity Manager installation, Oracle recommends that you configure a minimum block size of 8K for Oracle Database.

See Oracle Database documentation for detailed instructions on creating a database instance.

4.1.2.1 Configuring the Database for Globalization Support

For globalization support for Oracle Identity Manager, Oracle recommends configuring the database for Unicode. To configure the database for Unicode, perform the following steps:

  1. Select AL32UTF8 in the Character Sets tab of the DBCA. This character set supports the Unicode standard.

  2. Set the NLS_LENGTH_SEMANTICS initialization parameter to CHAR in the All Initialization Parameters field of the DBCA.

See Also:

Oracle Identity Manager Globalization Guide for information about globalization support for Oracle Identity Manager

4.1.3 Preparing the Oracle Database

After you install Oracle Database and created a database instance, you must prepare it for Oracle Identity Manager by completing the following tasks:

  • Verify that query rewrite is enabled

    Note:

    Query rewrite is applicable only if you are using Oracle Database Enterprise Edition.
  • Enable XA transactions support

    Note:

    Java Virtual Machine (JVM) is required to enable XA transaction support. If you did not install the Oracle JVM component during Oracle Database installation, then you must install it now. See the Oracle Database documentation for specific instructions.
  • Create at least one tablespace for storing Oracle Identity Manager data

  • Create a database user account for Oracle Identity Manager

You can perform the preceding tasks to prepare your Oracle database for Oracle Identity Manager by running one of the following scripts:

  • On UNIX, run the following:

    prepare_xl_db.sh

  • On Microsoft Windows, run the following:

    prepare_xl_db.bat

Both of these scripts ship with the Oracle Identity Manager Installer and are located in the /installServer/Xellerate/db/oracle/ directory.

You must observe the following prerequisites when using the prepare_xl_db script:

  • The script must be run by a user holding DBA privileges (for example, the oracle user on UNIX typically holds these privileges).

  • The script must be run on the computer on which the database resides.

To prepare your Oracle database for Oracle Identity Manager, complete the steps associated with the operating system on the computer hosting your Oracle database.

4.1.3.1 Preparing the Database on UNIX

To prepare the database on UNIX:

  1. Copy the scripts prepare_xl_db.sh and xell_db_prepare.sql from the distribution CD to a directory on the computer hosting your database on which you (as the account user performing this task) have write permission.

  2. Run the following command to enable permission to run the script:

    chmod 755 prepare_xl_db.sh

  3. Run the prepare_xl_db.sh script by entering the following command:

    ./prepare_xl_db.sh

  4. Provide information appropriate for your database and host computer when the script prompts you for the following items:

    • The location of your Oracle home (ORACLE_HOME)

    • The name of your database (ORACLE_SID)

    • The name of the Oracle Identity Manager database user to be created

    • The password for the Oracle Identity Manager database user

    • The name of the tablespace to be created for storing Oracle Identity Manager data

    • The directory in which to store the data file for the Oracle Identity Manager tablespace

    • The name of the data file (you do not need to append the .dbf extension)

    • The name of the temporary tablespace

  5. Check the prepare_xl_db.lst log file located in the directory from which you ran prepare_xl_db.sh to see the execution status and additional information.

    Note:

    If you encounter errors after running the prepare_xl_db.sh script, run the following command to ensure that prepare_xl_db.sh is executable on UNIX and Linux and then run the prepare_xl_db.sh script again.
    $ dos2unix prepare_xl_db.sh
    

4.1.3.2 Preparing the Database on Microsoft Windows

To prepare the database on Microsoft Windows:

  1. Copy the scripts prepare_xl_db.bat and xell_db_prepare.sql from the distribution CD to a directory on the computer hosting your database on which you (as the account user performing this task) have write permission.

  2. Open a command window, navigate to the directory to which you just copied the scripts, then run prepare_xl_db.bat with the following arguments:

    prepare_xl_db.bat ORACLE_SID ORACLE_HOME
    XELL_USER XELL_USER_PWD TABLESPACE_NAME
    DATAFILE_DIRECTORY DATAFILE_NAME
    XELL_USER_TEMP_TABLESPACE SYS_USER_PASSWORD
    

    For example, the string you enter on the command line might look like the following:

    prepare_xl_db.bat XELL C:\oracle\ora92 xladm xladm
    xeltbs C:\oracle\oradata xeltbs_01 TEMP manager
    

    Table 4-1 lists the options used in the preceding example of prepare_xl_db.bat.

    Table 4-1 Options for the prepare_xl_db.bat Script

    Argument Description

    XELL

    Name of the database

    C:\oracle\ora92

    Directory where the Oracle database is installed

    xladm

    Name of the Oracle Identity Manager user to be created

    xladm

    Password for the Oracle Identity Manager user

    xeltbs

    Name of the tablespace to be created

    C:\oracle\oradata

    Directory where the data files will be placed

    xeltbs_01

    Name of the data file (you do not need to include the .dbf extension)

    TEMP

    Name of the temporary tablespace that already exists in your database

    manager

    Password for the SYS user


  3. Check the prepare_xell_db.lst log file located in the directory from which you ran prepare_xl_db.bat to see the execution status and additional information.

4.1.3.3 Evaluating Script Results

If the script returns a message indicating successful execution, you can continue to the next task, which is installing Oracle Identity Manager.

If the script does not succeed, you must manually fix all fatal (nonrecoverable) errors so that the database is prepared successfully.

You can ignore all non-fatal errors. For example, when the script tries to drop a non-existent view, it will return the error "ORA-00942: table or view does not exist".

Ensure to scan all the errors in the log file and ignore or resolve them on an individual basis. Remember that you must successfully prepare the database for Oracle Identity Manager before you can install Oracle Identity Manager.

4.1.4 Removing Oracle Identity Manager Entries from an Oracle Database

To remove Oracle Identity Manager entries from an Oracle database after removing (deinstalling) the Oracle Identity Manager product, drop the database user holding the Oracle Identity Manager schema.

4.2 Using Oracle RAC Databases for Oracle Identity Manager

This section explains how to deploy Oracle Real Application Clusters (Oracle RAC) databases for Oracle Identity Manager and contains the following sections:

4.2.1 Installing Oracle Identity Manager for Oracle RAC

Oracle RAC is a cluster database with a shared cache architecture that provides highly scalable and available database solutions. Oracle RAC consists of multiple database instances on different computers acting in tandem to provide these features.

Note:

The Oracle Identity Manager Installer program does not provide support for Oracle RAC. To deploy Oracle Identity Manager for Oracle RAC, you must install Oracle Identity Manager on a single database instance in Oracle RAC and then change the application server settings, specifically the connection pool parameters, to use the Oracle RAC JDBC connection string.

Use the following steps to install Oracle Identity Manager for Oracle RAC:

  1. Ensure Oracle RAC is properly set up and configured with the Oracle Identity Manager schema owner.

  2. Start the Oracle Identity Manager Installer.

  3. On the Database Parameters page of the installer, enter the host name, port number, and database name of a single database instance in Oracle RAC.

  4. Complete the Oracle Identity Manager installation by performing the steps in the installer.

  5. Configure your application server for Oracle RAC by referring to Configuring JBoss Application Server for Oracle RAC.

4.2.2 Oracle RAC Net Services

The net services name entry for an Oracle RAC database differs from that of a conventional database. The following is an example of the net services name entry for an Oracle RAC database:

racdb= 
      (DESCRIPTION= 
              (LOAD_BALANCE=off)
              (FAILOVER=on)
              (ADDRESS_LIST=
                      (ADDRESS=(protocol=tcp)(host=node1-vip)(port=1521))
                      (ADDRESS=(protocol=tcp)(host=node2-vip)(port=1521))) 
      (CONNECT_DATA=
              (SERVER=DEDICATED)
              (SERVICE_NAME=racdb)))

Table 4-2 lists and describes the parameters in a net services name entry for an Oracle RAC database.

Table 4-2 Parameters for Oracle RAC Database Net Services Name Entries

Parameter Description

LOAD_BALANCE

Specifies whether client load balancing is enabled (on) or disabled (off). The default setting is on.

FAILOVER

Specifies whether failover is enabled (on) or disabled (off). The default setting is on.

ADDRESS_LIST

Specifies the list of all the nodes in Oracle RAC, including their host names and the ports they listen on.


4.2.3 JDBC and Oracle RAC

JDBC client applications using the Thin driver to connect to an Oracle RAC database must use the Oracle RAC net services name as a part of the JDBC URL. The entire Oracle RAC net services name is concatenated and the entire string is used in the JDBC URL so the client application can connect to Oracle RAC.

The following sample code shows how a JDBC URL is used to connect to an Oracle RAC database:

//String url = "jdbc:oracle:thin:@dbhost:1521:dbservice"
String racUrl =
"jdbc:oracle:thin:@(DESCRIPTION=(LOAD_BALANCE=off)(FAILOVER=on)(ADDRESS_LIST=(ADDRESS=(protocol=tcp)(host=node1-vip)(port=1521))(ADDRESS=(protocol=tcp)(host=node2-vip)(port=1521)))(CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_NAME=racdb)))";

       String strUser = "username";
       String strPW = "password";

       // load Oracle driver   
       Class.forName("oracle.jdbc.driver.OracleDriver");   

       // create the connection
       con = DriverManager.getConnection(strURL, strUser, strPW);

The subsequent sections about configuring application servers for Oracle RAC databases explain how to modify connection pools to use a similar JDBC URL so the application server can communicate with Oracle RAC.

4.2.4 Configuring JBoss Application Server for Oracle RAC

Note:

JBoss Application Server clustered environments are not supported in Oracle Identity Manager release 9.1.0. See "Certified Components" in Oracle Identity Manager Release Notes for information about certified components.

This section explains how to configure JBoss Application Server (nonclustered or clustered) for Oracle RAC by ensuring the data sources and connection pools are configured to use the Oracle RAC JDBC connection string.

See:

For information about avoiding split branches of a distributed transaction between Oracle Identity Manager and RAC, see Best Practices for Using XA with RAC document. You can find this document by searching the Oracle Technology Network at

http://www.oracle.com/technology/index.html

Perform the following steps to configure both non-clustered and clustered JBoss Application Server for Oracle RAC:

  1. Get the RAC net services name from the tnsnames.ora file.

  2. Construct the RAC JDBC URL by referring to JDBC and Oracle RAC.

  3. Open the OIM_HOME/xellerate/config/xlconfig.xml file.

  4. Locate the <DirectDB> section and replace the value of the <url>...</url> tag with the RAC JDBC URL. For example, the new tag can be similar to the following:

    <url>jdbc:oracle:thin:@(DESCRIPTION=(LOAD_BALANCE=off)(FAILOVER=on)(ADDRESS_
    LIST=(ADDRESS=(protocol=tcp)(host=node1-vip)(port=1521))(ADDRESS=(protocol=tcp)
    (host=node2-vip)(port=1521)))(CONNECT_DATA=(SERVER=DEDICATED)(SERVICE_
    NAME=racdb)))</url>
    
  5. Save and close the OIM_HOME/xellerate/config/xlconfig.xml file.

  6. If you are configuring a nonclustered JBoss Application Server environment, open the JBOSS_HOME/server/default/deploy/xell-ds.xml file.

    If you are configuring a clustered JBoss Application Server environment, open the JBOSS_HOME/server/all/farm/xell-ds.xml file for each node in the cluster.

    These files contain entries with the XA and non-XA datasources.

  7. Locate the <datasources>.<local-tx-datasource>.<connection-url> entry.

  8. Change the value of this entry to the JDBC URL described in step 4.

  9. Locate the <datasources>.<xa-datasource>.<xa-datasource-property name="URL"> entry.

  10. Change the value of this entry to the JDBC URL described in step 4.

  11. Save and close the file.

  12. Restart JBoss Application Server. For JBoss clusters, restart all nodes in the cluster.

4.3 Using a Microsoft SQL Server Database for Oracle Identity Manager

Note:

Microsoft SQL Server is not supported in Oracle Identity Manager release 9.1.0. See "Certified Components" in Oracle Identity Manager Release Notes for information about certified components.

To use Microsoft SQL Server for your database, you must complete the procedures in the following sections:

After you have completed these tasks, you are ready to install the Oracle Identity Manager components.

4.3.1 Installing and Configuring Microsoft SQL Server

To install and configure SQL Server for Oracle Identity Manager:

  1. Install Microsoft SQL Server 2000 with Service Pack 3a.

    During installation, choose mixed authentication mode, then set the password to sa.

    Note:

    Perform Steps 2 through 4 on the computer hosting the application server.
  2. Download the SQL Server 2000 Driver for JDBC Service Pack 3 from http://www.microsoft.com.

  3. Install SQL Server 2000 Driver for JDBC Service Pack 3.

    Note:

    Specify a short path for the installation folder, such as C:\JDBCjars, so that you can easily add the path to your CLASSPATH in the next step. If the classpath is more than 256 characters, the installer does not work properly.
  4. Locate the JDBC driver files (mssqlserver.jar, msbase.jar, and msutil.jar).

    Add their location to the system CLASSPATH environment variable. If the CLASSPATH environment variable does not exist, you must create it. The string you add should look like the following:

    C:\jdbc_install_folder\lib\mssqlserver.jar;
    C:\jdbc_install_folder\lib\msbase.jar;
    C:\jdbc_install_folder\lib\msutil.jar;
    

    In these sample strings, jdbc_install_folder is the location where the SQL Server 2000 Driver for JDBC files is installed.

  5. Enable distributed transactions by installing SQL Server JDBC XA procedures.

    Copy the sqljdbc.dll file in the SQLServer JDBC Driver\SQLServer JTA\ directory to the following directory:

    C:\Program Files\Microsoft SQl Server\MSSQL\Binn

  6. Run the script instjdbc.sql.

    Follow the instructions for installing stored procedures for Java Transaction APIs (JTA). These instructions are bundled with the SQL Server 2000 Driver for JDBC (see the jdbcsqlsrv9.html Help file).

  7. Ensure that the Distributed Transaction Coordinator (MSDTC) service for your SQL Server is running.

    If necessary, use the SQL Server Service Manager to start it.

Note:

You can set the Distributed Transaction Coordinator to start automatically whenever the operating system is restarted.

4.3.2 Configuring JBoss Application Server for Microsoft SQL Server

After installing JBoss Application Server, set up JBoss to work with SQL Server by copying (not moving) the following JDBC driver files to the lib directory of your default JBoss server:

  • mssqlserver.jar

  • msbase.jar

  • msutil.jar

Copy the files from the SQL Server 2000 Driver for JDBC library directory (the default is C:\Program Files\Microsoft SQL Server 2000 Driver for JDBC\lib) to JBOSS_HOME\server\default\lib.

Note:

- For a JBoss Application Server cluster, copy (do not move) the files from the SQL Server 2000 Driver for JDBC library directory to JBOSS_HOME\server\all\lib.

- JBoss Application Server clustered environments are not supported in Oracle Identity Manager release 9.1.0. See "Certified Components" in Oracle Identity Manager Release Notes for information about certified components.

4.3.3 Registering Microsoft SQL Server

To register Microsoft SQL Server:

  1. Start the SQL Server Enterprise Manager application.

    From the Windows Start Menu, select Programs, select Microsoft SQL Server, then select Enterprise Manager.

  2. In the left pane of the SQL Server Enterprise Manager application window, select Console Root, then select Microsoft SQL Servers.

  3. Right-click SQL Server Group and select New SQL Server Registration.

  4. In the Register SQL Server Wizard dialog, click Next.

  5. On the Select a SQL Server page, perform one of the three following sub-steps:

    • Select your server from the list in the right pane, click Add, then click Next.

    • Select LOCAL, then click Add, then click Next.

    • Enter the host name of your server in the text entry box, click Add, then click Next.

  6. On the Select an Authentication Mode page, select The SQL Server login information that was assigned to me by the administrator [SQL Server Authentication], then click Next.

  7. On the Register Connection Option page, select Login automatically using my SQL server account information, then complete the following sub-steps:

    1. In the Login name field, enter the account name used to connect to your SQL server. Typically, this is sa.

    2. In the Password field, enter the password associated with the account name you specified, then click Next.

  8. On the Select SQL Server Group page, select Add the SQL Server(s) to an existing SQL Server Group, select a group from the Group name list, then click Next.

  9. On the Completing the Register SQL Server Wizard page, click Finish, then click Done.

4.3.4 Creating a Microsoft SQL Server Database

The following procedure describes how to create a new database for Oracle Identity Manager.

Note:

In the following procedure uses the name XELL for the database. You are not required to use XELL as the name for the database. This document refers to the name of the database as XELL throughout.

To create a SQL Server database, complete these steps:

  1. Start the Microsoft SQL Server Enterprise Manager application. To do so, from the Windows Start Menu, select Programs, select Microsoft SQL Server, then select Enterprise Manager.

  2. In the left pane of the SQL Server Enterprise Manager application window, select Console Root, select Microsoft SQL Servers, select the server group to which your server belongs, then double-click the icon representing your server.

  3. Right-click Databases, then select New Database.

  4. In the Database Properties dialog, select the General tab, then enter XELL in the Name field.

  5. Select the Data Files tab. Then, for the Initial Size and Filegroup columns in the Database files matrix, enter the information from the corresponding columns in Table 4-3.

    Table 4-3 Database Files

    File Name Initial Size in Megabytes (MB) Filegroup Name Content

    XELL_PRIMARY

    100

    PRIMARY

    System objects required for SQL Server operation

    XELL_DATA

    500

    XELL_DATA

    Physical data and primary keys

    XELL_INDEX

    300

    XELL_INDEX

    Indexes

    XELL_TEXT

    500

    XELL_TEXT

    Large text fields

    XELL_UPA

    1000

    XELL_UPA

    Keys for the User Profile Audit component


    Note:

    Table 4-3 lists initial sizes for a production environment. For non-production installations, you can use the default initial sizes provided for the filegroups.

    To ensure successful installation of Oracle Identity Manager, filegroup names must be entered exactly as they appear in Table 4-3. You can vary the File Name and Location strings to match the database name and the location of your Microsoft SQL Server installation.

    1. Select Automatically Grow File.

    2. Select By Percent, then enter 10 in the associated field.

    3. Select Unrestricted file growth.

    Note:

    The PRIMARY filegroup contains the system objects required for SQL Server to operate. The XELL_DATA filegroup stores the physical data and primary keys, XELL_INDEX filegroup stores indexes, XELL_TEXT stores large text fields, and XELL_UPA stores the physical data and primary keys of the User Profile Audit component.
  6. Select the Transaction Log tab, then change the initial size to 500 MB. Leave all the other options on the tab at their default values.

    Note:

    For non-production installations, you can use the default initial size for the log file.
  7. Click OK to start creating the database.

4.3.5 Creating a Microsoft SQL Server Database Account

The following procedure describes how to create a database account for Oracle Identity Manager and assign appropriate permissions to that account.

Note:

The following procedure assumes the account name xladm. If you want an account name other than xladm, then specify that login instead of xladm throughout the following procedure and also when installing Oracle Identity Manager.

To create a Microsoft SQL Server database account and permissions:

  1. Start the Microsoft SQL Server Enterprise Manager application.

    From the Windows Start Menu, select Programs, select Microsoft SQL Server, then select Enterprise Manager.

  2. In the left pane of the SQL Server Enterprise Manager application window, select Console Root, select Microsoft SQL Servers, select the server group to which your server belongs, then double-click the icon representing your server.

  3. Select Security, right-click Logins, then select New Login.

  4. In the SQL Server Login Properties dialog, select the General tab.

    In the Name field, enter xladm (or a different account name that you prefer).

  5. Select SQL Server Authentication. In the Password field, enter the password associated with the account name that you specified in Step 4.

  6. In the Database box within the Defaults section, select XELL from the list.

    Leave the Language box set to <default>.

  7. Select the Database Access tab. In the upper panel, select the check box associated with XELL.

  8. In the lower panel, select the check boxes associated with the following:

    • public

    • db_owner

    • db_accessadmin

    • db_securityadmin

    • db_ddladmin

    • db_datareader

    • db_datawriter

  9. Click OK to commit your changes.

    When prompted, confirm the password and click OK.

  10. To check your database settings, right-click the icon representing your server, then select Properties from the shortcut menu.

  11. On the SQL Server Properties page, select the Security tab, then verify that Authentication is set to SQL Server and Windows.

  12. Click the General tab, then verify that the check boxes associated with Autostart SQL Server and Autostart MSDTC are selected.

    If Autostart SQL Server Agent is selected, do not change the existing setting, because that setting might be required by other applications. Click OK to close the SQL Server Properties page.

4.3.6 Removing Oracle Identity Manager Entries from a Microsoft SQL Server Database

To remove Oracle Identity Manager entries from a SQL Server database after removing (deinstalling) the Oracle Identity Manager product, perform the following steps:

  1. Delete the Oracle Identity Manager database.

  2. Delete the Oracle Identity Manager login.