5 Upgrading the Oracle Identity Manager Database

Before you upgrade your database, perform the following steps:

Extract the contents of the Oracle Identity Manager release 9.1.0 upgrade package to a temporary directory on the computer on which the database is installed.

This guide refers to this temporary directory as PATCH.
Enable execute permissions on the scripts in the PATCH directory.
Choose one of the following approaches to upgrade the database used by the Oracle Identity Manager release 9.0.1.5 deployment:
- Perform an upgrade of the existing database configured for release 9.0.1.5.
  
  For details, see "Upgrading an Existing Database Instance In-Place".
- Create a new instance of the database for release 9.1.0, and then import the data used by your release 9.0.1.5 deployment into the new database and perform the upgrade.
  
  For details, see "Creating a New Database Instance for the Upgrade".

5.1 Upgrading an Existing Database Instance In-Place

Perform the following steps to upgrade your existing release 9.0.1.5 database instance to release 9.1.0:

Create a backup of your existing database.

Use the export/backup utilities provided with the database 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 Identity Manager release 9.0.1.5 database instance to ensure that the database can be restored to its original state, if required.
Upgrade your database schema from release 9.0.1.5 to release 9.1.0 by using one of the following scripts appropriate for your database and operating system. Run the script on the computer on which the database is installed.

For Oracle Database on UNIX:
1. To upgrade the database schema, run the PATCH/db/oracle/Scripts/oim_db_upg_9015_to_9100.sh script on the computer on which the database for release 9.0.1.5 is installed.
2. Enter the required information for the Oracle database when prompted by the script.
For Oracle Database on Microsoft Windows:

To upgrade the database schema, run the PATCH\db\oracle\Scripts\oim_db_upg_9015_to_9100.bat batch script on the system on which the release 9.0.1.5 database is installed.

The command-line usage for the Oracle oim_db_upg_9015_to_9100 script is:
```
oim_db_upg_9015_to_9100.bat ORACLE_SID ORACLE_HOME ORACLE_IDENTITY_MANAGER_DB_USER_NAME ORACLE_IDENTITY_MANAGER_DB_USER_PASSWORD DIRECTORY_IN_WHICH_DB_UPGRADE_ZIP_FILE_IS_EXTRACTED
```
Note:
The upgrade script also upgrades the required stored procedures for Oracle.
To upgrade the Oracle Identity Manager Audit and Compliance module, perform the following steps as appropriate for your database:

For Oracle Database:
1. Log in to SQL *Plus with the credentials of the Oracle Identity Manager release 9.0.1.5 database schema owner.
1. Run the PATCH/db/oracle/Scripts/Oracle_Enable_XACM.sql script.
The user profile auditing feature and the reports feature require that certain metadata be loaded into the database. As appropriate for the operating system on the Oracle Identity Manager host computer, load Oracle Identity Manager metadata into your database by running one of the following commands:

If Oracle Identity Manager is installed without the Audit and Compliance module, then:
- For Microsoft Windows, run the following file:
```
PATCH\db\Utilities\LoadXML.bat
```
- For UNIX, run the following script:
```
PATCH/db/Utilities/LoadXML.sh
```
If Oracle Identity Manager is installed with the Audit and Compliance module, then:
- For Microsoft Windows, run the following file:
```
PATCH\db\Utilities\LoadXML_XACM.bat
```
- For UNIX, run the following script:
```
PATCH/db/Utilities/LoadXML_XACM.sh
```
See Also:
Appendix A, "Loading Report Metadata Into the Database" for more information about running the LoadXML or LoadXML_XACM script
The e-mail definition templates must be loaded into the database. As appropriate for the operating system on the Oracle Identity Manager host computer, load Oracle Identity Manager e-mail templates into your database by running one of the following commands:

For Microsoft Windows:

Run PATCH\db\Utilities\LoadXLIF.bat

For UNIX:

Run PATCH/db/Utilities/LoadXLIF.sh

Note:
Running LoadXLIF.bat or LoadXLIF.sh only inserts the newly added e-mail templates, and does not update the existing e-mail templates. Therefore, if you want to update the existing templates, then delete all the entries from the EMD table and run LoadXLIF.bat or LoadXLIF.sh.

See Also:
"Loading E-Mail Templates into the Database" for more information about running the LoadXLIF script

5.1.1 Using Oracle Identity Manager Database Validator

While performing an upgrade, you can use the Oracle Identity Manager Database Validator utility to compare database objects. The Database Validator is a command-line interface (CLI) utility that compares objects of two databases. The utility generates a report of the missing and mismatched objects in the destination database. You can also use this utility to verify an upgrade that you might install.

5.1.2 Using Reconciliation Archival

The purpose of the Reconciliation Archival utility is to archive data from active reconciliation tables to archival reconciliation tables and to delete data from active and archival reconciliation tables. See Appendix C, "Reconciliation Archival" for more details.

5.1.3 Using Task Archival

The purpose of the Task Archival utility is to archive data from active task tables to archival task tables and to delete data from active task tables. See Appendix D, "Task Archival" for more details.

5.2 Creating a New Database Instance for the Upgrade

You can create a new database instance, and then upgrade it to the database schema for Oracle Identity Manager release 9.1.0. This method ensures that your current working database remains available if a rollback is required. Perform the following steps for creating a new, upgraded database instance:

Use the export/backup utilities provided with the database 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 Identity Manager release 9.0.1.5 database instance. If the upgrade fails, then this backup can be used to restore the database to its original state.
Create a new database by referring to the database vendor's documentation and Oracle Identity Manager Installation and Configuration Guide specific to your application server.

