Skip Headers
Oracle® Identity Manager Installation and Upgrade Guide for JBoss
Release 9.0
B25938-01
  Go To Documentation Library
Home
Go To Table Of Contents
Contents

Previous
Previous
 
Next
Next
 

13 Upgrading to Oracle Identity Manager 9.0.1 from Versions 8.5.2 or 8.5.3

You Oracle Identity Manager has formerly been known as both Oracle Xellerate Identity Provisioning and also Thor Xellerate Identity Manager. The Oracle Identity Manager Audit and Compliance module, formerly known as Oracle Xellerate Audit and Compliance Manager, is a new, optional module that installs on top of Oracle Identity Manager and facilitates user profile auditing.

Upgrade Overview

Both Oracle Identity Manager and the Oracle Identity Manager Audit and Compliance module run on the JBoss application server version 4.0.2. Therefore, upgrade from Oracle Xellerate Identity Provisioning version 8.5.2 or 8.5.3 (henceforth referred to collectively as version 8.5.x) to Oracle Identity Manager version 9.0.1 involves upgrade to both the JBoss application server (from version 3.2.7 to version 4.0.2) and the Oracle Identity Manager application.

You can upgrade a non-clustered JBoss 3.2.7-based version of Oracle Xellerate Identity Provisioning 8.5.x to either a clustered or non-clustered JBoss 4.0.2-based configuration of Oracle Identity Manager 9.0.1. The new JBoss 4.0.2 application servers (in either clustered or non-clustered configuration) associated with your Oracle Identity Manager 9.0.1 installation can run on either Windows or Linux hosts.

The JBoss application server does not support an in-place upgrade; therefore, you must perform the following sequence of tasks to install Oracle Identity Manager version 9.0.1 and, if you desire, the optional Oracle Identity Manager Audit and Compliance module as well.

The following is an overview of the process to upgrade from Oracle Xellerate Identity Provisioning version 8.5.x to Oracle Identity Manager version 9.0.1:

  1. Upgrade the database you used for Oracle Xellerate Identity Provisioning 8.5.x. Refer to "Upgrading Your Database" for more information.

  2. Install a fresh instance of the JBoss 4.0.2 application server on the machine that will host your Oracle Identity Manager 9.0.1 server. Refer to "Installing the JBoss 4.0.2 Application Server" for more information.

  3. Install a fresh instance of Oracle Identity Manager 9.0.1 on the host running your JBoss 4.0.2 application server. Depending on your operating system, refer to the following:

    1. Chapter 6, "Installing Oracle Identity Manager Server on Windows" or Chapter 7, "Installing Oracle Identity Manager Server on Linux"

    2. Chapter 11, "Installing and Configuring Oracle Identity Manager Design Console"

    3. Chapter 12, "Installing and Configuring the Oracle Identity Manager Remote Manager"

  4. Migrate your legacy Oracle Xellerate Identity Provisioning 8.5.x configuration settings to your new Oracle Identity Manager 9.0.1 environment. Refer to "Migrating and Updating Component Settings" for more information.

  5. Migrate any Oracle Xellerate Identity Provisioning 8.5.x custom code, including custom clients, scheduled tasks, event handlers, and libraries bound to adapters to your new Oracle Identity Manager 9.0.1 environment. Refer to "Migrating Custom Code to 9.0.1" for more information.

  6. Perform post-installation configuration of your Oracle Identity Manager environment. Refer to "Post-Installation Configuration" for more information.


Note:

This chapter describes upgrading from Oracle Xellerate Identity Provisioning 8.5.2 or 8.5.3 to Oracle Identity Manager version 9.0.1, with optional addition of the Oracle Identity Manager Audit and Compliance.

The Oracle Identity Manager 9.0.1 upgrade package is contained in upg_852_853_to_901.zip. Extract the contents of this package to a temporary directory on the machine where you plan to install Oracle Identity Manager 9.0.1. Henceforth, this document refers to this temporary directory as <Patch>.

If you are running an earlier version of Oracle Xellerate Identity Provisioning, contact Oracle Technical Support for the appropriate upgrade patch.



Note:

This chapter only covers upgrading to Oracle Identity Manager 9.0.1 from an Oracle Xellerate Identity Provisioning 8.5.x installation deployed on JBoss application server.

Upgrading Your Database

Upgrade the database used by your Oracle Xellerate Identity Provisioning 8.5.x installation. You can choose among the following upgrade methods:

Upgrading an Existing Database Instance

This approach upgrades your existing database instance by upgrading the database schema while your database remains in-place.

  1. Extract the contents of the Oracle Identity Manager 9.0.1 upgrade package (upg_852_853_to_901.zip) to a temporary directory on the machine where you plan to install Oracle Identity Manager 9.0.1. Henceforth, this document refers to this temporary directory as <Patch>.

  2. Backup your existing database. As appropriate to your particular database, use the export/backup utilities provided with the Oracle database or SQL Server to perform a complete backup of your production database.

    Production database backup includes, but is not limited to, complete export or backup of the Oracle Xellerate Identity Provisioning 8.5.x database instance to ensure that no data is lost during the upgrade process. If the upgrade fails, this backup can be used to restore the database to its original state.

  3. Verify your database configuration. Make sure that your existing database is properly configured. As appropriate for your database, consult the following documentation:

    Oracle

    "Setting Up the Oracle Database"

    SQL Server

    "Setting Up the SQL Server"

  4. If you plan to install the optional Oracle Identity Manager Audit and Compliance module, you should create a separate file group for your SQL Server or a separate tablespace for Oracle databases to facilitate the new user profile auditing feature in version 9.0.1 of the Oracle Identity Manager Audit and Compliance module. If your database is SQL Server, you must create a new file group. If your database is Oracle, the new separate tablespace is not mandatory, but it is highly recommended for performance reasons.


    Note:

    Refer to "Creating a User Profile Audit File Group in SQL Server" for details on how to create a new file group in SQL Server. Refer to Oracle database documentation for details on setting up a tablespace for Oracle databases.

  5. Upgrade your database schema from Oracle Xellerate Identity Provisioning 8.5.x to Oracle Identity Manager 9.0.1 by using the one of the following scripts appropriate for your database and operating system. Be sure to run the script on the machine where the database resides.

    Oracle


    Note:

    The xl_db_upg_852_853_to_901 script also upgrades the required stored procedures for Oracle.

    For Oracle on Linux:

    1. Enable execute permissions on the xl_db_upg_852_853_to_901.sh script:

      chmod 755 xl_db_upg_852_853_to_901.sh
      
      
    2. Run the following script on the drive where you want to upgrade your database schema:

      <Patch>/Database/Oracle/Scripts/xl_db_upg_852_853_to_901.sh

    3. Enter the appropriate information for the Oracle database when prompted by the xl_db_upg_852_853_to_901.sh script.

    For Oracle on Windows:

    1. Run the following batch script on the drive where you want to upgrade your database schema:

      <Patch>\Database\Oracle\Scripts\xl_db_upg_852_853_to_901.bat

      The following is the command line usage for the Oracle xl_db_upg_852_853_to_901.bat script:

      xl_db_upg_852_853_to_901.bat <ORACLE_SID>
      <ORACLE_HOME> <ORACLE_XELL_USER>
      <ORACLE_XELL_USER_PWD> <PATCH>
      
      

    SQL Server

    1. Run the <Patch>\Database\SQLServer\Scripts\upg_852_853_to_901.bat batch file.


      Note:

      Refer to "Executing the SQL Server Upgrade Script" for more information on executing this script on an SQL Server database.

  6. New stored procedures have been introduced in Oracle Identity Manager 9.0.1. Perform the following steps to create the requisite stored procedures for your database:


    Note:

    If you are using an Oracle database, you can skip this step as running the xl_db_upg_852_853_to_901 script already created the required stored procedures for Oracle.

    SQL Server

    1. Launch a plain-text editor, then open the file compile_all_XL_SP.bat, which resides in the directory <Patch>/Database/SQLServer/StoredProcedures/.

    2. For every stored procedure listed in the Sequential Lists section of compile_all_XL_SP.bat, replace the string @sysuser with the database user name. This is necessary because SQL Server requires functions invoked from a stored procedure to be qualified by the database user name (owner). Be sure you replace the entire @sysuser string, including the @ character.

    3. Navigate to the directory <Patch>/Database/SQLServer/StoredProcedures/, then run the batch file compile_all_XL_SP.bat.


      Note:

      Refer to "Executing the SQL Server Upgrade Script" for more information on executing this script on an SQL Server database.

  7. To upgrade and enable the optional Oracle Identity Manager Audit and Compliance module, perform the following steps appropriate for your database:


    Note:

    This step is necessary only if you are upgrading from Oracle Xellerate Identity Provisioning 8.5.x to the 9.0.1 version of the Oracle Identity Manager Auditing and Compliance module.

    Oracle

    1. Log in to SQL *Plus with the credentials of the Oracle Xellerate Identity Provisioning 8.5.x database schema owner.

    2. Run the following script:

      <Patch>\Database\Oracle\Scripts\Oracle_Enable_XACM.sql

    SQL Server

    1. Run the <Patch>/Database/SQLServer/Scripts/SQLServer_Enable_XACM.bat batch file.


      Note:

      Refer to "Executing the SQL Server Upgrade Script" for more information on executing this script on an SQL Server database.

  8. The user profile auditing feature and the reports feature introduced in Oracle Identity Manager 9.0.1 require that certain metadata be loaded into the database. As appropriate for the operating system on the machine hosting your Oracle Identity Manager server, load Oracle Identity Manager metadata into your database by executing one of the following commands:

    Windows

    Run the batch file LoadXML.bat, which resides in the <Patch>\Database \Utilities\ directory.

    Linux

    Run the script LoadXML.sh, which resides in the directory <Patch>/Database/Utilities/.


    Note:

    Refer to "Loading Metadata into the Database" before executing this script.

