1. Configuring the Oracle E-Business Suite User Management Application
  2. Upgrading the EBS User Management Connector

7 Upgrading the EBS User Management Connector

If you have already deployed the 11.1.1.5.0 version of this connector, then upgrade the connector to the current release 12.2.1.3.0.

Note:

Before you perform the upgrade procedure:

  • It is strongly recommended that you create a backup of the Oracle Identity Manager database. Refer to the database documentation for information about creating a backup.

  • As a best practice, perform the upgrade procedure in a test environment initially.

See Also:

Upgrading Connectors in Oracle Fusion Middleware Administering Oracle Identity Manager for detailed information on these steps

7.1 Preupgrade Steps

Preupgrade steps for the connector involves performing a reconciliation run to fetch records from the target system, defining the source connector in Oracle Identity Manager, creating copies of the connector if you want to configure it for multiple installations of the target system, and disabling all the scheduled jobs.

Perform the following preupgrade steps:

  1. Perform a reconciliation run to fetch all latest updates to Oracle Identity Manager.
  2. Perform the preupgrade procedure documented in Managing Connector Lifecycle in Oracle Fusion Middleware Administering Oracle Identity Manager.
  3. Define the source connector (an earlier release of the connector that must be upgraded) in Oracle Identity Manager. You define the source connector to update the Deployment Manager XML file with all customization changes made to the connector. See Managing Connector Lifecycle in Oracle Fusion Middleware Administering Oracle Identity Manager for more information.
  4. If required, create the connector XML file for a clone of the source connector.
  5. Disable all the scheduled jobs.

7.2 Upgrade Steps

This is a summary of the procedure to upgrade the connector for both staging and production environments.

Depending on the environment in which you are upgrading the connector, perform one of the following steps:

  • Staging Environment

    Perform the upgrade procedure by using the wizard mode.

    Note:

    Do not upgrade IT resource type definition. In order to retain the default setting, you must map the IT resource definition to "None".

  • Production Environment

    Perform the upgrade procedure by using the silent mode.

See Managing Connector Lifecycle in Oracle Fusion Middleware Administering Oracle Identity Manager for detailed information about the wizard and silent modes.

7.3 Postupgrade Steps

Depending on the connector you are upgrading from, perform one of the following procedures::

7.3.1 Postupgrade Steps for the Oracle EBS UM TCA Connector from Release 9.1.0.7.x to 11.x

Perform the following procedure if you are upgrading the Oracle EBS UM TCA connector from release 9.1.0.7.x to this release:

  1. Download the latest version of this connector from Oracle Technology Network and extract its contents to any directory on the computer hosting Oracle Identity Manager.

  2. Run the Upload JARs utility to post the latest version of the connector bundle JAR file (org.identityconnectors.ebs-1.0.1115.jar) from the /bundle directory of the installation media to the Oracle Identity Governance database.

    For Microsoft Windows:

    OIM_HOME/server/bin/UploadJars.bat

    For UNIX:

    OIM_HOME/server/bin/UploadJars.sh

    When you run the utility, you are prompted to enter the login credentials of the Oracle Identity Governance administrator, URL of the Oracle Identity Governance host computer, context factory value, type of JAR file being uploaded (specify the JAR type as ICFBundle, option 4), and the location from which the JAR file is to be uploaded.

  3. Run the Form Version Control (FVC) utility to manage data changes on a form after an upgrade operation. To do so:

    1. In a text editor, open the fvc.properties file located in the OIM_DC_HOME directory and include the following entries: 

      ResourceObject;Oracle EBS User Management
