6 Upgrading the Generic REST Connector

If you have already deployed the 11.1.1.5.0 version of the Generic REST connector, then you can upgrade the connector to version 12.2.1.3.0 by uploading the new connector JAR files to the Oracle Identity Manager database.

The following topics describe the procedures for upgrading the Generic REST Connector:

See Also:

For detailed steps on upgrading Connectors in Oracle Fusion Middleware Administering, see the Oracle Fusion Middleware Administering Oracle Identity Manager guide.

6.1 Preupgrade Steps

The 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.

Note:

It is strongly recommended that you create a backup of the Oracle Identity Manager database and the connector JARs before you perform an upgrade operation. Refer to the database documentation for information about creating a backup.

As a best practice, first perform the upgrade procedure in a test environment. Perform the following pre upgrade steps:

  1. Perform a reconciliation run to fetch all the latest updates to Oracle Identity Manager.
  2. Perform the preupgrade procedure as documented in the Managing Connector Lifecycle in Oracle Fusion Middleware Administering Oracle Identity Manager.
  3. Disable all the scheduled jobs.

6.2 Upgrade Steps

Update the following Decode entries in the Lookup.<Connector name>.Configuration and Lookup.<Connector name>.Configuration.Truested lookup definition: Code Key: Bundle Version; Decode: 1.0.1115

New Decode: 12.3.0

6.3 Post upgrade Steps

Post upgrade steps involve uploading new connector JAR to Oracle Identity Manager database.

To perform the post-upgrade, perform the following procedure:
  1. Delete the old Connector JARs. Run the Oracle Identity Manager Delete JARs ($ORACLE_HOME/bin/DeleteJars.sh) utility to delete the existing ICF bundleorg.identityconnectors.genericrest-1.0.11150.jar from the Oracle Identity Manager database.
    When you run the Delete JARs utility, you are prompted to enter your log in credentials for the Oracle Identity Manager administrator, URL of the Oracle Identity Manager host computer, context factory value, type of JAR file being deleted, and the name of the JAR file to be removed. Specify 4 as the value of the JAR type.
  2. Upload the new connector JARs by performing the following steps:
    1. Run the Oracle Identity Manager Upload JARs ($ORACLE_HOME/bin/UploadJars.sh) utility to upload the connector JARs.
    2. Upload the org.identityconnectors.genericrest-12.3.0.jar bundle as an ICF Bundle. Run the Oracle Identity Manager Upload JARs utility to post the new ICF bundle.org.identityconnectors.genericrest-12.3.0.jar file to the Oracle Identity Manager database.
      When you run the Upload JARs utility, you are prompted to enter the log in credentials of the Oracle Identity Manager administrator, URL of the Oracle Identity Manager host computer, context factory value, type of JAR file being uploaded, and the location from which the JAR file is to be uploaded. Specify 4 as the value of the JAR type.
    3. Reconfigure the IT resource of the connector if the IT resource details are updated.
  3. Restart the Oracle Identity Manager.
  4. Perform full reconciliation and delete reconciliation(if applicable).
  5. If the connector is deployed on a Connector Server, then perform the following:
    1. Stop the connector server.
    2. Replace the existing bundle JAR fileorg.identityconnectors.genericrest-1.0.1115.jar with the new bundle JAR file org.identityconnectors.genericrest-12.3.0.jar.
    3. Start the connector server.

    Note:

    If you have configured the connector for multiple versions of target system, see Configuring the Connector for Multiple Installations of the Target System.

    See Also:

    Configuring Oracle Identity Governance for information about creating, activating, and publishing a sandbox and creating a new UI form.

Note:

  1. After upgrading to the 12.x Generic REST connector, if you require Target Resource User Reconciliation and Delete Reconciliation support (if target supports), perform the steps given in the below sections 6.3.1 and 6.3.2.
  2. For incremental reconciliation support update the target Resource User Reconciliation, by following the steps in Target Resource User Reconciliation.
  3. For delete Reconciliation support, refer to the Target User Delete Reconciliation.

6.3.1 Target Resource User Reconciliation