Creating a New, Upgraded Database Instance

This approach creates a new database instance, then upgrades it with the database schema for Oracle Identity Manager 9.0.1. This method ensures that your current working database remains available if a rollback is required. Use the following steps for creating a new, upgraded database instance:

  1. Use the export/backup utility provided by SQL Server or Oracle database to perform a complete export of all the data in your existing database.

  2. Create a new database. See either of the following: "Setting Up the Oracle Database" or "Setting Up the SQL Server" for more information.


    Important:

    If you create a new Oracle database, make sure to specify the username and password used by your original database instance as the credentials for your new database.

  3. Using the import utility provided by your particular database, import the data you exported from your original database in Step 1 into your newly created database you made in Step 2. This creates an exact copy of your original database instance.

  4. If you plan to install the optional Oracle Identity Manager Audit and Compliance module, you should create a separate file group for your SQL Server or a separate tablespace for Oracle databases to facilitate the new user profile auditing feature in version 9.0.1 of the Oracle Identity Manager Audit and Compliance module. If your database is SQL Server, you must create a new file group. If your database is Oracle, the new separate tablespace is not mandatory, but it is highly recommended for performance reasons.


    Note:

    Refer to "Creating a User Profile Audit File Group in SQL Server" for details on how to create a new file group in SQL Server. Refer to Oracle database documentation for details on setting up a tablespace for Oracle databases.

  5. Upgrade your database schema from Oracle Xellerate Identity Provisioning 8.5.x to Oracle Identity Manager 9.0.1 by using one of the following scripts appropriate for your database and operating system. Be sure to run the script on the machine where the database resides.

    Oracle


    Note:

    The xl_db_upg_852_853_to_901 script also upgrades the required stored procedures for Oracle.

    For Oracle on Linux:

    1. Enable execute permissions on the xl_db_upg_852_853_to_901.sh script:

      chmod 755 xl_db_upg_852_853_to_901.sh
      
      
    2. Run the following script on the drive where you want to upgrade your database schema:

      <Patch>/Database/Oracle/Scripts/xl_db_upg_852_853_to_901.sh

    3. Enter the appropriate information for the Oracle database when prompted by the xl_db_upg_852_853_to_901.sh script.

    For Oracle on Windows:

    1. Run the following batch script on the drive where you want to upgrade your database schema:

      <Patch>\Database\Oracle\Scripts\xl_db_upg_852_853_to_901.bat

      The following is the command line usage for the Oracle xl_db_upg_852_853_to_901.bat script:

      xl_db_upg_852_853_to_901.bat <ORACLE_SID>
      <ORACLE_HOME> <ORACLE_XELL_USER>
      <ORACLE_XELL_USER_PWD> <PATCH>
      
      

    SQL Server

    1. Run the <Patch>\Database\SQLServer\Scripts\upg_852_853_to_901.bat batch file.


      Note:

      Refer to "Executing the SQL Server Upgrade Script" for more information on executing this script on an SQL Server database.

  6. New stored procedures have been introduced in Oracle Identity Manager 9.0.1. Perform the following steps to create the requisite stored procedures for your database:


    Note:

    If you are using an Oracle database, you can skip this step as running the xl_db_upg_852_853_to_901 script already created the required stored procedures for Oracle.

    SQL Server

    1. Launch a plain-text editor and open the <Patch>/Database/SQLServer/StoredProcedures/compile_all_XL_SP.bat batch file.

    2. For every stored procedure listed in the Sequential Lists section of compile_all_XL_SP.bat, replace the @sysuser string with the database user name. This is necessary because SQL Server requires functions invoked from a stored procedure to be qualified by the database user name (owner). Be sure you replace the entire @sysuser string, including the @ character.

    3. Run the <Patch>/Database/SQLServer/StoredProcedures/compile_all_XL_SP.bat batch file.


      Note:

      Refer to "Executing the SQL Server Upgrade Script" for more information on executing this script on an SQL Server database.

  7. To upgrade and enable the optional Oracle Identity Manager Audit and Compliance module, perform the following steps appropriate for your database:


    Note:

    This step is necessary only if you are upgrading the 8.5.x version of the Audit and Compliance module to the 9.0.1 version of the Audit and Compliance module.

    Oracle

    1. Log in to SQL *Plus with the credentials of the Oracle Xellerate Identity Provisioning 8.5.x database schema owner.

    2. Run the following script:

      <Patch>\Database\Oracle\Scripts\Oracle_Enable_XACM.sql

    SQL Server

    1. Run the <Patch>/Database/SQLServer/Scripts/SQLServer_Enable_XACM.bat batch file.


      Note:

      Refer to "Executing the SQL Server Upgrade Script" for more information on executing this script on an SQL Server database.

  8. The user profile auditing and reports features introduced in Oracle Identity Manager 9.0.1 require that certain metadata be loaded into the database. As appropriate for the operating system on the machine hosting your Oracle Identity Manager server, load Oracle Identity Manager metadata into your database by executing one of the following:

    Windows

    1. Run the <Patch>\Database\Utilities\LoadXML.bat batch file.

    Linux

    1. Run the <Patch>/Database/Utilities/LoadXML.sh script.


      Note:

      Refer to "Loading Metadata into the Database" before executing this script.