FormName;UD_EBST_USR
FromVersion;SPECIFY_THE_VERSION_OF_FORM_THAT_WAS_IN_THE_ACTIVE_STATUS_BEFORE_THE_UPGRADE
ToVersion;SPECIFY_THE_VERSION_OF_FORM_THAT_IS_IN_THE_ACTIVE_STATUS_AFTER_THE_UPGRADE

    2. Run the FVC utility. This utility is copied into the following directory when you install the design console:

      For Microsoft Windows:

      OIM_DC_HOME/fvcutil.bat

      For UNIX:

      OIM_DC_HOME/fvcutil.sh

      When you run this utility, you are prompted to enter the login credentials of the Oracle Identity Governance administrator, and the logger level and log file location.

  4. Run the Post Upgrade Script as follows:

    1. Connect to the Oracle Identity Manager database by using the OIG User credentials.

    2. Run the PostUpgradeScript_TCAEBSUM.sql script located in the OIM_HOME/server/ConnectorDefaultDirectory/EBSUM_PCKG/upgrade directory.

  5. Configure the upgraded IT resource of the source connector.

  6. Change the literal value for child forms as follows:

    1. Log in to the Design Console.

    2. Expand Process Management, and then double-click Process Definition.

    3. Search for and open the Oracle EBS UM User process definition.

    4. On the Tasks tab, double-click the Add User Responsibility process task.

      The Editing Task: Add User Responsibility dialog box is displayed.

    5. On the Integration tab, double-click the childTableName adapter variable.

      The Edit Mapping for Variable dialog box is displayed.

    6. In the Literal Value field, change the value from UD_UM_RESP to UD_EBST_RSP.

    7. Click the Save icon and close the dialog box.

    8. Repeat Steps 6.d through 6.g for the Update User Responsibility and Remove User Responsibility process tasks.

    9. Repeat Steps 6.d through 6.g for the Add User Role, Update User Role, and Remove User Role process tasks by changing the value of the Literal Value field from UD_UM_ROLE to UD_EBST_RLS.

  7. Change the name of the child form in the Lookup.Oracle EBS UM.UM.ProvAttrMap lookup definition as follows:

    1. Expand Administration, and then double-click Lookup Definition.

    2. Search for and open the Lookup.Oracle EBS UM.UM.ProvAttrMap lookup definition.

    3. Search for all entries beginning with UD_UM_RESP and replace it with UD_EBST_RSP. For example, replace the UD_UM_RESP~Application Name[LOOKUP] entry with UD_EBST_RSP~Application Name[LOOKUP].

      Similarly, search for all entries beginning with UD_UM_ROLE and replace it with UD_EBST_RLS. For example, replace the UD_UM_ROLE~Role Start Date[DATE] entry with UD_EBST_RLS~Role Start Date[DATE].

    4. Click the Save icon.

  8. Change the literal value for the parent form as follows:

    1. Expand Development Tools, and then double-click Form Designer.

    2. Search for and open the UD_EBST_USR form.

    3. On the Additional Columns tab, double-click the UD_EBS_UM Updated process form.

      The Editing Task: UD_EBS_UM Updated dialog box is displayed.

    4. On the Integration tab, change the literal value from UD_EBS_UM to UD_EBST_USR.

    5. Click the Save icon and close the dialog box.

  9. Remove the old prepopulate adapter associated with the process form field as follows:

    1. Expand Development Tools, and then double-click Form Designer.

    2. Search for and open the UD_EBST_USR form.

    3. Create a new version (for example, v_11.1.1.5.0_1) of the form and save it.

    4. Select the newly created form version.

    5. On the Pre-Populate tab, select the row containing the old prepopulate adapter EBSPrePopFirstName, and then click Delete.

    6. Click OK in the Alert dialog box to confirm that you want to proceed with deleting the prepopulate adapter.

    7. Repeat Steps 9.e and 9.f to delete the EBSPrePopLastName prepopulate adapter associated with the Party Last Name form field.

    8. Click the Save icon and then Click Make Version Active.

  10. Update the localization properties. To do so, you must update the resource bundle of a user locale with new names of the process form attributes for proper translations after upgrading the connector. You can modify the properties file of your locale in the resources directory of the connector bundle.

    For example, the process form (UD_EBS_UM) attributes are referenced in the Japanese properties file, EBS-UM_ja.properties, as global.udf.UD_EBS_UM_PARTY_FNAME. During upgrade, the process form name is changed to old form name UD_EBST_USR (in case of EBS UM TCA upgrade) or UD_EBS_USER (in case of EBS Plain UM upgrade) to global.udf.UD_EBS_UM_PARTY_FNAME. Therefore, you must add the process form attributes to global.udf.UD_EBS_UM_PARTY_FNAME.

  11. Restart Oracle Identity Manager. Alternatively, you can purge the cache for the changes to reflect in Oracle Identity Governance. See Purging Cache in Oracle Fusion Middleware Administering Oracle Identity Manager for more information about the PurgeCache utility.

  12. Replicate all the changes made to the Form Designer of the Design Console to a new UI form as follows:

    1. Log in to Oracle Identity System Administration.

    2. Create and active a sandbox. See Creating and Activating a Sandbox for more information.

    3. Create a new UI form to view the upgraded fields. See Creating a New UI Form for more information about creating a UI form.

    4. Associate the newly created UI form with the application instance of your target system. To do so, open the existing application instance for your resource, from the Form field, select the form (created in the previous step), and then save the application instance.

    5. Publish the sandbox. See Publishing a Sandbox for more information.

