7 Preparing to Upgrade Oracle Identity Analytics

This chapter contains the following sections:

In this phase of the upgrade process you will document your existing environment, document any custom components, and choose an upgrade version.

7.1 Documenting the Existing Environment

Document your existing environment, including the following items:

  1. Application servers - Record the application server name and version number, including any service packs.

    Also, note the following:

    1. The operating system version number, including any service packs.

    2. The version number of the Java Development Kit (JDK) installed on the application server.

  2. Database servers - Record the database server name and version number and any additional service packs.

  3. Supported resources - Record the names of all supported resources, including version numbers, and any installed service packs. Supported resources also include integrated provisioning servers, such as Oracle Identity Manager.

  4. Web servers - Record the name and version number of any web servers, including any additional service packs.

7.2 Documenting the Oracle Identity Analytics Installation

Document your Oracle Identity Analytics installation, including the release and build version number.

7.2.1 To Obtain the Oracle Identity Analytics Release and Build Version

The Oracle Identity Analytics release version information can be obtained using any of the following steps.

  • To obtain version information from the rbacx.log file, do the following:

    1. Start Oracle Identity Analytics.

    2. Open the rbacx.log file located in the $RBACX_HOME/logs folder.

    3. Search the log for the Oracle Identity Analytics version information. The Oracle Identity Analytics version number is written to the log when Oracle Identity Analytics is started, for example:

      Oracle Identity Analytics (build: 5.0.0.200910016491-GA) Started

  • To obtain version information from VERSION.txt within the .war file, do the following:

    1. Navigate to the exploded_rbacx.war_directory/WEB-INF/classes directory.

    2. Locate VERSION.txt and view the contents using a text-editor.

    3. Search for the Implementation-Version tag, which contains the release version number.

      For example, Implementation-Version=5.0.0.200910016491-GA.

  • To obtain version information from MANIFEST.MF within the .war file, do the following:

    1. Navigate to exploded_rbacx.war_directory/META-INF directory.

    2. Using a text-editor, open the MANIFEST.MF file.

    3. Search for the Implementation-Version tag, which contains the release version number.

      For example, Implementation-Version=5.0.0.200910016491-GA.

  • To obtain only the version number, do the following:

    1. Log on to the Oracle Identity Analytics user interface.

    2. Click About in the top-right corner of the screen.

      A window containing the version number opens, for example Version 11.1.1.5.0.

7.3 Documenting Custom Components

Document any custom components, including the following:

  • Custom File-System Objects

  • Custom Repository Objects

7.3.1 Documenting Custom File-System Objects

Oracle recommends upgrading custom file-system objects. File-system objects that may have been customized include the following:

  • Modified iam.properties file - Record any changes made to the default iam.properties file.

  • Modified jdbc.properties file - Record any changes made to the default jdbc.properties file.

  • Modified ldap.properties file - Record any changes made to the default ldap.properties file.

  • Modified rm_idm_init.xml file - Record any changes made to the default rm_idm_init.xml file.

  • Modified log4j.properties file - Record any changes made to default log4j.properties file for customized loggings.

  • Modified rbacxmessages.properties file - Record any changes made to the default rbacxmessages.properties file.

  • Modified rbacxaudit-messages.properties file - Record any changes made to the default rbacxaudit-messages.properties file.

  • Customized property files - Record any changes made to other property files on the system.

  • Customized resource adapters (and any other custom Java code) - Customized resource adapters may require recompilation depending on the target Oracle Identity Analytics version. All custom Java that uses Oracle Identity Analytics APIs (including custom resource adapters) requires a recompilation as part of an upgrade. Also, consider other Java classes that may use the Oracle Identity Analytics library.

  • Custom utilities - Custom Java utilities, pre-processors, and data parsers may require review and recompilation depending on the target Oracle Identity version. Plan to re-evaluate the code in these scripts to ensure that they align with database schema changes or application modifications.

  • Modified JavaServer Pages (JSP Files) - Recent Oracle Identity Analytics versions may include API changes. If JSP files were modified during installation, they need to be updated when upgrading. Any JSP file that shipped with the product and was modified during a deployment (or any custom JSP file that uses Oracle Identity Analytics APIs) should be updated so that it is compatible with the JSP structure and API in the target release.

7.3.2 Documenting Custom Repository Objects

Oracle recommends upgrading custom repository objects. Repository objects that may have been customized include the following:

  • Modified E-mail Templates - Custom e-mail templates may require an export to take advantage of current product enhancements.

  • Custom Repository Schema - If a schema change occurred since Oracle Identity Analytics was last installed or upgraded, a schema update is required.

  • Custom Reports

    • Changes made to any reports in the $RBACX_HOME/reports directory should be incorporated into the reports present in the latest version of Oracle Identity Analytics.

    • Do not overwrite reports in the target release with previous versions because any changes made to the Oracle Identity Analytics schema will cause the reports to break.

    • Custom reports uploaded to Oracle Identity Analytics may require modification in order to comply with schema changes.

  • Custom Workflow Steps - Document all custom workflow steps created during Oracle Identity Analytics implementation. These steps would need to be recreated in the newer version of Oracle Identity Analytics.

  • Custom CRON Expression - Custom CRON expressions must be included in the latest version of the Oracle Identity Analytics jobs.xml file, otherwise the CRON expressions will be lost.

  • Custom Import Triggers - To retain previous triggering/scheduling customizations, changes should also be made in the target release scheduling-context.xml file

    Note:

    Any occurrence of REPLACE_ME needs to be changed to FILE_SERVER for feeds imported through the Oracle Identity Analytics file importer module.

7.4 Choosing the Upgrade Version

After completing the inventory assessment, choose the version of Oracle Identity Analytics that fulfills your requirements. You may want the latest version, or you may want a more mature version that has service packs available. It is a recommended that you upgrade to the most recent Oracle Identity Analytics release that is available during your testing time frame.

After choosing the target Oracle Identity Analytics release, verify that your current platform is supported.

Also, do the following:

  • Read the Release Notes for the target Oracle Identity Analytics release. Pay special attention to the Known Issues section to determine if you need to upgrade the operating system, the JDK software, the application server, or any resources.