Installing the JBoss 4.0.2 Application Server

Upgrading JBoss from version 3.2.7 to version 4.0.2 requires installation of a new instance of the application server, because JBoss does not provide an in-place upgrade mechanism for the versions involved. This new instance can be installed on the same machine that hosts the 3.2.7 instance or on a different machine.


Tip:

Installing multiple versions of an application server on the same machine can possibly reduce the downtime caused by the upgrade; however, you must ensure that the two instances do not contend for the same set of ports. Configuration of your new JBoss 4.0.2 instance to use a nondefault ports is a manual process. Refer to your JBoss documentation for details.


Caution:

Oracle Identity Manager 9.0.1 supports JBoss clustering. Make sure to guard against port contention whenever you upgrade a non-clustered machine running Oracle Xellerate Identity Provisioning 8.5.x so that it can run in a clustered, Oracle Identity Manager 9.0.1 environment.

Refer to Chapter 4, "Installing and Configuring JBoss for Oracle Identity Manager" for more information on setting up, installing, and configuring a new instance of your JBoss application server. Relevant sections in this chapter detail the configuration requirements you must perform before and during application server installation.

To upgrade an existing Oracle Identity Manager installation from a non-clustered to a clustered environment, see Chapter 10, "Deploying in a Clustered JBoss Configuration" for more information.


Caution:

Do not overwrite your existing application server installation. Instead, make sure to install the new application server instance in a directory other than the one used by your existing application server instance.


Caution:

Make sure to shut down your existing JBoss application server instance before you begin Oracle Identity Manager 9.0.1 installation.


Note:

During Oracle Identity Manager installation, the installer recognizes that the specified database credentials belong to an existing encrypted database. Therefore it prompts you to copy the file .xldatabasekey from the old installation directory (8.5.x) to the installation directory (9.0.1) so that the same key can be used to decrypt the data read from the database. You should ignore this prompt because post-installation steps in these upgrade instructions require you to copy .xldatabasekey and other files from your 8.5.x installation directory to your 9.0.1 installation directory. (See Step 2 in "Migrating Oracle Identity Manager Server Settings" for more information.)

Migrating and Updating Component Settings

After you install the Oracle Identity Manager 9.0.1 components (Oracle Identity Manager Server, Design Console, and Remote Manager), you must migrate certain settings from your version Oracle Xellerate Identity Provisioning 8.5.x environment to your version 9.0.1 components and update other various settings as described in this section.

Migrating Oracle Identity Manager Server Settings

To migrate and otherwise update the settings on your newly installed Oracle Identity Manager 9.0.1 servers, complete the following steps:

  1. Backup the contents of your Oracle Identity Manager 9.0.1 server configuration directory <XL_HOME>/xellerate/config

  2. Copy the following configuration files from your version Oracle Xellerate Identity Provisioning 8.5.x installation directory (<XL_85x_HOME>) to the corresponding version 9.0.1 installation directory (<XL_HOME>), overwriting files, as necessary.

    xellerate/config/.xldatabasekey
    xellerate/config/.xlkeystore
    xellerate/config/configkey.key
    xellerate/config/FormMetaData.xml
    xellerate/config/xell.csr
    xellerate/config/xlconfig.xml
    xellerate/config/xlserver.cert
    
    
  3. If you are not upgrading to a clustered environment, launch a plain-text editor, open the file log4j.xml, which resides in the directory <JBOSS_3.2.7_HOME>/server/default/conf/, then copy all tags that were added to this file as part of Oracle Xellerate Identity Provisioning 8.5.x setup to the file log4j.xml that resides in the directory <JBOSS_4.0.2_HOME>/server/default /conf/.

    Alternatively, if you are upgrading from a non-clustered environment to a clustered environment, copy all the tags that were added as part of Oracle Xellerate Identity Provisioning 8.5.x setup from the file log4j.xml, which resides in the directory <JBOSS_3.2.7_HOME>/server/default/conf/ to the file log4j.xml, which resides in <JBOSS_4.0.2_HOME>/server/all/conf/. To identify added tags, look for entries that resemble the following:

    <category name="XELLERATE.DDM">
         <priority value="DEBUG"/>
    </category>
    <category name="XELLERATE">
         <priority value="WARN"/>
    </category>
    <category name="com.nexaweb.server">
         <priority value="WARN"/>
    </category>
    
    

    In all of these tags Òpriority valueÓ is set to one of the permissible log4j levels, such as DEBUG or WARN.

    By copying these relevant tags, you migrate the existing log categories and their current log-level settings from your JBoss 3.2.7/Oracle Xellerate Identity Provisioning 8.5.x environment to your new JBoss 4.0.2/ Oracle Identity Manager 9.0.1 environment.

  4. Update the file xlconfig.xml, which resides in the directory <XL_HOME>/xellerate/config/. See "Upgrading the Server Configuration File" for more information.

  5. Update the file FormMetaData.xml, which resides in the directory <XL_HOME>/xellerate/config/. See "Upgrading the Metadata File" for more information.

  6. Copy the contents of the directory <XL_85x_HOME>/xellerate/adapters to the directory <XL_HOME>/xellerate/adapters.


    Important:

    If you are upgrading from a non-clustered environment to a clustered environment, make sure to repeat steps 1 through 6 on all cluster members.

Migrating Remote Manager Settings