After upgrading the connector, you can perform either full reconciliation or incremental reconciliation. This ensures that records created or modified since the last reconciliation run (the one that you performed in Preupgrade Steps) are fetched into Oracle Identity Manager. From the next reconciliation run onward, the reconciliation engine automatically enters a value for the Latest Token attribute.

Before you perform lookup field synchronization, ensure to remove all preupgrade entries from the lookup definitions Oracle Identity Governance. After upgrade these values must be synchronized with the lookup fields in the target system.

See Performing Full and Incremental Reconciliation for more information about performing full or incremental reconciliation.

7.3.2 Postupgrade Steps for the Oracle EBS UM TCA Connector from Release 11.x to this Release

Perform the following procedure if you are upgrading the Oracle EBS UM TCA connector from release 9.1.0.7.x to this release.

  1. Download the latest version of this connector from Oracle Technology Network and extract its contents to any directory on the computer hosting Oracle Identity Manager.

  2. Run the Upload JARs utility to post the latest version of the connector bundle JAR file (org.identityconnectors.ebs-1.0.1115.jar) from the /bundle directory of the installation media to the Oracle Identity Governance database.

    For Microsoft Windows:

    OIM_HOME/server/bin/UploadJars.bat

    For UNIX:

    OIM_HOME/server/bin/UploadJars.sh

    When you run the utility, you are prompted to enter the login credentials of the Oracle Identity Governance administrator, URL of the Oracle Identity Governance host computer, context factory value, type of JAR file being uploaded (specify the JAR type as ICFBundle, option 4), and the location from which the JAR file is to be uploaded.

  3. Run the Form Version Control (FVC) utility to manage data changes on a form after an upgrade operation. To do so:

    1. In a text editor, open the fvc.properties file located in the OIM_DC_HOME directory and include the following entries: 

      ResourceObject;Oracle EBS User Management
FormName;UD_EBST_USR
FromVersion;SPECIFY_THE_VERSION_OF_FORM_THAT_WAS_IN_THE_ACTIVE_STATUS_BEFORE_THE_UPGRADE
ToVersion;SPECIFY_THE_VERSION_OF_FORM_THAT_IS_IN_THE_ACTIVE_STATUS_AFTER_THE_UPGRADE

    2. Run the FVC utility. This utility is copied into the following directory when you install the design console:

      For Microsoft Windows:

      OIM_DC_HOME/fvcutil.bat

      For UNIX:

      OIM_DC_HOME/fvcutil.sh

      When you run this utility, you are prompted to enter the login credentials of the Oracle Identity Governance administrator, and the logger level and log file location.

  4. Run the Post Upgrade Script as follows:

    1. Connect to the Oracle Identity Manager database by using the OIG User credentials.

    2. Run the PostUpgradeScript_TCAEBSUM.sql script located in the OIM_HOME/server/ConnectorDefaultDirectory/EBSUM_PCKG/upgrade directory.

7.3.3 Postupgrade Steps for the Oracle EBS UM Connector from Release 9.1.0.7.x to 11.x

Perform the following procedure if you are upgrading the Oracle EBS UM connector from release 9.1.0.7.x to 11.x:

  1. Download the latest version of this connector from Oracle Technology Network and extract its contents to any directory on the computer hosting Oracle Identity Governance.

  2. Run the Upload JARs utility to post the latest version of the connector bundle JAR file (org.identityconnectors.ebs-1.0.1115.jar) from the /bundle directory of the installation media to the Oracle Identity Governance database.

    For Microsoft Windows:

    OIM_HOME/server/bin/UploadJars.bat

    For UNIX:

    OIM_HOME/server/bin/UploadJars.sh

    When you run the utility, you are prompted to enter the login credentials of the Oracle Identity Governance administrator, URL of the Oracle Identity Governance host computer, context factory value, type of JAR file being uploaded (specify the JAR type as ICFBundle, option 4), and the location from which the JAR file is to be uploaded.

  3. Run the Form Version Control (FVC) utility to manage data changes on a form after an upgrade operation. To do so:

    1. In a text editor, open the fvc.properties file located in the OIM_DC_HOME directory and include the following entries: 

      ResourceObject;Oracle EBS User Management
