Skip Headers
Oracle® Role Manager Installation Guide
Release 10g (

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

Go to previous page
Go to next page
View PDF

9 Upgrading Oracle Role Manager

This chapter provides a detailed information about Oracle Role Manager upgrade process. It deals with upgrading to Oracle Role Manager release from release or release

To upgrade to release from release or release, you must complete the following tasks:

9.1 Installing the Oracle Role Manager in Install-Only Mode

You must run the installer in the install only mode. This is because Role Manager configuration is already existing and you are upgrading it to the latest configuration using the upgrade utility. Running the installer in the install only mode will deliver the latest files, and and binaries, server.jar, server.ear, webui.ear to your environment. For information about running the Oracle Role Manager installer, refer "Installing Role Manager".

The installer does not support overwriting an existing installation on the file system. You must provide an alterative file system path to the installer.


The install and configure mode is not supported on existing dbowner/app user schema which has data, but it is supported only on new dbowner/app user schema which has no data. Therefore, to upgrade existing configuration, you must install Oracle Role Manager in the install-only mode.

9.2 Creating a Back Up for Existing Database

Use the export or 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 Role Manager release or database instance to ensure that the database can be restored to its original state, if required.


  • You must shut down the J2EE server in which Oracle Role Manager is running (or all servers in case of a cluster) before running the database backup and the upgrade tool.

  • Ensure that no other JDBC client is accessing the existing Oracle Role Manager database.

9.3 Configuring Oracle Role Manager Integration Library

If you have installed Oracle Role Manager Integration Library for Oracle Identity Manager, then you must configure the Integration Library to match the Oracle Role Manager version that you are going to install. For information about how to configure the Integration Library, refer to Oracle Role Manager Integration Guide

9.4 Re-applying Customization to Data Model Configurations

If Oracle Role Manager setup has any customization to the data model configuration files such as standard.xml or standard_permissions.xml, then you must reapply the customized configuration to the latest data model configurations shipped with Oracle Role Manager For more information about data model customization, refer to Oracle Role Manager Developer's Guide.


  • Re-applying customization is optional if the Oracle Role Manager setup does not have any customization to standard data model configurations and webui.

  • Upgrade does not support upgrade of webui and datamodel customizations. These customizations must be applied manually.

9.5 Running the Upgrade Tool

The upgrade tool is a command line tool, which upon successful running, upgrades the existing Oracle Role Manager database to the latest one.

The upgrade tool will not upgrade the Oracle Role Manager software deployed to application servers, but only upgrade the data model and configurations in the database.


You must not directly run the upgrade tool on production database. It must be run on staging environment, which is prepared from production database backup. Upon successful upgrade and acceptance testing in staging environment, this tool can be run on production database.

Running the upgrade tool provides the installation with the following details:

For more information about these configurations, refer to Oracle Role Manager Integration Guide.

To run the upgrade tool:

  1. On the Oracle Role Manager installation host, navigate to ORM_HOME/config on the new ORM installation.

  2. Ensure that the file in ORM_HOME/config contains the correct information for your database environment. If it does not, edit and add the following lines:


    Where $HOST$ is the database host name, $PORT$ is the database listener port, and $SERVICE$ is the database instance on which the existing Oracle Role Manager users/schemas were created.

  3. Stop the Oracle Role Manager application server if it is running.

  4. In a command window, navigate to ORM_HOME/bin.

  5. Run the following command to deploy the configuration: NEW_ORM_HOME ..\config\ ormapp-user orm-owner admin-user  "collection_of_cars"


    • ormapp-user is the user name of the Oracle Role Manager application user/schema

    • orm-owner is the user name of the Oracle Role Manager database owner user/schema

    • admin-user is the user name of the Oracle Role Manager System Administrator

    • collection_of_cars contains the relative paths and file names of CAR files to be deployed. This collection must be within quotes with a semicolon (;) used as the delimiter between CAR files.

      Example for default configurations upgrade:


      Example for customized configurations upgrade:


      Example for a customized Oracle Role Manager configurations and Integration Library configurations upgrade:

  6. At the prompt, type Y to confirm you want to proceed with the upgrade.

  7. At the prompt, type the passwords for application user, database owner, and administrator. The command window displays messages about the progress of the upgrade. These messages are also recorded in the log file.

    Refer "Upgrade Logging" for examples of log messages.

    Refer "Verifying the Upgrade" for information about verifying that the upgrade was successful.

9.6 Upgrade Logging

The log files for upgrade, for example orm-upgrade-1.log, are generated under the logs folder of ORM_HOME. These log files contain details about the progress of upgrade tasks and failure or success reports for upgrade.

The following are the examples of log messages generated in the log file:

9.7 Verifying the Upgrade

The upgrade log will contain following messages that can be used to determine if the upgrade has been started and completed successfully:

In case the upgrade fails, then an Upgrade Exception with the failure details will be logged in the log file.

Fix the error accordingly and rerun the upgrade till it runs successfully. If required restore the database from the production database backup.

If you complete the upgrade successfully, then a table named VERSION_TABLE is created in the orm-owner database schema and the SOFTWARE_VERSION column of the table displays the latest Oracle Role Manager version.

9.8 Re-Deploying New Binaries to J2EE Container

To re-deploy new binaries to J2EE container:

  1. If the server.ear and the webui.war file are already deployed into the J2EE container, undeploy them and re-deploy the latest ones again.

  2. Start up the J2EE container/application server that hosts the Oracle Role Manager instance.


    If IL is configured, then you must start the upgraded Oracle Identity Manager instances.
  3. If IL is configured for Oracle Identity Manager, then perform the acceptance testing including IL. If acceptance test passes on staging environment, then repeat the steps from 9.6 to 9.8 on production environment.

9.8.1 For WebLogic

To deploy the Role Manager server and Web applications for WebLogic, refer "Deploying Role Manager".

9.8.2 For JBoss

To deploy the Role Manager server and Web applications for JBoss, refer "Configuring JBoss Server in a Nonclustered Mode".

9.8.3 For WebSphere

To deploy the Role Manager server and Web applications for WebSphere, refer "Deploying the Oracle Role Manager Web Application" and "Deploying the Oracle Role Manager Server".