The Remote Manager installation wizard performs most Remote Manager configuration tasks. However, when you are upgrading, you must manually migrate certain version 8.5.x configuration files to your new Remote Manager installation directory. In some cases, you must also modify these files. Complete the following steps to complete configuration of your version 9.0.1 Remote Manager.

  1. Backup the contents of your version 9.0.1 Remote Manager configuration directory, which is <XL_RM_HOME>/xlremote/config

  2. Copy the following configuration files from your version 8.5.x Remote Manager installation directory (<XL_85x_RM_HOME>) to the corresponding version 9.0.1 Remote Manager installation directory (<XL_RM_HOME>), overwriting files, as necessary.

    xlremote/config/.xlkeystore
    xlremote/config/configkey.key
    xlremote/config/xell.csr
    xlremote/config/xlconfig.xml
    xlremote/config/xlserver.cert
    
    
  3. As of version 9.0.1, and for all future releases, the log.properties file replaces the log.conf file as the Remote Manager configuration file. Complete the following steps to migrate all the Remote Manager logging settings:

    1. Copy the <XL_HOME>/xellerate/config/log.properties file from the version 9.0.1 server installation directory to the version 9.0.1 Remote Manager <XL_RM_HOME>/xlremote/config/ installation directory.

    2. Copy any version 8.5.x custom logging-related settings that may exist in the file log.conf, which resides in the directory <XL_85x_RM_HOME>/xlremote/config/, to the file log.properties, which resides in the directory <XL_RM_HOME>/xlremote/config/.


      Note:

      Copy only the custom logging-related settings in the log.conf file, not the syntax of the 8.5.x log.conf file.

    3. You must convert the formatting of the log-level settings in log.conf to new formatting in the log.properties file. For example, a logging-related entry in log.conf might look similar to the following:

      Logger.module.RemoteManager=WARN
      
      

      The corresponding entry in log.properties might look like the following:

      # log4j.logger.XELLERATE.RemoteManager=DEBUG
      
      

      You need to uncomment the line, then set the parameter to the value already set in the log.conf entry, so that the log.properties entry looks something like the following:

      log4j.logger.XELLERATE.RemoteManager=WARN
      
      

      Repeat this for all logging-related entries, then save and close the file.

  4. Update the file xlconfig.xml in the directory <XL_RM_HOME>/xlremote/config/. See "Upgrading the Remote Manager Configuration File" for more information.

Updating the Oracle Identity Manager Server

You must update the bootstrap information in the configuration file for your Oracle Identity Manager server by completing the following steps:

  1. Launch a plain-text editor, then open the file xlconfig.xml, which resides in the directory <XL_HOME>/xellerate/config/, of the machine hosting your Oracle Identity Manager server. Ensure that the bootstrap address and port in the configuration file point to your version 9.0.1 server or servers. The following configuration parameters, which contain the bootstrap information, must be updated:

    <xl-configuration>.<Discovery>.<CoreServer>.<java.naming.provider.url>
    <xl-configuration>.<Discovery>.<BackOffice>.<java.naming.provider.url>
    <xl-configuration>.<Discovery>.<Scheduler>.<java.naming.provider.url>
    <xl-configuration>.<Discovery>.<JMSServer>.<java.naming.provider.url>
    
    

    For example, you might change a parameter setting for an un-upgraded, non-clustered configuration such as this:

    <java.naming.provider.url>jnp://localhost:1100</java.naming.provider.url>
    
    

    To something like the following for an upgraded, clustered configuration:

    <java.naming.provider.url>
          jnp://192.168.20.5:1100,192.168.20.6:1100
    </java.naming.provider.url>
    
    
  2. As necessary, update the other external components used in deployment (like IIS) with the new port information. For detailed procedures, consult the documentation for each external component.


    Note:

    Restart the application server after completing the upgrade process.

Updating Design Console Settings

When you upgrade a non-clustered Oracle Xellerate Identity Provisioning 8.5.x environment to a clustered Oracle Identity Manager 9.0.1 environment, you must update the version 9.0.1 Design Console so that the bootstrap address and port in the configuration file point to your version 9.0.1 Oracle Identity Manager server.

Complete the following steps:

  1. Launch a plain text editor, open the file xlconfig.xml, which resides in the directory <XL_DC_HOME>/xlclient/config/, then locate the following configuration parameter:

    <xl-configuration>.<Discovery>.<CoreServer>.<java.naming.provider.url>
    
    
  2. Within the tag <java.naming.provider.url></java.naming.provider.url>, add a comma-delimited list of some of the bootstrap addresses and ports in your configuration, using the following format:

    jnp://<ip-addr-or-host-name1>:<port1>,<ip-addr-or-host-name2>:<port2>,...<ip-addr-or-host-namen>:<portn>
    
    

    The completed string for a clustered installation might look something like the following:

    <java.naming.provider.url>jnp://192.168.20.5:1100,192.168.20.6:1100</java.naming.provider.url>
    
    
  3. Add to the discovery/CoreServer section a partition information statement similar to the following:

    <jnp.partitionName>MyPartition</jnp.partitionName>
    
    
  4. Locate the <ApplicationURL> tag and changes its value to the URL of the Web server that is hosting the clustered environment.