FormName;UD_EBS_USER
FromVersion;SPECIFY_THE_VERSION_OF_FORM_THAT_WAS_IN_THE_ACTIVE_STATUS_BEFORE_THE_UPGRADE
ToVersion;SPECIFY_THE_VERSION_OF_FORM_THAT_IS_IN_THE_ACTIVE_STATUS_AFTER_THE_UPGRADE

    2. Run the FVC utility. This utility is copied into the following directory when you install the design console:

      For Microsoft Windows:

      OIM_DC_HOME/fvcutil.bat

      For UNIX:

      OIM_DC_HOME/fvcutil.sh

      When you run this utility, you are prompted to enter the login credentials of the Oracle Identity Governance administrator, and the logger level and log file location.

  4. Run the Post Upgrade Script as follows:

    1. Connect to the Oracle Identity Manager database by using the OIG User credentials.

    2. Run the PostUpgradeScript_PlainEBSUM.sql script located in the OIM_HOME/server/ConnectorDefaultDirectory/EBSUM_PCKG/upgrade directory.

  5. Configure the upgraded IT resource of the source connector.

  6. Change the literal value for child forms as follows:

    1. Log in to the Design Console.

    2. Expand Process Management, and then double-click Process Definition.

    3. Search for and open the Oracle EBS UM User process definition.

    4. On the Tasks tab, double-click the Add User Responsibility process task.

      The Editing Task: Add User Responsibility dialog box is displayed.

    5. On the Integration tab, double-click the childTableName adapter variable.

      The Edit Mapping for Variable dialog box is displayed.

    6. In the Literal Value field, change the value from UD_UM_RESP to UD_EBS_RESP.

    7. Click the Save icon and close the dialog box.

    8. Repeat Steps 6.d through 6.g for the Update User Responsibility and Remove User Responsibility process tasks.

    9. Repeat Steps 6.d through 6.g for the Add User Role, Update User Role, Remove User Role process tasks by changing the value of the Literal Value field from UD_UM_ROLE to UD_EBS_RLS.

  7. Change the name of the child form in the Lookup.Oracle EBS UM.UM.ProvAttrMap lookup definition as follows:

    1. Expand Administration, and then double-click Lookup Definition.

    2. Search for and open the Lookup.Oracle EBS UM.UM.ProvAttrMap lookup definition.

    3. In the Code Key column, search for all entries beginning with UD_UM_RESP and replace it with UD_EBS_RESP. For example, replace the UD_UM_RESP~Application Name[LOOKUP] entry with UD_EBS_RESP~Application Name[LOOKUP].

      Similarly, search for all entries beginning with UD_UM_ROLE and replace it with UD_EBS_RLS. For example, replace the UD_UM_ROLE~Role Start Date[DATE] entry with UD_EBS_RLS~Role Start Date[DATE].

    4. Click the Save icon.

  8. Change the literal value for the parent form as follows:

    1. Expand Development Tools, and then double-click Form Designer.

    2. Search for and open the UD_EBST_USR form.

    3. On the Additional Columns tab, double-click the UD_EBS_UM Updated process form.

      The Editing Task: UD_EBS_UM Updated dialog box is displayed.

    4. On the Integration tab, change the literal value from UD_EBS_UM to UD_EBS_USER.

    5. Click the Save icon and close the dialog box.

  9. Remove the old repopulate adapter associated with the process form field as follows:

    1. Expand Development Tools and then double-click Form Designer.

    2. Search for and open the UD_EBS_USER form.

    3. Create a new version (for example, v_11.1.1.5.0_1) of the form and save it.

    4. Select the newly created form version.

    5. On the Pr-Populate tab, select the row containing the old repopulate adapter Disproportionate, and then click Delete.

    6. Click OK in the Alert dialog box to confirm that you want to proceed with deleting the repopulate adapter.

    7. Click the Save icon and then click Make Version Active.

  10. Update the localization properties. To do so, you must update the resource bundle of a user locale with new names of the process form attributes for proper translations after upgrading the connector. You can modify the properties file of your locale in the resources directory of the connector bundle.

    For example, the process form (UD_EBS_UM) attributes are referenced in the Japanese properties file, ENS-UM_ja.properties, as global.udf.UD_EBS_UM_PARTY_FNAME. During upgrade, the process form name is changed to old form name UD_EBST_USR (in case of EBS UM TCA upgrade) or UD_EBS_USER (in case of EBS Plain UM upgrade) to global.udf.UD_EBS_UM_PARTY_FNAME. Therefore, you must add the process form attributes to global.udf.UD_EBS_UM_PARTY_FNAME.

  11. Restart Oracle Identity Governance. Alternatively, you can purge the cache for the changes to reflect in Oracle Identity Manager. See Purging Cache in Oracle Fusion Middleware Administering Oracle Identity Manager for more information about the Purge Cache utility.

  12. Replicate all the changes made to the Form Designer of the Design Console to a new UI form as follows:

    1. Log in to Oracle Identity System Administration.

    2. Create and active a sandbox. See Creating and Activating a Sandbox for more information.

    3. Create a new UI form to view the upgraded fields. See Creating a New UI Form for more information about creating a UI form.

    4. Associate the newly created UI form with the application instance of your target system. To do so, open the existing application instance for your resource, from the Form field, select the form (created in the previous step), and then save the application instance.

    5. Publish the sandbox. See Publishing a Sandbox for more information.

After upgrading the connector, you can perform either full reconciliation or incremental reconciliation. This ensures that records created or modified since the last reconciliation run (the one that you performed in Preupgrade Steps) are fetched into Oracle Identity Governance. From the next reconciliation run onward, the reconciliation engine automatically enters a value for the Latest Token attribute.

Before you perform lookup field synchronization, ensure to remove all upgradeable entries from the lookup definitions Oracle Identity Manager. After upgrade these values must be synchronized with the lookup fields in the target system.

See Performing Full and Incremental Reconciliation for more information about performing full or incremental reconciliation.

7.3.4 Postupgrade Steps for the Oracle EBS UM Connector from Release 11.x to this Release

Perform the following procedure if you are upgrading the Oracle EBS UM connector from release 9.1.0.7.x to this release:

  1. Download the latest version of this connector from Oracle Technology Network and extract its contents to any directory on the computer hosting Oracle Identity Governance.

  2. Run the Upload JARs utility to post the latest version of the connector bundle JAR file (org.identityconnectors.ebs-1.0.1115.jar) from the /bundle directory of the installation media to the Oracle Identity Governance database.

    For Microsoft Windows:

    OIM_HOME/server/bin/UploadJars.bat

    For UNIX:

    OIM_HOME/server/bin/UploadJars.sh

    When you run the utility, you are prompted to enter the login credentials of the Oracle Identity Governance administrator, URL of the Oracle Identity Governance host computer, context factory value, type of JAR file being uploaded (specify the JAR type as ICFBundle, option 4), and the location from which the JAR file is to be uploaded.

  3. Run the Form Version Control (FVC) utility to manage data changes on a form after an upgrade operation. To do so:

    1. In a text editor, open the fvc.properties file located in the OIM_DC_HOME directory and include the following entries: 

      ResourceObject;Oracle EBS User Management
FormName;UD_EBS_USER
FromVersion;SPECIFY_THE_VERSION_OF_FORM_THAT_WAS_IN_THE_ACTIVE_STATUS_BEFORE_THE_UPGRADE
ToVersion;SPECIFY_THE_VERSION_OF_FORM_THAT_IS_IN_THE_ACTIVE_STATUS_AFTER_THE_UPGRADE

    2. Run the FVC utility. This utility is copied into the following directory when you install the design console:

      For Microsoft Windows:

      OIM_DC_HOME/fvcutil.bat

      For UNIX:

      OIM_DC_HOME/fvcutil.sh

      When you run this utility, you are prompted to enter the login credentials of the Oracle Identity Governance administrator, and the logger level and log file location.

  4. Run the Post Upgrade Script as follows:

    1. Connect to the Oracle Identity Manager database by using the OIG User credentials.

    2. Run the PostUpgradeScript_PlainEBSUM.sql script located in the OIM_HOME/server/ConnectorDefaultDirectory/EBSUM_PCKG/upgrade directory.