For Incremental Recon, update the Target Resource User Reconciliation.
You must update the Target Resource User Reconciliation, by performing the following procedure:
  1. Log in to the System Administration and expand System Configuration >Export Form OIG > Target Resource User Reconciliation> Scheduler and save xml as Target Resource User Reconciliation.xml.
  2. Open Target Resource User Reconciliation.xml in edit plus.
  3. Add the following code text before </parameters>: <string-param required="false" encrypted="false" helpText="Incremental Recon Attribute">Incremental Recon Attribute</string-param><string-param required="false" encrypted="false" helpText="Latest Token">Latest Token</string-param>
  4. Save XML.
  5. Log in to the System Administration and expand System Configuration, then import to OIG Target Resource User Reconciliation.xml. Restart the Oracle Identity Manager Server for changes to take effect.

6.3.2 Target User Delete Reconciliation

Create the Target User Delete Reconciliation Job by performing the following steps:
  1. Rename Target Resource User Reconciliation.xml as Target User Delete Reconciliation.xml.
  2. Open Target User Delete Reconciliation.xml in edit plus and perform the following changes:
    1. scheduledTask name=Target User Delete Reconciliation & mds-file as Target User Delete Reconciliation.xml
    2. Update the name, class, description as given below:<name> Target User Delete Reconciliation</name> <class>oracle.iam.connectors.icfcommon.recon.SearchReconDeleteTask</class> <description> Target User Delete Reconciliation</description>
    3. Update <parameters> as given below:<parameters> <string-param required="false" encrypted="false" helpText="IT Resource Name">IT Resource Name</string-param> <string-param required="false" encrypted="false" helpText="Object Type">Object Type</string-param> <string-param required="false" encrypted="false" helpText="Resource Object Name">Resource Object Name</string-param> </parameters>
    4. Add the below Job tag before </xl-ddm-data>:
      <Job repo-type="API" name=" Target User Delete Reconciliation ">
      <retrycount>0</retrycount>
      <method>executeJob</method>
      <taskKey>250</taskKey>
      <taskClassName>oracle.iam.connectors.icfcommon.recon.SearchReconDeleteTask</taskClassName>
      <concurrent>false</concurrent>
      <jobScheduleType>None</jobScheduleType>
      <attributes>
      <object>
      <key>Resource Object Name</key>
      <value type="jobparameter">
      <name type="string">Resource Object Name</name>
      <required type="boolean">false</required>
      <encrypted type="boolean">false</encrypted>
      <helpText type="string">Resource Object Name</helpText>
      <dataType type="string">String</dataType>
      <paramKey type="string">37</paramKey>
      <paramValue type="string">O365 Target User</paramValue>
      </value>
      </object>
      <object>
      <key>IT Resource Name</key>
      <value type="jobparameter">
      <name type="string">IT Resource Name</name>
      <required type="boolean">false</required>
      <encrypted type="boolean">false</encrypted>
      <helpText type="string">IT Resource Name</helpText>
      <dataType type="string">String</dataType>
      <paramKey type="string">35</paramKey>
      <paramValue type="string">O365 Target</paramValue>
      </value>
      </object>
      <object>
      <key>Object Type</key>
      <value type="jobparameter">
      <name type="string">Object Type</name>
      <required type="boolean">false</required>
      <encrypted type="boolean">false</encrypted>
      <helpText type="string">Object Type</helpText>
      <dataType type="string">String</dataType>
      <paramKey type="string">36</paramKey>
      <paramValue type="string">User</paramValue>
      </value>
      </object>
      </attributes>
      <lastModifyDate>1523209246378</lastModifyDate>
      <taskStatus>false</taskStatus>
      <source-scope type="scheduledTask" name=" Target User Delete Reconciliation "/>
      <taskName scheduledTask=" Target User Delete Reconciliation "/>
      </Job>
  3. Save the XML file.
  4. Log in to the System Administration and expand System Configuration and import to OIG Target User Delete Reconciliation.xml.
  5. Update the Scheduler job parameters based on your requirement.