| Oracle® Identity Manager Installation Guide for JBoss Release 9.0.3 Part Number B32460-01 |
|
|
View PDF |
| Oracle® Identity Manager Installation Guide for JBoss Release 9.0.3 Part Number B32460-01 |
|
|
View PDF |
Oracle Identity Manager requires a database. You must have your database installed and configured before you begin the Oracle Identity Manager installation. Refer to the section that applies to your particular database:
To use Oracle as your database, you must perform the tasks described in the following sections:
Install the Oracle9i or 10g Release 2 database by referring to the documentation delivered with the Oracle database. Refer to the 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.You need to create a new Oracle database instance for Oracle Identity Manager. When creating the database, make sure to 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 init.ora parameters QUERY_REWRITE_ENABLED to TRUE and QUERY_REWRITE_INTEGRITY to TRUSTED in the All Initialization Parameters field of the DBCA.
Consult your Oracle database documentation for detailed instructions on creating a database instance.
For globalization support for Oracle Identity Manager, Oracle recommends configuring the database for Unicode. To configure the database for Unicode, perform the following steps:
Set the database character to AL32UTF8, which supports the Unicode standard, by selecting AL32UTF8 in the Character Sets tab of the DBCA.
Set the NLS_LENGTH_SEMANTICS init.ora parameter to CHAR in the All Initialization Parameters field of the DBCA.
See Also:
Oracle Identity Manager Globalization GuideAfter you have installed Oracle and created a database instance, you must prepare it for Oracle Identity Manager by completing the following tasks:
Verify that query rewrite is enabled
Enable XA transactions support
Note:
The Java JVM is required to enable XA transaction support. If you did not install the JVM during your Oracle installation, you must install it now. Consult Oracle 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 or Linux, run the following:
On Windows, run the following:
prepare_xl_db.bat
Both of these scripts ship with the Oracle Identity Manager installer and reside 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 the user holding dba privilege (for example, the oracle user on UNIX or Linux typically holds these privileges).
The script must be run on the machine where the database resides.
The following procedures describe how to prepare your Oracle database for Oracle Identity Manager. Complete the steps associated with the operating system on the machine hosting your Oracle database.
To prepare the database on UNIX or Linux:
Copy the scripts prepare_xl_db.sh and xell_db_prepare.sql from the distribution CD to a directory on the machine hosting your database where you (as the account user performing this task) have write permission.
Run the following command to enable permission to run the script:
chmod 755 prepare_xl_db.sh
Run the prepare_xl_db.sh script by entering the following command:
./prepare_xl_db.sh
Provide information appropriate for your database and host machine 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
Check the prepare_xl_db.lst log file located in the directory where you ran the xl_db_prepare script from to see execution status and additional information.
Note:
If you encounter errors after running the prepare_xl_db.sh script, run the following command to ensure the 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
To prepare the database on Windows:
Copy the scripts prepare_xl_db.bat and xell_db_prepare.sql from the distribution CD to a directory on the machine hosting your database where you (as the account user performing this task) have write permission.
Open a command window, navigate to the directory where 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 something 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 |
|---|---|
|
|
Name of the database |
|
|
Directory where the Oracle database is installed |
|
|
Name of the Oracle Identity Manager user to be created |
|
|
Password for the Oracle Identity Manager user |
|
|
Name of the tablespace to be created |
|
|
Directory where the datafiles will be placed |
|
|
Name of the datafile (you do not need to give .dbf extension) |
|
|
Name of the temporary tablespace that already exists in your database |
|
|
Password for the SYS user |
Check the prepare_xell_db.lst log file located in the directory where you ran the xell_db_prepare script from to see execution status and additional information.
If the script returns a message indicating successful execution, you can continue to the next task, which is Oracle Identity Manager installation.
If the script does not succeed, you must manually fix all fatal errors so that the database is prepared successfully.
You can ignore 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". This can be ignored without adverse consequences.
Make sure 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.
This section explains how to deploy Oracle RAC databases for Oracle Identity Manager and contains the following sections:
Oracle RAC is a cluster database with a shared cache architecture that provides highly scalable and available database solutions. A RAC consists of multiple database instances on different machines and acting in tandem to provide these features.
Important:
The Oracle Identity Manager installer program does not provide support for RAC. To deploy Oracle Identity Manager for RAC, you must install Oracle Identity Manager on a single database instance in the RAC and then change the application server settings, specifically the connection pool parameters, to use the RAC JDBC connection string.Use the following steps to install Oracle Identity Manager for RAC:
Ensure the RAC is properly set up and configured with the Oracle Identity Manager schema owner.
Start the Oracle Identity Manager installer program.
Enter the host name, port number, and database name of a single database instance in the RAC on the Database Parameters screen of the Oracle Identity Manager installer program.
Complete the Oracle Identity Manager installation by finishing the steps in the installer program.
Configure your application server for RAC by referring to Configuring JBoss Application Servers for Oracle RAC.
The net service 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=on)
(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 the RAC, including their host names and the ports they listen on. |
JDBC client applications using the Thin driver to connect to an Oracle RAC database must use the RAC net services name as a part of the JDBC URL. The entire RAC net services name is concatenated and the entire string is used in the JDBC URL so the client application can connect to the RAC.
The following is sample code that demonstrates an example JDBC URL used to connect to a RAC database:
//String url = "jdbc:oracle:thin:@dbhost:1521:dbservice"
String racUrl =
"jdbc:oracle:thin:@(DESCRIPTION=(LOAD_BALANCE=on)(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 the RAC.
This section explains how to configure both non-clustered and clustered JBoss application servers for Oracle RAC by ensuring the data sources and connection pools are configured to use the RAC JDBC connection string.
Note:
Before configuring JBoss application servers for Oracle RAC, you must:Get the RAC net services name from the tnsnames.ora file.
Construct the RAC JDBC URL by referring to JDBC and Oracle RAC.
Perform the following steps to configure both non-clustered and clustered JBoss application servers for Oracle RAC:
Open the <XL_HOME>/xellerate/config/xlconfig.xml file.
Locate the <DirectDB> section and replace the value of the <url>...</url> tag with the RAC JDBC URL. For example, the new tag may be similar to the following:
<url>jdbc:oracle:thin:@(DESCRIPTION=(LOAD_BALANCE=on)(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>
Save and close the <XL_HOME>/xellerate/config/xlconfig.xml file.
If you are configuring a non-clustered JBoss environment, open the <JBOSS_HOME>/server/default/deploy/xell-ds.xml file.
If you are configuring a clustered JBoss 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.
Locate the <datasources>.<local-tx-datasource>.<connection-url> entry.
Change the value of this entry to the JDBC URL described in step 2.
Locate the <datasources>.<xa-datasource>.<xa-datasource-property name="URL"> entry.
Change the value of this entry to the JDBC URL described in step 2.
Save and close the file.
Restart the JBoss application server. For JBoss clusters, restart all nodes in the cluster.
To use 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.
To install and configure SQL Server for Oracle Identity Manager:
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–4 on the machine hosting the application server.Download the SQL Server 2000 Driver for JDBC Service Pack 3 from http://www.microsoft.com.
Install SQL Server 2000 Driver for JDBC Service Pack 3.
Note:
Make sure to 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 your classpath is more than 256 characters, the installer does not work properly.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;
Where <jdbc_install_folder> is the location where the SQL Server 2000 Driver for JDBC files is installed.
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
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 help file jdbcsqlsrv9.html).
Make sure the Distributed Transaction Coordinator (MSDTC) service for your SQL Server is running.
If necessary, use the SQL Server Service Manager to start it.
Tip:
Set the Distributed Transaction Coordinator to auto-start whenever your operating system starts.After installing JBoss, 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 cluster, copy (do not move) the files from the SQL Server 2000 Driver for JDBC library directory to <JBOSS_HOME>\server\all\lib.Start the Microsoft SQL Server Enterprise Manager application.
From the Windows Start Menu, select Programs, select Microsoft SQL Server, then select Enterprise Manager.
In the left pane of the SQL Server Enterprise Manager application window, select Console Root, then select Microsoft SQL Servers.
Right-click SQL Server Group and select New SQL Server Registration.
In the Register SQL Server Wizard dialog, click Next.
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.
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.
On the Register Connection Option page, select Login automatically using my SQL server account information, then complete the following sub-steps:
In the Login name field, enter the account name used to connect to your SQL server. Typically, this is sa.
In the Password field, enter the password associated with the account name you specified, then click Next.
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.
On the Completing the Register SQL Server Wizard page, click Finish, then click Done.
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:
Start the Microsoft SQL Server Enterprise Manager application.
From the Windows Start Menu, select Programs, select Microsoft SQL Server, then select Enterprise Manager.
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.
Right-click Databases, then select New Database.
In the Database Properties dialog, select the General tab, then enter XELL in the Name field.
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 | 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.Note:
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 SQL Server installation.Select Automatically Grow File.
Select By Percent, then enter 10 in the associated text box.
Select Unrestricted file growth.
Tip:
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 physical data and primary keys of the User Profile Audit component.Select the Transaction Log tab, then change the initial size to 500MB. 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.Click OK to initiate the database creation.
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, make sure to specify that login instead of xladm throughout the following procedure and also when installing Oracle Identity Manager.To create a SQL Server database account and permissions:
Launch the Microsoft SQL Server Enterprise Manager application.
From the Windows Start Menu, select Programs, select Microsoft SQL Server, then select Enterprise Manager.
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.
Select Security, right-click Logins, then select New Login.
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).
Select SQL Server Authentication, then enter the password associated with the account you specified in the Password text box.
In the Database box within the Defaults section, select XELL from the list.
Leave the Language box set to <default>.
Select the Database Access tab. In the upper panel, select the check box associated with XELL.
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
Click OK to commit your changes.
When prompted, confirm the password and click OK.
To check your database settings, right-click the icon representing your server, then select Properties from the shortcut menu.
On the SQL Server Properties page, select the Security tab, then verify that Authentication is set to SQL Server and Windows.
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 may be required by other applications. Click OK to close the SQL Server Properties page.
To remove Oracle Identity Manager entries from a SQL Server database after removing (deinstalling) the Oracle Identity Manager product, perform the following steps:
Delete the Oracle Identity Manager database.
Delete the Oracle Identity Manager login.