Note:
If you create a new database, then you must specify the same login credentials for the new database as used for the original database instance.
Using the import utility provided by the database, import the data you exported from the original database into the newly created database. This creates an exact copy of the original database instance.
Upgrade the database schema from Oracle Identity Manager release 9.0.1.5 to release 9.1.0 by using one of the following scripts appropriate for your database and operating system. Ensure that you run the script on the computer in which the database is stored.

For Oracle Database running on UNIX:

Run the following script on the new release 9.1.0 database system and enter the appropriate information when prompted to upgrade the database schema:

To upgrade from release 9.0.1.5:
```
PATCH/db/oracle/Scripts/oim_db_upg_9015_to_9100.sh
```
Note:
The script also upgrades the required stored procedures for Oracle.

For Oracle Database running on Microsoft Windows:

Run the following batch script on the new release 9.1.0 database system to upgrade the database schema:

To upgrade from release 9.0.1.5:
```
PATCH/db/oracle/Scripts/oim_db_upg_9015_to_9100.bat
```
The following is the command-line usage for the Oracle oim_db_upg_9015_to_9100.bat file:
```
oim_db_upg_9015_to_9100.bat ORACLE_SID ORACLE_HOME ORACLE_OIM_USER ORACLE_OIM_USER_PWD UPGRADE_FOLDER
```
Perform the following steps appropriate for the database to upgrade the Oracle Identity Manager Audit and Compliance module:
1. Log in to SQL *Plus with the credentials of the Oracle Identity Manager release 9.0.1.5 database schema owner.
1. Run the PATCH/db/oracle/Scripts/Oracle_Enable_XACM.sql script.
The user profile auditing feature and the reports feature require that certain metadata be loaded to the database. As appropriate for the operating system on the Oracle Identity Manager host computer, load Oracle Identity Manager metadata to the database by running one of the following commands:

If Oracle Identity Manager is installed without the Audit and Compliance module, then:
- For Microsoft Windows, run the following file:
```
PATCH\db\Utilities\LoadXML.bat
```
- For UNIX, run the following script:
```
PATCH/db/Utilities/LoadXML.sh
```
If Oracle Identity Manager is installed with the Audit and Compliance module, then:
- For Microsoft Windows, run the following file:
```
PATCH\db\Utilities\LoadXML_XACM.bat
```
- For UNIX, run the following script:
```
PATCH/db/Utilities/LoadXML_XACM.sh
```
See Also:
Appendix A, "Loading Report Metadata Into the Database" for more information about running the LoadXML or LoadXML_XACM script
The e-mail definition templates must be loaded into the database. As appropriate for the operating system on the Oracle Identity Manager host computer, load Oracle Identity Manager e-mail templates into the database by running one of the following commands:

For Microsoft Windows:

Run PATCH\db\Utilities\LoadXLIF.bat

For UNIX:

Run PATCH/db/Utilities/LoadXLIF.sh

See Also:
"Loading E-Mail Templates into the Database" for more information about running the LoadXLIF script

5.3 Loading E-Mail Templates into the Database

You must load e-mail templates into your database. To do so:

As appropriate for the operating system on the Oracle Identity Manager host computer, open either LoadXLIF.bat or LoadXLIF.sh located in the PATCH/db/Utilities/ directory, and update the JAVA_HOME variable.
Note:
- For upgrade from release 9.0.1.5 to release 9.1.0, the location is PATCH/db/Utilities/.
- The xlUtils.jar file is in the PATCH/db/Utilities/ directory. Do not copy this JAR to the OIM_HOME/lib/ directory.
Run LoadXLIF to populate the e-mail template for Default English Email Templates.

Note:
If your database supports languages other than English according to globalization support guidelines of Oracle Identity Manager release 9.1.0, then edit the XLIFsequence.properties file located at PATCH/db/Utilities/xliff/ to include e-mail templates for that language. You must refer to the XML file corresponding to your locale. The XML file name is xlif_locale.xml. For example, for French, you include xlif_fr.xml.
As appropriate for the database and operating system on the Oracle Identity Manager host computer, perform the following steps:
1. For Oracle Database on Microsoft Windows:
  
  In a text editor, open LoadXLIF.bat, and uncomment the following line:
```
REM SET ORACLE_DRIVER_DIR=
```
  Assign the path to the Oracle driver directory containing the Oracle JDBC drivers, as shown:
```
SET ORACLE_DRIVER_DIR=PATH_TO_ORACLE_DRIVER
```
  For Oracle Database on UNIX:
  
  In a text editor, open LoadXLIF.sh and uncomment the following lines:
```
#ORACLE_DRIVER_DIR=
#export ORACLE_DRIVER_DIR
```
  Assign the path to the JDBC driver for Oracle, as shown:
```
ORACLE_DRIVER_DIR=PATH_TO_ORACLE_DRIVER 
export ORACLE_DRIVER_DIR
```
2. In the command prompt, run the PATCH/db/Utilities/LoadXLIF.bat or LoadXLIF.sh script.
  
  The command-line usage of the LoadXLIF script for Oracle Database is as shown:
```
LoadXLIF JDBC_URL DB_USERNAME DB_PASSWORD AUDIT_ON_OFF
```
  When you run the LoadXLIF command:
  - Replace JDBC_URL with the JDBC URL, for example, jdbc:oracle:thin:@DB_HOST_IP:PORT:SID.
  - Replace DB_USERNAME with the database user name.
  - Replace DB_PASSWORD with the database password.
  - Replace AUDIT_ON_OFF with True if Oracle Identity Manager is installed with the Audit and Compliance Module. Otherwise, specify False.