Skip Headers
Oracle® Identity Manager Upgrade Guide
Release 9.1.0 ( Upgrade)

Part Number E13340-01
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

F UPA Form Data Upgrade Utility

This appendix provides information about the UPA Form Data Upgrade Utility. This utility is mandatory facilitates exception-based reporting. You must run this utility after running the GenerateSnapshot utility.

F.1 Introduction

Oracle Identity Manager release 9.1.0 features exception-based reporting for resource access and fine-grained attributes related to the resource instance. The form data and changes to it on which these exception reports work are available in the two newly introduced tables in release 9.1.0: UPA_UD_FORMS and UPA_UD_FORMFIELDS. These two tables are populated only if the value of the XL.EnableExceptionReports system configuration property is set to TRUE.

Suppose the exception reports feature is disabled and you plan to enable the feature by changing the value of the XL.EnableExceptionReports property to TRUE. While the exception reports feature is disabled, there is no baseline process form data in the newly introduced UPA_UD_FORMS and UPA_UD_FORMFIELDS tables. As a result, the exception reports will fail.

The UPA Form Data Upgrade utility helps you solve this problem. To run this utility, the exception reporting feature is enabled. The utility runs through all the entitlements. For provisioning instances that have a resource with either a process or an object form attached, the utility reads the data on the form and stores them in the two database tables.

Subsequent changes to the form is automatically captured after the upgrade. With the baseline available, the exception reports start reporting on exceptions. The utility creates a log file named UPA_Form_Data_Upgrade_TIMESTAMP.log after the process is complete.


In this release, provisioning is initiated from Oracle Identity Manager. As a result, the two database tables contain the baseline for the process form data. Any successive updates through reconciliation are captured and reported as an exception if the values differ.

F.2 Generating Process/Object Form Data by Using the UPA Form Data Upgrade Utility

If you have installed Oracle Identity Manager Audit and Compliance module, then you must generate the process or object form data only if the following conditions apply together:


Use this utility only after enabling the exception reporting feature. If some previous runs resulted in some kind of error, then the utility could be run multiple times at the time of enabling the exception reporting feature. The utility should not be used at any other time when the environment is functional.

In case of audit-related failures in a functional environment, use the Generate Snapshot utility. Do not use this utility if the Generate Snapshot utility is being used as part of the upgrade process because the Generate Snapshot utility will perform the task of this utility also.

See Also:

Appendix G, "Generating GPA Snapshots" for more information about the Generate Snapshot utility

F.2.1 Working with UPA Form Data Upgrade Utility

To use the UPA Form Data Upgrade utility, perform the following steps:

Copying the UPA Form Data Upgrade Utility Files

Copy the UPA Form Data Upgrade utility files to your local computer. Before using the utility, copy the UPAFormDataUpgradeUtility directory from the PATCH/db/oracle/Utilities directory on the installation media to your local computer.

Configuring the Scripts

Following are the settings for the Oracle Database Batch/Shell file:

  • For Microsoft Windows: Edit the following file:


  • For UNIX: Edit the following file:


Table F-1 shows the values of the variables that must be set before you run the utility:

Table F-1 Variables of the UPA Form Data Upgrade Utility

Variables Description


Oracle home directory.


Username for the Oracle Identity Manager database user


Password for the Oracle Identity Manager database user


Describes if the database is running on a remote computer.

Set a value for this parameter if OIM_DB_REMOTE = Y or OIM_DB_REMOTE = N..


SID of the database.

Set a value for this parameter only if OIM_DB_REMOTE = N.


TNS service name that points to the remote database.

Set a value for this parameter only if OIM_DB_REMOTE = Y.

Compiling the Stored Procedure

For Oracle, perform the following steps:

  1. Log in to SQL *Plus with the credentials of the Oracle Identity Manager release database schema owner.

  2. Run the following script:


Running the Utility

Oracle Database

On Microsoft Windows:

Run the batch file UPAFormDataUpgrade.bat from the following location:



Run the shell file from the following location: