2 Deploying the Connector

To deploy the connector, perform the procedures described in the following sections:

2.1 Preinstallation

Preinstallation information is divided across the following sections:

2.1.1 Preinstallation on Oracle Identity Manager

This section contains the following topics:

2.1.1.1 Files and Directories On the Installation Media

Table 2-1 describes the files and directories on the installation media.

Table 2-1 Files and Directories On the Installation Media

File in the Installation Media Directory Description

configuration/EDirectory-CI.xml

This XML file contains configuration information that is used during connector installation.

lib/eDirProv.jar

This JAR file contains the class files required for provisioning. During connector installation, this file is copied to the following location:

  • For Oracle Identity Manager release 9.1.0.x: OIM_HOME/xellerate/JavaTasks

  • For Oracle Identity Manager release 11.1.x: Oracle Identity Manager database

lib/eDirRecon.jar

This JAR file contains the class files required for reconciliation. During connector installation, this file is copied to the following location:

  • For Oracle Identity Manager release 9.1.0.x: OIM_HOME/xellerate/ScheduleTask

  • For Oracle Identity Manager release 11.1.x: Oracle Identity Manager database

lib/eDirRemote.jar

This JAR file contains the class file required for creation of a user's Home directory. During connector deployment, this file is copied to the following location:

  • For Oracle Identity Manager release 9.1.0.x: OIM_HOME/xellerate/JavaTasks

  • For Oracle Identity Manager release 11.1.x: Oracle Identity Manager database

lib/eDirRM.jar

This JAR file contains the class file required to check the Remote Manger connections. During connector deployment, this file is copied to the following location:

  • For Oracle Identity Manager release 9.1.0.x: OIM_HOME/xellerate/JavaTasks

  • For Oracle Identity Manager release 11.1.x: Oracle Identity Manager database

Files in the resources directory

Each of these resource bundles contains language-specific information that is used by the connector. During connector installation, these resource bundles are copied to the following location:

  • For Oracle Identity Manager release 9.1.0.x: OIM_HOME/xellerate/connectorResources

  • For Oracle Identity Manager release 11.1.x: Oracle Identity Manager database

Note: A resource bundle is a file containing localized versions of the text strings that are displayed on the Administrative and User Console. These text strings include GUI element labels and messages.

Files in the test/troubleshoot directory

These files are used to implement test cases that are run by using the testing utility.

xml/eDirResourceObject.xml

This XML file contains definitions of the various connector components.

xml/eDirXLResourceObject.xml

This XML file contains the configuration for the Xellerate User (OIM User). You import this file only if you plan to use the connector in trusted source reconciliation mode.


Note:

The files in the test/troubleshoot directory are used only to run tests on the connector.

2.1.1.2 Determining the Release Number of the Connector

Note:

If you are using Oracle Identity Manager release 9.0.1 through 9.0.3.2 or release 9.1.0.x, then the procedure described in this section is optional.

If you are using Oracle Identity Manager release 11.1.x, then skip this section.

You might have a deployment of an earlier release of the connector. While deploying the latest release, you might want to know the release number of the earlier release. To determine the release number of the connector that has already been deployed:

  1. In a temporary directory, extract the contents of the following JAR file:

    OIM_HOME/xellerate/JavaTasks/eDirProv.jar

  2. Open the manifest.mf file in a text editor. The manifest.mf file is one of the files bundled inside the eDirProv.jar file.

    In the manifest.mf file, the release number of the connector is displayed as the value of the Version property.

2.1.1.3 Using External Code Files

Note:

In a clustered environment, copy the JAR files and the contents of the OIM_HOME/xellerate/connectorResources directory to the corresponding directories on each node of the cluster.

Copy the following code files into the specified directories:

  • ldap.jar

    The ldap.jar file contains APIs that are used to connect to the target system. You must download this file from the Novell Web site and copy it into the ThirdParty directory as follows:

    1. Log on to the Novell Web site at

      http://developer.novell.com/wiki/index.php/Special:Downloads/jldap/builds/netware_windows/

    2. Download the following file from the Web site:

      novell-jldap-devel-2005.10.03-1netware_windows.zip

      The size of the file is 11.1 MB.

    3. Extract the contents of this ZIP file.

    4. Copy the ldap.jar file from the novell-jldap-devel-2005.10.03-1netware_windows\jldap_2005.10.03\lib directory to the following directory:

      Note:

      In an Oracle Identity Manager cluster, copy this JAR file into the ThirdParty directory on each node of the cluster.
      • For Oracle Identity Manager release 9.0.1 through 9.0.3.2 or release 9.1.0.x:

        OIM_HOME/xellerate/ThirdParty

      • For Oracle Identity Manager release 11.1.x:

        OIM_HOME/server/ThirdParty

  • ldapbp.jar

    The ldapbp.jar file is used by the connector to enable LDAP-based search of user records on the target system. You must download this file from the Sun Web site and copy it into the ThirdParty directory as follows:

    1. Log on to the Sun Web site at

      http://java.sun.com/products/jndi/downloads/index.html

    2. Click Download JNDI 1.2.1 & More.

    3. From the table on the page that is displayed, select and download the file containing the ldapbp.jar file.

    4. Copy the ldapbp.jar file into the following directory:

      Note:

      In an Oracle Identity Manager cluster, copy this JAR file into the ThirdParty directory on each node of the cluster.
      • For Oracle Identity Manager release 9.0.1 through 9.0.3.2 or release 9.1.0.x:

        OIM_HOME/xellerate/ThirdParty

      • For Oracle Identity Manager release 11.1.x:

        OIM_HOME/server/ThirdParty

  • njclv2.jar

    The njclv2.jar file contains APIs that are used to create the home directory on Novell eDirectory. This file is in the lib directory inside the Novell eDirectory installation directory. The following is a sample path:

    NOVELL_CONSOLE_HOME\ndk\nocell-njclc-devel-2008.02.29-1windows\lib\njclv2.jar

    Copy the njclv2.jar file into the following directory:

    Note:

    In an Oracle Identity Manager cluster, copy this JAR file into the ThirdParty directory on each node of the cluster.
    • For Oracle Identity Manager release 9.0.1 through 9.0.3.2 or release 9.1.0.x:

      OIM_HOME/xellerate/ThirdParty

    • For Oracle Identity Manager release 11.1.x:

      OIM_HOME/server/ThirdParty

2.1.2 Preinstallation on the Target System

Preinstallation on the target system involves performing the procedure described in the following section:

2.1.2.1 Installing Role Based Services

Note:

Perform the procedure described in this section only if your target system does not contain the RBS:Role schema.

To support provisioning of roles, you must perform the following procedure:

  1. Log in to Novell ConsoleOne.

  2. From the Tools menu, select Install . . . .

  3. In the Installation Wizard dialog box, click Next to proceed with installing Role Based Services.

  4. On the Select the desired products to install page, from the Product name region, select Role Based Services, and then click Next.

  5. On the Select the desired NDS trees to install to page, from the Authenticated trees region, select the tree (for example, EDIR_88SP6) in which the Role Based Services must be installed, and then click Next.

  6. On the Summary of services to be installed page, verify the services and the trees into which these services are being installed, and then click Finish.

    Installation of Role Based Services is complete.

2.2 Installation

Depending on the Oracle Identity Manager release that you are using, perform the procedure described in one of the following sections:

2.2.1 Installing the Connector on Oracle Identity Manager Release 9.1.0.x and Release 11.1.x

Note:

In this guide, the term Connector Installer has been used to refer to the Connector Installer feature of the Oracle Identity Manager Administrative and User Console.

Installing the connector on Oracle Identity Manager release 9.1.0.x and release 11.1.x involves the following procedures:

2.2.1.1 Running the Connector Installer

To run the Connector Installer:

  1. Copy the contents of the connector installation media directory into the following directory:

    Note:

    In an Oracle Identity Manager cluster, copy this JAR file to each node of the cluster.
    • For Oracle Identity Manager release 9.1.0.x: OIM_HOME/xellerate/ConnectorDefaultDirectory

    • For Oracle Identity Manager release 11.1.x: OIM_HOME/server/ConnectorDefaultDirectory

  2. Log in to the Administrative and User Console by using the user account described in the "Creating the User Account for Installing Connectors" section of the following guide:

    • For Oracle Identity Manager release 9.1.0.x:

      Oracle Identity Manager Administrative and User Console Guide

    • For Oracle Identity Manager release 11.1.x:

      Oracle Fusion Middleware System Administrator's Guide for Oracle Identity Manager

  3. Depending on the Oracle Identity Manager release you are using, perform one of the following steps:

    • For Oracle Identity Manager release 9.1.0.x:

      Click Deployment Management, and then click Install Connector.

    • For Oracle Identity Manager release 11.1.1:

      On the Welcome to Identity Manager Advanced Administration page, in the System Management region, click Install Connector.

    • For Oracle Identity Manager release 11.1.2:

      In the left pane, under System Management, click Manage Connector. In the Manage Connector page, click Install.

  4. From the Connector List list, select Novell eDirectory RELEASE_NUMBER. This list displays the names and release numbers of connectors whose installation files you copy into the default connector installation directory in Step 1.

    If you have copied the installation files into a different directory, then:

    1. In the Alternative Directory field, enter the full path and name of that directory.

    2. To repopulate the list of connectors in the Connector List list, click Refresh.

    3. From the Connector List list, select Novell eDirectory RELEASE_NUMBER.

  5. Click Load.

  6. To start the installation process, click Continue.

    The following tasks are performed in sequence:

    1. Configuration of connector libraries

    2. Import of the connector XML file (through the Deployment Manager)

    3. Compilation of adapters

    On successful completion of a task, a check mark is displayed for the task. If a task fails, then an X mark and a message stating the reason for failure are displayed. Depending on the reason for the failure, make the required correction and then perform one of the following steps:

    • Retry the installation by clicking Retry.

    • Cancel the installation and begin again from Step 0.

  7. If all three tasks of the connector installation process are successful, then a message indicating successful installation is displayed. In addition, a list of the steps that you must perform after the installation is displayed. These steps are as follows:

    1. Ensuring that the prerequisites for using the connector are addressed

      Note:

      At this stage, run the Oracle Identity Manager PurgeCache utility to load the server cache with content from the connector resource bundle in order to view the list of prerequisites. See Section 2.3.5, "Clearing Content Related to Connector Resource Bundles from the Server Cache" for information about running the PurgeCache utility.

      There are no prerequisites for some predefined connectors.

    2. Configuring the IT resource for the connector

      Record the name of the IT resource displayed on this page. The procedure to configure the IT resource is described later in this guide.

    3. Configuring the scheduled tasks that are created when you installed the connector

      Note:

      In Oracle Identity Manager release 11.1.x, a scheduled job is an instance of a scheduled task. In this guide, the term scheduled task used in the context of Oracle Identity Manager release 9.1.0.x is the same as the term scheduled job in the context of Oracle Identity Manager release 11.1.x.

      See Oracle Fusion Middleware System Administrator's Guide for Oracle Identity Manager for more information about scheduled tasks and scheduled jobs.

      Record the names of the scheduled tasks displayed on this page. The procedure to configure these scheduled tasks is described later in this guide.

When you run the Connector Installer, it copies the connector files and external code files to destination directories on the Oracle Identity Manager host computer. These files are listed in Table 2-1.

Installing the Connector in an Oracle Identity Manager Cluster

While installing Oracle Identity Manager in a clustered environment, you must copy all the JAR files and the contents of the connectorResources directory into the corresponding directories on each node of the cluster. See Section 2.1.1.1, "Files and Directories On the Installation Media" for information about the files that you must copy and their destination locations on the Oracle Identity Manager host computer.

2.2.1.2 Configuring the IT Resource

You must specify values for the parameters of the eDirectory IT Resource IT resource as follows:

  1. Depending on the Oracle Identity Manager release you are using, perform one of the following steps:

    • For Oracle Identity Manager release 9.x or 11.1.1:

      Log in to the Administrative and User Console

    • For Oracle Identity Manager release 11.1.2:

      Log in to Oracle Identity System Administration

  2. Depending on the Oracle Identity Manager release you are using, perform one of the following steps:

    • If you are using Oracle Identity Manager release 9.x, expand Resource Management, and then click Manage IT Resource.

    • If you are using Oracle Identity Manager release 11.1.1, then:

      1. On the Welcome to Oracle Identity Manager Self Service page, click Advanced.

      2. On the Welcome to Oracle Identity Manager Advanced Administration page, in the Configuration region, click Manage IT Resource.

    • If you are using Oracle Identity Manager release 11.1.2, then in the left pane under Configuration, click IT Resource.

  3. In the IT Resource Name field on the Manage IT Resource page, enter eDirectory IT Resource and then click Search.

  4. Click the edit icon for the IT resource.

  5. From the list at the top of the page, select Details and Parameters.

  6. Specify values for the parameters of the IT resource. Table 2-2 describes the parameters of the IT resource.

    Table 2-2 Parameters of the IT Resource

    Parameter Description

    Admin ID

    Enter the DN of the user who has administrator rights on the Novell eDirectory server.

    Sample value:

    cn=Admin,o=PXED-DEV
    

    Admin Password

    Enter the password of the user whose DN you enter as the value of the Admin ID parameter.

    Server Address

    Enter the server address of the Novell eDirectory host computer.

    Root DN

    Enter the base DN on which all user operations must be carried out.

    Sample value: o=PXED-DEV

    Port

    Enter the port number to connect to Novell eDirectory.

    Default value: 636

    SSL

    Enter true if you plan to configure SSL to secure communication between Novell eDirectory and Oracle Identity Manager. Otherwise, enter false.

    Default value: true

    Note: It is recommended that you enable SSL to secure communication with the target system.

    Last Recon Target TimeStamp

    For the first target resource reconciliation run, this parameter does not hold any value. For subsequent rounds of reconciliation, the time at which the previous reconciliation run was completed is stored in this parameter.

    See Section 3.3.1, "Full Reconciliation vs. Incremental Reconciliation" for information about using this parameter to switch from incremental to full reconciliation.

    Last Recon Trusted TimeStamp

    For the first trusted source reconciliation run, this parameter does not hold any value. For subsequent rounds of reconciliation, the time at which the previous reconciliation run was completed is stored in this parameter.

    See Section 3.3.1, "Full Reconciliation vs. Incremental Reconciliation" for information about using this parameter to switch from incremental to full reconciliation.

    Prov Attribute Lookup Code

    This parameter holds the name of the lookup definition that stores attribute mappings for provisioning.

    Default value: AttrName.Prov.Map.EDIR

    Note: This value must not be changed.

    Recon Attribute Lookup Code

    This parameter holds the name of the lookup definition that stores attribute mappings for reconciliation.

    Default value: AttrName.Recon.Map.EDIR

    Note: This value must not be changed.

    Role Reconciliation TimeStamp

    For the first role resource reconciliation run, this parameter does not hold any value. For subsequent rounds of reconciliation, the time at which the previous reconciliation run was completed is stored in this parameter automatically.

    Use XL Org Structure

    If set to true, then the Oracle Identity Manager Organization structure is used during provisioning and reconciliation. If set to false, then the value of the Organization field in the process form is used for provisioning and the organization or container in the target LDAP is used for reconciliation.

    Default value: false

    Group Reconciliation TimeStamp

    For the first group resource reconciliation run, the time stamp value is not set. For subsequent rounds of reconciliation, the time at which the previous reconciliation run was completed is stored in this parameter.

    Tree name

    Enter the name of the tree of the domain in which you want to let users create home directories.

    Sample Value: MY_TREE

    Server Name

    Enter the host name of the target system host computer.


  7. To save the values, click Update.

2.2.2 Installing the Connector on Oracle Identity Manager Release 9.0.1 Through 9.0.3.2

Installing the connector on any Oracle Identity Manager release between releases 9.0.1 and 9.0.3.2 involves the following procedures:

2.2.2.1 Copying the Connector Files

The connector files to be copied and the directories to which you must copy them are given in the following table.

See Also:

Section 2.1.1.1, "Files and Directories On the Installation Media" for more information about these files
File in the Installation Media Directory Destination Directory
lib/eDirProv.jar OIM_HOME/xellerate/JavaTasks
lib/eDirRemote.jar OIM_HOME/xellerate/JavaTasks
lib/eDirRM.jar OIM_HOME/xellerate/JavaTasks

Note: Copy this file only if you want to enable provisioning of Home directories.

lib/eDirRecon.jar OIM_HOME/xellerate/ScheduleTask
Files in the resources directory OIM_HOME/xellerate/connectorResources
Files in the test directory OIM_HOME/xellerate/eDir/test/troubleshoot
Files in the xml directory OIM_HOME/xellerate/eDir/xml

Note:

In a clustered environment, copy the JAR files and the contents of the connectorResources directory to the corresponding directories on each node of the cluster.

2.2.2.2 Importing the Connector XML File

Perform this section only if you are using Oracle Identity Manager 9.x versions. As mentioned in Section 2.1.1.1, "Files and Directories On the Installation Media," the connector XML file contains definitions of the components of the connector. By importing the connector XML file, you create these components in Oracle Identity Manager.

To import the connector XML file into Oracle Identity Manager:

  1. Open the Oracle Identity Manager Administrative and User Console.

  2. Click the Deployment Management link on the left navigation bar.

  3. Click the Import link under Deployment Management. A dialog box for opening files is displayed.

  4. Locate and open the eDirResourceObject.xml file, which is in the OIM_HOME/xellerate/eDir/xml directory. Details of this XML file are shown on the File Preview page.

  5. Click Add File. The Substitutions page is displayed.

  6. Click Next. The Confirmation page is displayed.

  7. Click Next. The Provide IT Resource Instance Data page for the eDirectory IT Resource IT resource is displayed.

  8. Specify values for the parameters of this IT resource. Table 2-2 describes the parameters of the IT resource.

  9. Click Next. The Provide IT Resource Instance Data page for a new instance of the LDAP Server IT resource type is displayed.

  10. Click Skip to specify that you do not want to define another IT resource. The Confirmation page is displayed.

    See Also:

    If you want to define another IT resource, then refer to Oracle Identity Manager Administrative and User Console Guide for instructions.
  11. Click View Selections.

    The contents of the XML file are displayed on the Import page. You might see a cross-shaped icon along with some nodes. These nodes represent Oracle Identity Manager entities that are redundant. Before you import the connector XML file, you must remove these entities by right-clicking each node and then selecting Remove.

  12. Click Import. The connector XML file is imported into Oracle Identity Manager.

2.2.2.3 Compiling Adapters

Note:

You must perform the procedure described in this section if you want to use the provisioning features of Oracle Identity Manager for this target system.

Adapters are used to implement provisioning functions. The following adapters are imported into Oracle Identity Manager when you import the connector XML file:

See Also:

Section 1.6.6, "Provisioning Functions" for a listing of the provisioning functions that are available with this connector
  • EDIR Create User

  • EDIR Delete User

  • EDIR Modify User

  • EDIR Move User

  • EDIR Add User to Group

  • EDIR Remove User from Group

  • EDIR Add Trustee Right to User

  • EDIR Remove Trustee Right from User

  • EDIR Add Assigned Role to User

  • EDIR Remove Assigned Role from User

  • EDIR Add Network Restriction

  • EDIR Remove Network Restriction

  • EDIR PP String

  • Update eDirectory Role Details

  • Update eDirectory Group Details

  • EDIR Delete Group

  • EDIR Create Group

  • EDIR Remove User from Group

  • Chk Process Parent Org eDir

  • EDIR Create OU

  • EDIR Remove User from Role

  • EDIR Create Role

  • EDIR Delete Role

  • EDIR Move OU

  • EDIR Change Org Name

  • EDIR Delete OU

  • EDIR Add MultiValAttr

  • EDIR Remove MultiValAttr

  • EDIR Update MultiValAttr

  • EDIR Create Home Directory

  • EDIR Modify Home Directory

You must compile these adapters before they can be used in provisioning operations.

To compile adapters by using the Adapter Manager form:

  1. Open the Adapter Manager form.

  2. To compile all the adapters that you import into the current database, select Compile All.

    To compile multiple (but not all) adapters, select the adapters you want to compile. Then, select Compile Selected.

    Note:

    Click Compile Previously Failed to recompile only those adapters that were not compiled successfully. Such adapters do not have an OK compilation status.
  3. Click Start. Oracle Identity Manager compiles the selected adapters.

  4. If Oracle Identity Manager is installed in a clustered environment, then copy the compiled adapters from the OIM_HOME/xellerate/Adapter directory to the same directory on each of the other nodes of the cluster. If required, overwrite the adapter files on the other nodes.

If you want to compile one adapter at a time, then use the Adapter Factory form.

See Also:

Oracle Identity Manager Tools Reference Guide for information about using the Adapter Factory and Adapter Manager forms

To view detailed information about an adapter:

  1. Highlight the adapter in the Adapter Manager form.

  2. Double-click the row header of the adapter, or right-click the adapter.

  3. Select Launch Adapter from the shortcut menu that is displayed. Details of the adapter are displayed.

2.3 Postinstallation

The following sections discuss postinstallation procedures:

2.3.1 Configuring Oracle Identity Manager 11.1.2 or Later

If you are using Oracle Identity Manager release 11.1.2 or later, you must create additional metadata such as a UI form and an application instance. In addition, you must run entitlement and catalog synchronization jobs. These procedures are described in the following sections:

2.3.1.1 Tagging Form Fields

You must add properties to certain form fields. To do so:

  1. Log in to Oracle Identity Manager Design Console.

  2. Open Novell eDirectory child form (UD_EDIR_ROL).

  3. Create a new form version.

  4. In the Properties tab, for the Role Name field, add Entitlement = true property.

  5. Click Make Version Active.

  6. Open Novell eDirectory child form (UD_EDIR_GRP).

  7. Create a new form version.

  8. In the Properties tab, for the Group Name field, add Entitlement = true property.

  9. Click Make Version Active.

  10. Open Novell eDirectory user form (UD_EDIR_USR).

  11. Create a new form version.

  12. In the Properties tab, add the following properties:

    For the Novell Server (ITResourceLookupField) field, add ITResource = true property.

    For the User ID field, add AccountName = true property.

    For the Guid field, add AccountId = true property.

  13. Click Make Version Active.

2.3.1.2 Creating and Activating a Sandbox

Create and activate a sandbox as follows. For detailed instructions, see the "Managing Sandboxes" section in the Oracle Fusion Middleware Administrator's Guide for Oracle Identity Manager.

  1. On the upper navigation bar, click Sandboxes. The Manage Sandboxes page is displayed.

  2. On the toolbar, click Create Sandbox. The Create Sandbox dialog box is displayed.

  3. In the Sandbox Name field, enter a name for the sandbox. This is a mandatory field.

  4. In the Sandbox Description field, enter a description of the sandbox. This is an optional field.

  5. Click Save and Close. A message is displayed with the sandbox name and creation label.

  6. Click OK. The sandbox is displayed in the Available Sandboxes section of the Manage Sandboxes page.

  7. Select the sandbox that you created.

  8. From the table showing the available sandboxes in the Manage Sandboxes page, select the newly created sandbox that you want to activate.

  9. On the toolbar, click Activate Sandbox.

    The sandbox is activated.

2.3.1.3 Creating a New UI Form

Create a new UI form as follows. For detailed instructions, see the "Managing Forms" chapter in the Oracle Fusion Middleware Administrator's Guide for Oracle Identity Manager.

  1. In the left pane, under Configuration, click Form Designer.

  2. Under Search Results, click Create.

  3. Select the resource type for which you want to create the form, for example, Novell eDirectory IT resource.

  4. Enter a form name and click Create.

2.3.1.4 Creating an Application Instance

Create an application instance as follows. For detailed instructions, see the "Managing Application Instances" chapter in the Oracle Fusion Middleware Administrator's Guide for Oracle Identity Manager.

  1. In the System Administration page, under Configuration in the left pane, click Application Instances.

  2. Under Search Results, click Create.

  3. Enter appropriate values for the fields displayed on the Attributes form and click Save.

  4. In the Form drop-down list, select the newly created form and click Apply.

  5. Publish the application instance for a particular organization.

2.3.1.5 Publishing a Sandbox

To publish the sandbox that you created in Section 2.3.1.2, "Creating and Activating a Sandbox":

  1. Close all the open tabs and pages.

  2. From the table showing the available sandboxes in the Manage Sandboxes page, select the sandbox that you created in Section 2.3.1.2, "Creating and Activating a Sandbox."

  3. On the toolbar, click Publish Sandbox. A message is displayed asking for confirmation.

  4. Click Yes to confirm. The sandbox is published and the customizations it contained are merged with the main line.

2.3.1.6 Harvesting Entitlements and Sync Catalog

To harvest entitlements and sync catalog:

  1. Run the scheduled jobs for lookup field synchronization listed in Section 3.2, "Lookup Field Synchronization."

  2. Run the Entitlement List scheduled job to populate Entitlement Assignment schema from child process form table. See the "Predefined Scheduled Tasks" section in the Oracle Fusion Middleware Administrator's Guide for Oracle Identity Manager for more information about this scheduled job.

  3. Run the Catalog Synchronization Job scheduled job. See the "Predefined Scheduled Tasks" section in the Oracle Fusion Middleware Administrator's Guide for Oracle Identity Manager for more information about this scheduled job.

2.3.1.7 Updating an Existing Application Instance with a New Form

For any changes you do in the Form Designer, you must create a new UI form and update the changes in an application instance. To update an existing application instance with a new form:

  1. Create a sandbox and activate it as described in Section 2.3.1.2, "Creating and Activating a Sandbox."

  2. Create a new UI form for the resource as described in Section 2.3.1.3, "Creating a New UI Form."

  3. Open the existing application instance.

  4. In the Form field, select the new UI form that you created.

  5. Save the application instance.

  6. Publish the sandbox as described in Section 2.3.1.5, "Publishing a Sandbox."

Note:

If you are using Oracle Identity Manager 11g Release 2 (11.1.2.0.4) or later, and if the eDirectory connector 9.x is configured on Remote Manger, then you must perform the steps mentioned in MetaLink note 1535369.1 to ensure provisioning operations work as expected.

2.3.2 Localizing Field Labels in UI Forms

Note:

Perform the procedure described in this section only if you are using Oracle Identity Manager release 11.1.2 or later and you want to localize UI form field labels.

To localize field label that you add to in UI forms:

  1. Log in to Oracle Enterprise Manager.

  2. In the left pane, expand Application Deployments and then select oracle.iam.console.identity.sysadmin.ear.

  3. In the right pane, from the Application Deployment list, select MDS Configuration.

  4. On the MDS Configuration page, click Export and save the archive to the local computer.

  5. Extract the contents of the archive, and open the following file in a text editor:

    SAVED_LOCATION\xliffBundles\oracle\iam\ui\runtime\BizEditorBundle.xlf

  6. Edit the BizEditorBundle.xlf file in the following manner:

    1. Search for the following text:

      <file source-language="en"  
      original="/xliffBundles/oracle/iam/ui/runtime/BizEditorBundle.xlf"
      datatype="x-oracle-adf">
      
    2. Replace with the following text:

      <file source-language="en" target-language="LANG_CODE"
      original="/xliffBundles/oracle/iam/ui/runtime/BizEditorBundle.xlf"
      datatype="x-oracle-adf">
      

      In this text, replace LANG_CODE with the code of the language that you want to localize the form field labels. The following is a sample value for localizing the form field labels in Japanese:

      <file source-language="en" target-language="ja"
      original="/xliffBundles/oracle/iam/ui/runtime/BizEditorBundle.xlf"
      datatype="x-oracle-adf">
      
    3. Search for the application instance code. This procedure shows a sample edit for Novell eDirectory application instance. The original code is:

      <trans-unit id="${adfBundle['oracle.adf.businesseditor.model.util.BaseRuntimeResourceBundle']['persdef.sessiondef.oracle.iam.ui.runtime.form.model.user.entity.userEO.UD_EDIR_USR_LOCATION__c_description']}">
      <source>Location</source>
      <target/>
      </trans-unit>
      <trans-unit id="sessiondef.oracle.iam.ui.runtime.form.model.EDIRFORM.entity.EDIREO.UD_EDIR_USR_LOCATION__c_LABEL">
      <source>Location</source>
      <target/>
      </trans-unit>
      
    4. Open the resource file from the connector package, for example eDirectory_ja.properties, and get the value of the attribute from the file, for example, global.udf.UD_EDIR_USR_LOCATION=\u5834\u6240.

    5. Replace the original code shown in Step 6.c with the following:

      <trans-unit id="${adfBundle['oracle.adf.businesseditor.model.util.BaseRuntimeResourceBundle']['persdef.sessiondef.oracle.iam.ui.runtime.form.model.user.entity.userEO.UD_EDIR_USR_LOCATION__c_description']}">
      <source>Location</source>
      <target>\u5834\u6240</target>
      </trans-unit>
      <trans-unit id="sessiondef.oracle.iam.ui.runtime.form.model.EDIR.entity.EDIREO.UD_EDIR_USR_LOCATION__c_LABEL">
      <source>Location</source>
      <target>\u5834\u6240</target>
      </trans-unit>
      
    6. Repeat Steps 6.a through 6.d for all attributes of the process form.

    7. Save the file as BizEditorBundle_LANG_CODE.xlf. In this file name, replace LANG_CODE with the code of the language to which you are localizing.

      Sample file name: BizEditorBundle_ja.xlf.

  7. Repackage the ZIP file and import it into MDS.

    See Also:

    The "Deploying and Undeploying Customizations" chapter in the Oracle Fusion Middleware Developer's Guide for Oracle Identity Manager, for more information about exporting and importing metadata files
  8. Log out of and log in to Oracle Identity Manager.

2.3.3 Copying Files to the Oracle Identity Manager Host Computer

You must manually copy the files listed in Table 2-3.

Note:

If a particular destination directory does not exist on the Oracle Identity Manager host computer, then create it.

Table 2-3 Files to Be Copied to the Oracle Identity Manager Host Computer

Files on the Installation Media Destination Directory on the Oracle Identity Manager Release 9.0.1 through Release 9.1.0.x Host Computer Destination Directory on the Oracle Identity Manager Release 11.1.x Host Computer

Files in the test/troubleshoot directory

OIM_HOME/xellerate/eDir/test/troubleshoot

OIM_HOME/server/eDir/test/troubleshoot

Files in the xml directory

OIM_HOME/xellerate/eDir/xml

OIM_HOME/server/ eDir/xml


2.3.4 Changing to the Required Input Locale

Note:

In an Oracle Identity Manager cluster, you must perform this step on each node of the cluster. Then, restart each node.

Changing to the required input locale (language and country setting) involves installing the required fonts and setting the required input locale.

You may require the assistance of the system administrator to change to the required input locale.

2.3.5 Clearing Content Related to Connector Resource Bundles from the Server Cache

Note:

In an Oracle Identity Manager cluster, you must perform this step on each node of the cluster. Then, restart each node.

When you deploy the connector, the resource bundles are copied from the resources directory on the installation media into the OIM_HOME/xellerate/connectorResources directory for Oracle Identity Manager release 9.0.1 through 9.0.3.2 and release 9.1.0.x, and Oracle Identity Manager database for Oracle Identity Manager release 11.1.x. Whenever you add a new resource bundle to the connectorResources directory or make a change in an existing resource bundle, you must clear content related to connector resource bundles from the server cache.

To clear content related to connector resource bundles from the server cache:

  1. In a command window, perform one of the following steps:

    • If you are using Oracle Identity Manager release 9.0.1 through 9.0.3.2 or release 9.1.0.x, then switch to the OIM_HOME/xellerate/bin directory.

    • If you are using Oracle Identity Manager release 11.1.x, then switch to the OIM_HOME/server/bin directory.

    Note:

    You must perform Step 1 before you perform Step 2. An exception is thrown if you run the command described in Step 2 as follows:

    For Oracle Identity Manager release 9.0.3.2 or release 9.1.0.x:

    OIM_HOME/xellerate/bin/SCRIPT_FILE_NAME
    

    For Oracle Identity Manager release 11.1.x:

    OIM_HOME/server/bin/SCRIPT_FILE_NAME
    
  2. Enter one of the following commands:

    Note:

    You can use the PurgeCache utility to purge the cache for any content category. Run PurgeCache.bat CATEGORY_NAME on Microsoft Windows or PurgeCache.sh CATEGORY_NAME on UNIX. The CATEGORY_NAME argument represents the name of the content category that must be purged.

    For example, the following commands purge Metadata entries from the server cache:

    PurgeCache.bat MetaData

    PurgeCache.sh MetaData

    • For Oracle Identity Manager release 9.0.1 through 9.0.3.2 or release 9.1.0.x:

      On Microsoft Windows: PurgeCache.bat ConnectorResourceBundle

      On UNIX: PurgeCache.sh ConnectorResourceBundle

      Note:

      You can ignore the exception that is thrown when you perform Step 2. This exception is different from the one mentioned in Step 1.

      In this command, ConnectorResourceBundle is one of the content categories that you can delete from the server cache. See the following file for information about the other content categories:

      OIM_HOME/xellerate/config/xlconfig.xml

    • For Oracle Identity Manager release 11.1.x:

      On Microsoft Windows: PurgeCache.bat All

      On UNIX: PurgeCache.sh All

      When prompted, enter the user name and password of an account belonging to the SYSTEM ADMINISTRATORS group. In addition, you are prompted to enter the service URL in the following format:

      t3://OIM_HOST_NAME:OIM_PORT_NUMBER
      

      In this format:

      • Replace OIM_HOST_NAME with the host name or IP address of the Oracle Identity Manager host computer.

      • Replace OIM_PORT_NUMBER with the port on which Oracle Identity Manager is listening.

    See Oracle Fusion Middleware System Administrator's Guide for Oracle Identity Manager for more information about the PurgeCache utility.

2.3.6 Enabling Logging

Depending on the Oracle Identity Manager release you are using, perform the procedure described in one of the following sections:

2.3.6.1 Enabling Logging on Oracle Identity Manager Release 9.0.1 through 9.0.3.2 or Release 9.1.0.x

When you enable logging, Oracle Identity Manager automatically stores in a log file information about events that occur during the course of provisioning and reconciliation operations. To specify the type of event for which you want logging to take place, you can set the log level to one of the following:

  • ALL

    This level enables logging for all events.

  • DEBUG

    This level enables logging of information about fine-grained events that are useful for debugging.

  • INFO

    This level enables logging of messages that highlight the progress of the application at a coarse-grained level.

  • WARN

    This level enables logging of information about potentially harmful situations.

  • ERROR

    This level enables logging of information about error events that might allow the application to continue running.

  • FATAL

    This level enables logging of information about very severe error events that could cause the application to stop functioning.

  • OFF

    This level disables logging for all events.

The file in which you set the log level and the log file path depend on the application server that you use:

  • IBM WebSphere Application Server

    To enable logging:

    1. Add the following lines in the OIM_HOME/xellerate/config/log.properties file:

      log4j.logger.XELLERATE=log_level
      log4j.logger.XL_INTG.EDIRECTORY=log_level
      
    2. In these lines, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.XELLERATE=INFO
      log4j.logger.XL_INTG.EDIRECTORY=INFO
      

    After you enable logging, log information is written to the following file:

    WEBSPHERE_HOME/AppServer/logs/SERVER_NAME/SystemOut.log

  • JBoss Application Server

    To enable logging:

    1. In the JBOSS_HOME/server/default/conf/log4j.xml file, locate or add the following lines if they are not already present in the file:

      <category name="XELLERATE">
         <priority value="log_level"/>
      </category>
      
      <category name="XL_INTG.EDIRECTORY">
         <priority value="log_level"/>
      </category>
      
    2. In the second XML code line of each set, replace log_level with the log level that you want to set. For example:

      <category name="XELLERATE">
         <priority value="INFO"/>
      </category>
      
      <category name="XL_INTG.EDIRECTORY">
         <priority value="INFO"/>
      </category>
      

    After you enable logging, log information is written to the following file:

    JBOSS_HOME/server/default/log/server.log

  • Oracle Application Server

    To enable logging:

    1. Add the following lines in the OIM_HOME/xellerate/config/log.properties file:

      log4j.logger.XELLERATE=log_level
      log4j.logger.XL_INTG.EDIRECTORY=log_level
      
    2. In these lines, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.XELLERATE=INFO
      log4j.logger.XL_INTG.EDIRECTORY=INFO
      

    After you enable logging, log information is written to the following file:

    ORACLE_HOME/opmn/logs/default_group~home~default_group~1.log

  • Oracle WebLogic Server

    To enable logging:

    1. Add the following lines in the OIM_HOME/xellerate/config/log.properties file:

      log4j.logger.XELLERATE=log_level
      log4j.logger.XL_INTG.EDIRECTORY=log_level
      
    2. In these lines, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.XELLERATE=INFO
      log4j.logger.XL_INTG.EDIRECTORY=INFO
      

    After you enable logging, log information is displayed on the server console.

2.3.6.2 Enabling Logging on Oracle Identity Manager Release 11.1.x

Note:

In an Oracle Identity Manager cluster, perform this procedure on each node of the cluster. Then, restart each node.

Oracle Identity Manager release 11.1.x uses Oracle Java Diagnostic Logging (OJDL) for logging. OJDL is based on java.util.logger. To specify the type of event for which you want logging to take place, you can set the log level to one of the following:

  • SEVERE.intValue()+100

    This level enables logging of information about fatal errors.

  • SEVERE

    This level enables logging of information about errors that might allow Oracle Identity Manager to continue running.

  • WARNING

    This level enables logging of information about potentially harmful situations.

  • INFO

    This level enables logging of messages that highlight the progress of the application.

  • CONFIG

    This level enables logging of information about fine-grained events that are useful for debugging.

  • FINE, FINER, FINEST

    These levels enable logging of information about fine-grained events, where FINEST logs information about all events.

These log levels are mapped to ODL message type and level combinations as shown in Table 2-4.

Table 2-4 Log Levels and ODL Message Type:Level Combinations

Log Level ODL Message Type:Level

SEVERE.intValue()+100

INCIDENT_ERROR:1

SEVERE

ERROR:1

WARNING

WARNING:1

INFO

NOTIFICATION:1

CONFIG

NOTIFICATION:16

FINE

TRACE:1

FINER

TRACE:16

FINEST

TRACE:32


The configuration file for OJDL is logging.xml, which is located at the following path:

DOMAIN_HOME/config/fmwconfig/servers/OIM_SERVER/logging.xml

Here, DOMAIN_HOME and OIM_SERVER are the domain name and server name specified during the installation of Oracle Identity Manager.

To enable logging in Oracle WebLogic Server:

  1. Edit the logging.xml file as follows:

    1. Add the following blocks in the file:

      <log_handler name='edir-handler' level='[LOG_LEVEL]' class='oracle.core.ojdl.logging.ODLHandlerFactory'>
      <property name='logreader:' value='off'/>
           <property name='path' value='[FILE_NAME]'/>
           <property name='format' value='ODL-Text'/>
           <property name='useThreadName' value='true'/>
           <property name='locale' value='en'/>
           <property name='maxFileSize' value='5242880'/>
           <property name='maxLogSize' value='52428800'/>
           <property name='encoding' value='UTF-8'/>
         </log_handler>
      
      <logger name="XL_INTG.EDIRECTORY" level="[LOG_LEVEL]" useParentHandlers="false">
           <handler name="edir-handler"/>
           <handler name="console-handler"/>
         </logger>
      
    2. Replace both occurrences of [LOG_LEVEL] with the ODL message type and level combination that you require. Table 2-4 lists the supported message type and level combinations.

      Similarly, replace [FILE_NAME] with the full path and name of the log file in which you want log messages to be recorded.

      The following blocks show sample values for [LOG_LEVEL] and [FILE_NAME]:

      <log_handler name='edir-handler' level='NOTIFICATION:1' class='oracle.core.ojdl.logging.ODLHandlerFactory'>
      <property name='logreader:' value='off'/>
           <property name='path' value='F:\MyMachine\middleware\user_projects\domains\base_domain1\servers\oim_server1\logs\oim_server1-diagnostic-1.log'/>
           <property name='format' value='ODL-Text'/>
           <property name='useThreadName' value='true'/>
           <property name='locale' value='en'/>
           <property name='maxFileSize' value='5242880'/>
           <property name='maxLogSize' value='52428800'/>
           <property name='encoding' value='UTF-8'/>
         </log_handler>
       
      <logger name="XL_INTG.EDIRECTORY" level="NOTIFICATION:1" useParentHandlers="false">
           <handler name="edir-handler"/>
           <handler name="console-handler"/>
         </logger>
      

    With these sample values, when you use Oracle Identity Manager, all messages generated for this connector that are of a log level equal to or higher than the NOTIFICATION:1 level are recorded in the specified file.

  2. Save and close the file.

  3. Set the following environment variable to redirect the server logs to a file:

    For Microsoft Windows:

    set WLS_REDIRECT_LOG=FILENAME
    

    For UNIX:

    export WLS_REDIRECT_LOG=FILENAME
    

    Replace FILENAME with the location and name of the file to which you want to redirect the output.

  4. Restart the application server.

2.3.7 Setting Up Lookup Definitions in Oracle Identity Manager

You must enter values in some of the lookup definitions that are created when you install the connector. To enter values in a lookup definition:

  1. Log in to the Design Console.

  2. Expand Administration, and double-click Lookup Definition.

  3. Search for and open the lookup definitions described in the following sections. After you enter values in each lookup definitions, save the changes.

2.3.7.1 Setting Up the Lookup.EDIR.Configuration Lookup Definition

You can specify values for the following entries in the Lookup.EDIR.Configuration lookup definition:

  • TimeStampFormat

    Enter the time-stamp format that must be used for connector operations.

    Default value: yyyyMMddHHmmss'Z'

  • Special Characters

    Enter the list of special characters that must not be modified in any way during connector operations. To add a special character to the default value, append the character to the default value without adding a space or any other delimiter.

    Default value: +=\<>%;#

  • PageSize

    Enter the page size that must be used during reconciliation. This entry enables the reconciliation of a specified set of target system records at a time, within a reconciliation run. Multiple pages of records are fetched to complete the reconciliation run.

    Note:

    Only Novell eDirectory 8.8 and later versions support paged reconciliation.

    Default value: 100

  • LDAPConnectTimeOut

    Enter the timeout interval (in milliseconds) after which the connector must start trying to establish a connection with the backup target system installations.

    Default value: 3000

2.3.7.2 Setting Up Other Lookup Definitions

The following are other lookup definitions in which you must manually create entries:

See Also:

Section 1.5.2, "Other Lookup Definitions" for the descriptions of these lookup definitions
  • Lookup.EDIR.NetworkRestriction

    Table 2-5 shows the default entries in the Lookup.EDIR.NetworkRestriction lookup definition.

    Note:

    If you want to add entries in this lookup definition, then ensure that the entries are in the format used for the default values.

    Table 2-5 Entries in the Lookup.EDIR.NetworkRestriction Lookup Definition

    Code Key Decode

    IP:123.124.35.36

    IP:123.124.35.36

    IPX:AAAAAAAA:BBBBBBBBBBBB:CCCC

    IPX:AAAAAAAA:BBBBBBBBBBBB:CCCC

    OSI:1234567890

    OSI:1234567890

    SDLC:2222:222222:2222222222

    SDLC:2222:222222:2222222222

    SDLC:3434:343434:3434343434

    SDLC:3434:343434:3434343434

    TCP:255.0.255.255

    TCP:255.0.255.255

    TCP:164.164.164.164

    TCP:164.164.164.164

    UDP:121.121.121.121

    UDP:121.121.121.121

    UDP:255.255.255.255

    UDP:255.255.255.255

    ETHERNET_TOKENRING:2222:333333:5555555555

    ETHERNET_TOKENRING:2222:333333:5555555555

    IP:300.34.35.26

    IP:300.34.35.26


  • Lookup.EDIR.CommLang

    Table 2-6 shows the default entries in the Lookup.EDIR.CommLang lookup definition.

    Note:

    If you want to add entries in this lookup definition, then ensure that the entries are in the format used for the default values.

    Table 2-6 Entries in the Lookup.EDIR.CommLang Lookup Definition

    Code Key Decode

    ENGLISH

    ENGLISH

    FRENCH

    FRENCH

    GERMAN

    GERMAN

    ITALIAN

    ITALIAN

    JAPANESE

    JAPANESE

    KOREAN

    KOREAN

    SPANISH

    SPANISH

    SIMPLIFIED CHINESE

    SIMPLIFIED CHINESE

    TRADITIONAL CHINESE

    TRADITIONAL CHINESE

    BRAZILIAN PORTUGUESE

    BRAZILIAN PORTUGUESE


  • Lookup.EDIR.TrusteeProperty

    Table 2-7 shows the default entries in the Lookup.EDIR.TrusteeProperty lookup definition.

    Note:

    If you want to add entries in this lookup definition, then ensure that the entries are in the format used for the default values.

    Table 2-7 Entries in the Lookup.EDIR.TrusteeProperty Lookup Definition

    Code Key Decode

    [All Attributes Rights]

    All Attributes Rights

    sn

    sn

    givenName

    givenName

    title

    title


2.3.8 Installing and Configuring the Remote Manager

To enable the creation of home directories for users on the target system, you must install a Remote Manager on a computer running Microsoft Windows in the domain. In addition, you must install Novell Console One Application on the same computer.

Note:

  • Perform the procedure described in this section only if you want to include the Home Directory field in provisioning operations.

  • The directory in which you install the Remote Manager is referred to as RM_HOME.

  • The directory in which you install the Novell Console One Application is referred to as NOVELL_CONSOLE_HOME.

  • See Novell documentation for information about installing Novell Console One Application.

Installing and configuring the Remote Manager involves performing the following procedures:

2.3.8.1 Installing the Remote Manager

Note:

You can install the Remote Manager only if you are using Oracle Identity Manager release 9.0.3.x, release 9.1.0.x, or release 11.1.x.

If you are using an Oracle Identity Manager release earlier than 9.0.3.x, then skip this section.

To install the Remote Manager:

  1. The Remote Manager installation files are shipped along with the Oracle Identity Manager installation files. You can install the Remote Manager on any computer that is a part of the domain.

    If you are using Oracle Identity Manager release 11.1.x, then see the Oracle Fusion Middleware System Administrator's Guide for Oracle Identity Manager guide for instructions on installing the Remote Manager.

    If you are using Oracle Identity Manager release 9.0.1 through 9.0.3.2 or release 9.1.0.x, then depending on the application server that you use, perform the procedure to install the Remote Manager by following the instructions given in one of the following guides:

    • Oracle Identity Manager Installation and Configuration Guide for Oracle WebLogic Server

    • Oracle Identity Manager Installation and Configuration Guide for IBM WebSphere Application Server

    • Oracle Identity Manager Installation and Configuration Guide for JBoss Application Server

    • Oracle Identity Manager Installation and Configuration Guide for Oracle Application Server

  2. If you are using Oracle Identity Manager release 9.0.1 through 9.0.3.2 or release 9.1.0.x, then copy the following JAR files into the RM_HOME\xlremote\JavaTasks directory:

    • OIM_HOME\xellerate\lib\xlVO.jar

    • OIM_HOME\xellerate\lib\xlScheduler.jar

    • OIM_HOME\xellerate\lib\xlAPI.jar

    • NOVELL_CONSOLE_HOME\ndk\nocell-njclc-devel-2008.02.29-1windows\lib\njclv2.jar (sample path)

    • INSTALL_MEDIA\lib\eDirRemote.jar

      Note:

      In this guide, the connector installation media is referred to as INSTALL_MEDIA.
    • INSTALL_MEDIA\lib\eDirRM.jar

    • INSTALL_MEDIA\lib\eDirProv.jar

  3. If you are using Oracle Identity Manager release 11.1.x, then copy the following JAR files into the RM_HOME\xlremote\JavaTasks directory:

    • OIM_HOME\server\lib\xlVO.jar

    • OIM_HOME\server\lib\xlScheduler.jar

    • OIM_HOME\server\lib\xlAPI.jar

    • OIM_HOME\server\lib\xlUtils.jar

    • OIM_HOME\server\lib\xlRemoteManager.jar

    • INSTALL_MEDIA\lib\ eDirRecon.jar

    • INSTALL_MEDIA\lib\ eDirProv.jar

  4. Copy the following file into the C:\WINDOWS\system32 directory:

    NOVELL_CONSOLE_HOME\consoleone\1.2\bin\jncpv2.dll

  5. Use the following script to start the Remote Manager:

    • For Oracle Identity Manager release 9.0.1 through 9.0.3.2 and release 9.1.0.x:

      RM_HOME\xlremote\remotemanager.bat

    • For Oracle Identity Manager release 11.1.x:

      RM_HOME\remote_manager\remotemanager.bat

  6. Note the Remote Manager service name and URL. These values are displayed in the Remote Manager command window. You will need these values while creating the IT resource for the Remote Manager. The default values are RManager and rmi://HOST_NAME:12346. For example, for a Remote Manager running on ten.mydomain.com, the default values will be RManager and rmi://ten.mydomain.com:12346.