Migrating Custom Code to 9.0.1

In a version 9.0.1 environment, you can recycle custom code (including custom clients, scheduled tasks, event handlers and libraries bound to adapters) originally used in your version 8.5.x environment.


Important:

Before migrating custom code from the 8.5.x environment, the custom code must first be rebuilt using the Oracle Identity Manager 9.0.1 libraries.

Recompiling Custom Code

Custom code written for Oracle Xellerate Identity Provisioning 8.5.x needs to be rebuilt using the Oracle Identity Manager 9.0.1 libraries, which are located in <XL_HOME>/xellerate/lib.

Using the integrated development environment (that is, Eclipse, JDeveloper, WASD or command line javac) that originally compiled the version 8.5.x custom code, recompile all custom java code using Oracle Identity Manager 9.0.1 libraries instead of Oracle Xellerate Identity Provisioning 8.5.x libraries.

Migrating Adapters

Custom java libraries bound to functional Oracle Xellerate Identity Provisioning 8.5.x adapters can be reused in a Oracle Identity Manager 9.0.1 environment after they have been recompiled using Oracle Identity Manager 9.0.1 libraries.

The recompiled custom java libraries that were originally in the directory <XL_85x_HOME>/xellerate/JavaTasks must be copied to the directory <XL_HOME>/xellerate/JavaTasks.

The recompiled custom java libraries that were originally in the directory <XL_85x_RM_HOME>/xlremote/JavaTasks must be copied to the directory <XL_RM_HOME>/xlremote/JavaTasks.


Important:

If you are upgrading from a non-clustered to a clustered environment, you must repeat this step on all cluster members.


Note:

You do not need to recompile the adapters themselves.

Migrating Scheduled Tasks

Custom scheduled tasks that were functional in Oracle Xellerate Identity Provisioning 8.5.x can be reused in your Oracle Identity Manager 9.0.1 environment after you have recompiled them using Oracle Identity Manager 9.0.1 libraries.

The recompiled custom scheduled tasks need to be copied to the directory <XL_HOME>/xellerate/ScheduleTask.


Note:

If you are upgrading from a non-clustered to a clustered environment, you must repeat this step on all cluster members.

Migrating Event Handlers

Custom event handlers that were functional in Oracle Xellerate Identity Provisioning 8.5.x can be reused in your version 9.0.1 environment after you have recompiled them using Oracle Identity Manager 9.0.1 libraries.

The recompiled custom event handlers must be copied to the directory <XL_HOME>/xellerate/EventHandlers.


Note:

If upgrading from a non-clustered environment to a clustered environment then repeat this step on all cluster members.

Migrating xlWebApp Customizations

You must reapply any customizations (for example, JSP customizations) made to the Oracle Xellerate Identity Provisioning 8.5.x web application to the 9.0.1 Oracle Identity Manager environment.

Migrate any customizations previously applied to your version 8.5.x web application to the out-of-box version 9.0.1 web application xlWebApp.war, which resides in the directory <XL_HOME>/xellerate/webapp.

After migrating the 8.5.x web application customizations, you must patch your version 9.0.1 web application. See Appendix B, "Patching an Existing Oracle Identity Manager Installation" for more information.

Migrating Custom Clients

Any custom clients that were built using Oracle Xellerate Identity Provisioning 8.5.x APIs must be updated and recompiled to make them compatible with the Oracle Identity Manager 9.0.1 APIs. For example, certain APIs might have been deprecated or replaced by new APIs. Refer to the Oracle Identity Manager Release Notes for a comprehensive list of API calls that have changed between Oracle Xellerate Identity Provisioning 8.5.x and Oracle Identity Manager 9.0.1.

Post-Installation Configuration

The following post-installation configurations are necessary to complete the upgrade process.

Post-Installation Configuration for the Oracle Identity Manager Auditing and Compliance Module

The following post-installation configuration procedures might be necessary if you have installed the Oracle Identity Manager Audit and Compliance module (previously named Oracle Xellerate Auditing and Compliance Manager in 8.5.x). The following is an overview of the process:

  1. Set the user profile audit level

  2. Generate user snapshots

  3. Execute the Generate Snapshot script