2.3.8.2 Enabling Logging in the Remote Manager

To enable logging in the Remote Manager:

  1. Add the log4j.logger.XL_INTG.EDIRECTORY=LOG_LEVEL line in one of the following files:

    • For Oracle Identity Manager release 9.0.1 through 9.0.3.2 or release 9.1.0.x:

      RM_HOME\xlremote\config\log.properties

    • For Oracle Identity Manager release 11.1.x:

      OIM_HOME\remote_manager\config\log.properties

  2. In these lines, replace LOG_LEVEL with the log level that you want to set.

    For example:

    log4j.logger.XL_INTG.EDIRECTORY=INFO
    
  3. In the log.properties file, use the following parameter to specify the name and location of the file in which you want log information to be recorded:

    log4j.appender.logfile.File
    

2.3.8.3 Configuring the IT Resource for the Remote Manager

Table 2-8 describes the parameters of the IT resource for the Remote Manager. Enter values for these parameters.

See Also:

Section 2.2.1.2, "Configuring the IT Resource" for information about the procedure to set values for parameters of IT resources

Table 2-8 Parameters of the IT Resource for the Remote Manager

Parameter Description

service name

Enter a name for the Remote Manager.

Sample value: RManager

url

Enter the IP address of the target system host computer and the port number at which the Remote Manager is listening.

Sample value: rmi://10.0.0.1:12346


2.3.8.4 Configuring Oracle Identity Manager Release 9.0.1 through 9.0.3.2 or Release 9.1.0.x to Trust the Remote Manager

To configure Oracle Identity Manager to trust the Remote Manager:

  1. From the computer hosting the Remote Manager, copy the RM_HOME/xlremote/config/xlserver.cert file to a temporary directory on the Oracle Identity Manager host computer.

    Note:

    The server certificate in the OIM_HOME directory is also named xlserver.cert. Ensure that you do not overwrite that certificate.
  2. To import the certificate by using the keytool utility, run the following command:

    JAVA_HOME/jre/bin/keytool -import -alias ALIAS -file RM_CERT_LOCATION/xlserver.cert -keystore OIM_HOME/xellerate/config/.xlkeystore -storepass PASSWORD
    

    In the preceding command, replace:

    • JAVA_HOME with the location of the Java directory for your application server.

    • ALIAS with an alias for the certificate in the store.

    • RM_CERT_LOCATION with the full path of the temporary directory where you copied the certificate.

    • PASSWORD with the password of the keystore.

  3. Copy the OIM_HOME/xellerate/config/xlserver.cert file to a temporary directory on the Remote Manager host computer.

  4. To import the certificate by using the keytool utility on the Remote Manager host computer, run the following command:

    JAVA_HOME/jre/bin/keytool -import -alias ALIAS -file OIM_CERT_LOCATION/xlserver.cert -keystore RM_HOME/xlremote/config/.xlkeystore -storepass PASSWORD
    

    In the preceding command, replace:

    • JAVA_HOME with the location of the Java directory for your application server.

    • ALIAS with an alias for the certificate in the store.

    • OIM_CERT_LOCATION with the full path of the temporary directory where you copied the certificate.

    • PASSWORD with the password of the keystore.

      Note:

      It is recommended that you follow security best practices and change the default passwords used for the Remote Manager keystore. To change the Remote Manager keystore password, follow the instructions given in Oracle Identity Manager Installation and Configuration Guide for your application server.

2.3.8.5 Configuring Oracle Identity Manager Release 11.1.x to Trust the Remote Manager

To configure Oracle Identity Manager to trust the Remote Manager:

  1. On the computer hosting Oracle Identity Manager, export the certificate by running the following command:

    keytool -export -keystore KEYSTORE_FILE -storepass KEYSTORE_PASSWORD -alias ALIAS -file CERT_FILE_NAME
    

    In this command:

    • KEYSTORE_FILE is the complete path and name of the keystore.

    • KEYSTORE_PASSWORD is the password of the keystore.

    • ALIAS is the alias of the certificate to be exported.

    • CERT_FILE_NAME is the file name containing the exported certificate

    The following is a sample command:

    keytool -export -keystore D:\March11g\Middleware\user_projects\domains\MARCHWIN\config\fmwconfig\default-keystore.jks -storepass MyPa55word -alias xell -file oim.cer 
    
  2. Copy the exported certificate to any directory on the target system.

  3. To import the certificate, run the following command:

    keytool -import -keystore KEYSTORE_FILE -storepass KEYSTORE_PASSWORD -alias ALIAS -file CERT_FILE_NAME 
    

    In this command:

    • KEYSTORE_FILE is the complete path and name of the keystore.

    • KEYSTORE_PASSWORD is the password of the keystore.

    • ALIAS is the alias of the certificate to be imported.

    • CERT_FILE_NAME is the file name containing the imported certificate

    The following is a sample command:

    keytool -import -keystore C:\Oracle\Middleware1\Oracle_IDM1\remote_manager\config\default-keystore.jks -storepass MyPa55word -alias oimserver -file C:\Oracle\Middleware1\OIMCert\oim.cer 
    
  4. Copy the OIM_HOME\server\config\xlserver.cert file from the Remote Manager host computer to a temporary directory on the Oracle Identity Manager host computer.

  5. To import the certificate, run the following command:

    keytool -import -keystore KEYSTORE_FILE -storepass KEYSTORE_PASSWORD -alias ALIAS -file CERT_FILE_NAME
    

    In this command:

    • KEYSTORE_FILE is the complete path and name of the keystore.

    • KEYSTORE_PASSWORD is the password of the keystore.

    • ALIAS is the alias of the certificate to be imported.

    • CERT_FILE_NAME is the file name containing the imported certificate

    The following is a sample command

    keytool -import -keystore D:\March11g\Middleware\user_projects\domains\MARCHWIN\config\fmwconfig\default_keystore.jks -storepass Welcome1 -alias rmcert -file D:\March11g\Middleware\RMCert146\xlserver.cert
    

2.3.8.6 Verifying That the Remote Manager Is Running

To verify that the Remote Manager is running:

  1. Use one of the following scripts to start the Remote Manager:

    • For Oracle Identity Manager release 9.0.1 through 9.0.3.2 or release 9.1.0.x:

      RM_HOME\xlremote\remotemanager.bat

    • For Oracle Identity Manager release 11.1.x:

      OIM_HOME\remote_manager\remotemanager.bat

  2. Log in to the Design Console.

  3. Expand Administration, and double-click Remote Manager.

  4. Search for and open the Remote Manager that you have created.

  5. Click the Refresh icon. The screen displays details of the Remote Manager that you have configured. The Running check box should be selected for the Remote Manager. This implies that the status of the Remote Manager is active.

2.3.9 Configuring High Availability of the Target System

Suppose you have set up multiple, replicated installations of the target system for high availability. You can use the Lookup.EDIR.BackupServers lookup definition to ensure that if the primary target system installation becomes unavailable, then Oracle Identity Manager switches to one of the secondary target system installations. The Lookup.EDIR.BackupServers lookup definition is one of the lookup definitions created when you deploy the connector.