Setting the User Profile Audit Level

  1. Define a secondary data source for reporting, if necessary. Refer to the Oracle Identity Manager Audit Report Developer's Guide for more information on defining a secondary data source.

  2. Start the application server hosting your Oracle Identity Manager server.

  3. Set the audit level. The permissible values, in descending order are:

    • Process Task

    • Resource Form

    • Resource

    • Membership

    • Core

    • None

    Specify an audit level by completing the following sub-steps:

    1. Log into the Design Console as an administrator

    2. Navigate to the System Configuration page

    3. Locate XL.UserProfileAuditDataCollection and sets its value to Resource Form or the appropriate audit level.

  4. To collect user profile audit data in the secondary reporting data store, complete the following sub-steps:

    1. Log into the Design Console as an administrator

    2. Navigate to the System Configuration page

    3. Locate XL.UserProfileAuditInSecondaryDS and set its value to TRUE.

Generating User Snapshots

If you installed the Oracle Identity Manager Audit and Compliance module, you must generate new snapshots for all existing users in the system when either of the following two situations occur:

  • You upgrade from version 8.5.x to version 9.0.1 with the Oracle Identity Manager Audit and Compliance module

  • You elevate the audit level for an existing Oracle Identity Manager Audit and Compliance module environment

To generate new snapshots, complete the following steps:

  1. Launch a plain-text editor and open the file GenerateSnapshot script located in the <XL_HOME>/xellerate/bin/ directory. If you are running on Windows, open GenerateSnapshot.bat. If you are running on Linux, open GenerateSnapshot.sh.

  2. Edit the following variables in the GenerateSnapshot script:

    1. Modify the set XEL_HOME=variable to point to the directory where you installed Oracle Identity Manager.

    2. Modify the set APP_SERVER=@appserver variable to be:

      set APP_SERVER=jboss
      
      
    3. Modify the set APP_SERVER_HOME=@app_server_home variable to point to the directory where you installed JBoss.

    4. Modify the set JAVA_HOME=@jdk_loc variable to point to the directory containing the JDK.

    5. Modify the SQL_SERVER_DRIVER_DIR variable to point to the directory containing the SQL Server JDBC drivers. For example:

      Windows

      In GenerateSnapshot.bat, change the following line:

      REM set SQL_SERVER_DRIVER_DIR=C:\Program Files\Microsoft SQL Server 2000 Driver for JDBC\lib
      
      

      to the following:

      set SQL_SERVER_DRIVER_DIR=<Set appropriate value here>
      
      

      Linux

      In GenerateSnapshot.sh, change the following line:

      # SQL_SERVER_DRIVER_DIR=/msdrivers/lib# export SQL_SERVER_DRIVER_DIR
      
      

      to the following:

      SQL_SERVER_DRIVER_DIR=<Set appropriate value here>export SQL_SERVER_DRIVER_DIR
      
      
  3. Execute one of the following GenerateSnapshot scripts as appropriate for the operating system on the machine hosting the Design Console:

    Windows

    • Run the batch file GenerateSnapshot.bat, which resides in the directory <XL_HOME>/xellerate/bin/.

    Linux

    • Run the batch file GenerateSnapshot.sh, which resides in the directory <XL_HOME>/xellerate/bin/.

Post-Installation Configuration Tasks for Oracle Identity Manager

The following tasks apply to the various Oracle Identity Manager components:

  • You must apply to all new application server instances all performance tuning settings previously applied to the application servers you used for Oracle Xellerate Identity Provisioning 8.5.x.

  • Verify that your upgrade process has succeeded by confirming that all version 8.5.x data is accessible in your version 9.0.1 environment, for example, that you can access all users, organizations, groups, resources, process definitions, rule definitions, forms, and adapter definitions that were part of your version 8.5.x installation.

    Once you are confident that your entire 8.5.x environment is accessible in 9.0.1, back up, then remove the application servers you used for your 8.5.x environment.

  • If necessary, you must update your new application server so that it uses default ports. If you update your new application server so that it uses default ports, be sure to update the bootstrap addresses in the Oracle Identity Manager Server's configuration file, <XL_HOME>xellerate/config/xlconfig.xml. See"Updating the Oracle Identity Manager Server" for more information.