For a single primary installation, you can have any number of secondary installations. In addition, if you configure the connector to work with multiple primary installations, then you can specify secondary installations for each primary installation.

To use the Lookup.EDIR.BackupServers lookup definition, open it in the Design Console and enter Code Key and Decode values for each combination of primary and secondary target system installations.

Note:

In addition, set the timeout interval as the value of the LDAPConnectTimeOut entry of the Lookup.EDIR.Configuration lookup definition. See Section 2.3.7, "Setting Up Lookup Definitions in Oracle Identity Manager" for more information.

Table 2-9 shows samples entries for the Lookup.EDIR.BackupServers lookup definition.

Table 2-9 Samples Entries for the Lookup.EDIR.BackupServers Lookup Definition

Code Key Decode

172.20.55.64

172.20.55.65

172.20.55.64

172.20.55.66

172.20.55.97

172.20.55.98


In this table, the first two entries represent two secondary installations (172.20.55.65 and 172.20.55.66) for one primary installation (172.20.55.64). The third entry shows a one-to-one combination of primary (172.20.55.97) and secondary (172.20.55.98) installations.

2.3.10 Configuring Trusted Source Reconciliation

While configuring the connector, the target system can be designated as a trusted source or target resource. If you designate the target system as a trusted source, then during a reconciliation run:

  • For each newly created user on the target system, an OIM User is created.

  • Updates made to each user on the target system are propagated to the corresponding OIM User.

If you designate the target system as a target resource, then during a reconciliation run:

  • For each account created on the target system, a resource is assigned to the corresponding OIM User.

  • Updates made to each account on the target system are propagated to the corresponding resource.

Note:

Skip this section if you do not want to designate the target system as a trusted source for reconciliation.

Configuring trusted source reconciliation involves importing the XML file for trusted source reconciliation, eDirXLResourceObject.xml, by using the Deployment Manager.

Note:

Only one target system can be designated as a trusted source. If you import the eDirXLResourceObject.xml file while you have another trusted source configured, then both connector reconciliations would stop working.

To import the XML file for trusted source reconciliation:

  1. Open the Oracle Identity Manager Administrative and User Console.

  2. If you are using Oracle Identity Manager release 9.0.1 through 9.0.3.2 or release 9.1.0.x, then:

    1. Click the Deployment Management link on the left navigation bar.

    2. Click the Import link under Deployment Management. A dialog box for opening files is displayed.

  3. If you are using Oracle Identity Manager release 11.1.x, then:

    1. On the Welcome page, click Advanced in the upper-right corner of the page.

    2. On the Welcome to Oracle Identity Manager Advanced Administration page, in the System Management region, click Import Deployment Manager File. A dialog box for opening files is displayed.

  4. Locate and open the eDirXLResourceObject.xml file located in the following directory:

    • For Oracle Identity Manager release 9.0.1 through 9.0.3.2 or release 9.1.0.x:

      OIM_HOME/xellerate/ConnectorDefaultDirectory/eDirectory_9.0.4.14.0/xml

    • For Oracle Identity Manager release 11.1.x:

      OIM_HOME/server/ConnectorDefaultDirectory/eDirectory_9.0.4.14.0/xml

    Details of this XML file are shown on the File Preview page.

  5. Click Add File. The Substitutions page is displayed.

  6. Click Next. The Confirmation page is displayed.

  7. Click Import.

  8. In the message that is displayed, click Import to confirm that you want to import the XML file and then click OK.

2.3.11 Enabling Provisioning of Users in Organizations and Organizational Units

Note:

This section describes an optional procedure. You need not perform this procedure if you do not want to enable provisioning of users in organizations.

In the Lookup.EDIR.Configuration lookup definition, the following are default settings for enabling provisioning of users in organizational units:

  • ldapOrgDNPrefix=ou

  • ldapOrgUnitObjectClass=OrganizationalUnit

If you want to enable the provisioning of users in organizations, then change these settings as follows:

See Also:

Oracle Identity Manager Design Console Guide for detailed information about modifying lookup definitions
  • ldapOrgDNPrefix=o

  • ldapOrgUnitObjectClass=organization

2.3.12 Configuring Oracle Identity Manager for Request-Based Provisioning

Note:

Perform the procedure described in this section only if you are using Oracle Identity Manager release 11.1.1 and you want to configure request-based provisioning.

In request-based provisioning, an end user creates a request for a resource by using the Administrative and User Console. Administrators or other users can also create requests for a particular user. Requests for a particular resource on the resource can be viewed and approved by approvers designated in Oracle Identity Manager.

The following are features of request-based provisioning:

  • A user can be provisioned only one resource (account) on the target system.

    Note:

    Direct provisioning allows the provisioning of multiple target system accounts on the target system.
  • Direct provisioning cannot be used if you enable request-based provisioning.

To configure request-based provisioning, perform the following procedures:

2.3.12.1 Copying Predefined Request Datasets

A request dataset is an XML file that specifies the information to be submitted by the requester during a provisioning operation. Predefined request datasets are shipped with this connector. These request datasets specify information about the default set of attributes for which the requester must submit information during a request-based provisioning operation. The following is the predefined request dataset available in the DataSets directory on the installation media:

  • ProvisionResourceeDirectory User.xml

  • ModifyResourceeDirectory User.xml

Copy the files from the DataSets directory on the installation media to the OIM_HOME/DataSet/file directory.

Depending on your requirement, you can modify the file names of the request datasets. In addition, you can modify the information in the request datasets. See Oracle Fusion Middleware Developer's Guide for Oracle Identity Manager for information on modifying request datasets.

2.3.12.2 Importing Request Datasets into MDS

Note:

In an Oracle Identity Manager cluster, perform this procedure on each node of the cluster.

All request datasets must be imported into the metadata store (MDS), which can be done by using the Oracle Identity Manager MDS Import utility.

To import a request dataset definition into MDS:

  1. Ensure that you have set the environment for running the MDS Import utility. See Oracle Fusion Middleware Developer's Guide for Oracle Identity Manager for detailed information about setting up the environment for MDS utilities.

  2. In a command window, change to the OIM_HOME\server\bin directory.

  3. Run one of the following commands:

    • On Microsoft Windows

      weblogicImportMetadata.bat
      
    • On UNIX

      weblogicImportMetadata.sh
      
  4. When prompted, enter the following values:

    • Please enter your username [weblogic]

      Enter the username used to log in to the WebLogic server

      Sample value: WL_User

    • Please enter your password [weblogic]

      Enter the password used to log in to the WebLogic server.

    • Please enter your server URL [t3://localhost:7001]

      Enter the URL of the application server in the following format:

      t3://HOST_NAME_IP_ADDRESS:PORT

      In this format, replace:

      • HOST_NAME_IP_ADDRESS with the host name or IP address of the computer on which Oracle Identity Manager is installed.

      • PORT with the port on which Oracle Identity Manager is listening.

    The request dataset is imported into MDS.

2.3.12.3 Enabling the Auto Save Form Feature

To enable the Auto Save Form feature:

  1. Log in to the Design Console.

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

  3. Search for and open the eDirectory User PD process definition.

  4. Select the Auto Save Form check box.

  5. Click the Save icon.

2.3.12.4 Running the PurgeCache Utility

Run the PurgeCache utility to clear content belonging to the Metadata category from the server cache. See Section 2.3.5, "Clearing Content Related to Connector Resource Bundles from the Server Cache" for instructions.

The procedure to configure request-based provisioning ends with this step.

2.3.13 Configuring SSL

Note:

This is an optional step of the deployment procedure.

To enable SSL connectivity between Oracle Identity Manager and the target Novell eDirectory:

  1. Import the certificate from the target system into the JSDK (the JSDK that is used during installation of Oracle Identity Manager Server) cacerts keystore as follows:

    keytool -import -alias ALIAS_NAME -file CERTIFICATE_FILE_NAME_WITH_COMPLETE_PATH -keystore JAVA_HOME/jre/lib/security/cacerts
    
  2. Restart the Oracle Identity Manager server.

  3. In the eDirectory IT Resource IT resource definition:

    • Set the SSL parameter value to true.

    • Set the Port parameter value to the SSL port number. Typically, this number is 636.