Skip Headers
Oracle® Identity Manager Connector Guide for Novell eDirectory
Release 9.0.4

Part Number E10432-05
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
View PDF

2 Deploying the Connector

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

2.1 Verifying Deployment Requirements

The following table lists the deployment requirements for the connector.

Item Requirement
Oracle Identity Manager Oracle Identity Manager release 8.5.3.1 or later
Target systems Novell eDirectory 8.7.3
External code ldap.jar and ldapbp.jar

Refer to the "Using External Code Files" section for information about downloading this JAR file.

Target system user account Novell eDirectory user account to which the Supervisor right has been assigned

You provide the credentials of this user account while performing the procedure in the "Configuring the IT Resource" section.

If this target system user account is not assigned the specified rights, then the following error message may be displayed during connector operations:

Transaction is not active (Transaction Manager error)


2.2 Using External Code Files

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.

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 Novell 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 the file that you downloaded in Step 2.

  4. Copy the ldap.jar file from the novell-jldap-devel-2005.10.03-1netware_windows\jldap_2005.10.03\lib directory to the OIM_HOME/xellerate/ThirdParty directory on the Oracle Identity Manager server.

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 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 OIM_HOME/xellerate/ThirdParty directory.

Note:

In an Oracle Identity Manager cluster, copy this JAR file into the ThirdParty directory on each node of the cluster.

2.3 Installing the Connector on Oracle Identity Manager Release 9.1.0 or Later

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 or later involves the following procedures:

2.3.1 Running the Connector Installer

To run the Connector Installer:

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

    OIM_HOME/xellerate/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 Oracle Identity Manager Administrative and User Console.

  3. Click Deployment Management, and then click Install Connector.

  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:

    OIM_HOME/xellerate/ConnectorDefaultDirectory 
    

    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 files (by using 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 PurgeCache utility to load the server cache with content from the connector resource bundle in order to view the list of prerequisites. Refer to "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

      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 1-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 Table 1-1 for information about the files that you must copy and their destination locations on the Oracle Identity Manager server.

2.3.2 Configuring the IT Resource

Note:

Perform this procedure if you are installing the connector on Oracle Identity Manager release 9.1.0 or later.

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

  1. Log in to the Administrative and User Console.

  2. Expand Resource Management.

  3. Click Manage IT Resource.

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

  5. Click the edit icon for the IT resource.

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

  7. Specify values for the parameters of the IT resource. The following table describes each parameter:

    Parameter Description
    Admin ID DN value of the user who has administrator rights on the Novell eDirectory server

    Default value:

    cn=Admin,o=PXED-DEV
    
    Admin Password Password of the administrator
    Server Address Server address of the Novell eDirectory server
    Root DN Base DN on which all user operations are to be carried out

    Default value: o=PXED-DEV

    Port Port number to connect to the target Novell eDirectory server

    Default value: 389

    SSL Specifies whether or not SSL is used to secure communication between Oracle Identity Manager and Novell eDirectory

    The value can be true or false.

    Default value: false

    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, the time stamp value is not set. For subsequent rounds of reconciliation, the time at which the previous round of reconciliation was completed is stored in this parameter.
    Last Recon Trusted TimeStamp For the first trusted source reconciliation run, the time stamp value is not set. For subsequent rounds of reconciliation, the time at which the previous round of reconciliation was completed is stored in this parameter.
    Prov Attribute Lookup Code Name of the lookup definition that has the target attribute mappings required for provisioning

    Default value: AttrName.Prov.Map.EDIR

    Note: This value must not be changed.

    Recon Attribute Lookup Code Name of the lookup definition that has the target attribute mappings required for reconciliation

    Default value: AttrName.Recon.Map.EDIR

    Note: This value must not be changed.

    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

    CustomizedReconQuery Query condition on which reconciliation must be based

    If you specify a query condition for this parameter, then the target system records are searched based on the query condition.

    If you want to reconcile all the target system records, then do not specify a value for this parameter.

    The query can be composed with the AND (&) and OR (|) logical operators.

    Sample value: givenname=John

    For more information about this parameter, refer to the "Partial Reconciliation" section.


  8. To save the values, click Update.

2.4 Installing the Connector on Oracle Identity Manager Release 8.5.3.1 Through 9.0.3.x

Installing the connector on any Oracle Identity Manager release between releases 8.5.3.1 and 9.0.3.x involves the following procedures:

2.4.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:

"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/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.4.2 Importing the Connector XML File

Note:

Perform this procedure if you are installing the connector on Oracle Identity Manager release 8.5.3.1 through 9.0.3.

As mentioned in "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. The following table describes each parameter:

    Parameter Description
    Admin ID DN value of the user who has administrator rights on the Novell eDirectory server

    Default value:

    cn=Admin,o=PXED-DEV
    
    Admin Password Password of the administrator
    Server Address Server address of the Novell eDirectory server
    Root DN Base DN on which all user operations are to be carried out

    Default value: o=PXED-DEV

    Port Port number to connect to the target Novell eDirectory server

    Default value: 389

    SSL Specifies whether or not SSL is used to secure communication between Oracle Identity Manager and Novell eDirectory

    The value can be true or false.

    Default value: false

    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, the time stamp value is not set. For subsequent rounds of reconciliation, the time at which the previous round of reconciliation was completed is stored in this parameter.
    Last Recon Trusted TimeStamp For the first trusted source reconciliation run, the time stamp value is not set. For subsequent rounds of reconciliation, the time at which the previous round of reconciliation was completed is stored in this parameter.
    Prov Attribute Lookup Code Name of the lookup definition that has the target attribute mappings required for provisioning

    Default value: AttrName.Prov.Map.EDIR

    Note: This value must not be changed.

    Recon Attribute Lookup Code Name of the lookup definition that has the target attribute mappings required for reconciliation

    Default value: AttrName.Recon.Map.EDIR

    Note: This value must not be changed.

    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

    CustomizedReconQuery Query condition on which reconciliation must be based

    If you specify a query condition for this parameter, then the target system records are searched based on the query condition.

    If you want to reconcile all the target system records, then do not specify a value for this parameter.

    The query can be composed with the AND (&) and OR (|) logical operators.

    Sample value: givenname=John

    For more information about this parameter, refer to the "Partial Reconciliation" section.


  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 may 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.5 Configuring the Oracle Identity Manager Server

Configuring the Oracle Identity Manager server involves performing the following procedures:

Note:

In a clustered environment, you must perform this step on each node of the cluster.

2.5.1 Changing to the Required Input Locale

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.5.2 Clearing Content Related to Connector Resource Bundles from the Server Cache

While performing the instructions described in the "Using External Code Files" section, you copy files from the resources directory on the installation media into the OIM_HOME/xellerate/connectorResources directory. Whenever you add a new resource bundle in 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, change to the OIM_HOME/xellerate/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:
    OIM_HOME/xellerate/bin/batch_file_name
    
  2. Enter one of the following commands:

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

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

    OIM_HOME/xellerate/config/xlConfig.xml
    

2.5.3 Enabling Logging

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 may 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:

  • BEA 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.

  • 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:

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

2.5.4 Setting Up Lookup Definitions in Oracle Identity Manager

The following lookup definitions are created in Oracle Identity Manager when you deploy the connector:

  • Lookup.EDIR.NetworkRestriction

    During a provisioning operation, you use this lookup definition to specify the IP addresses of the workstations from which the user can log in. If you do not specify an IP address, then the user can log in from any workstation.

  • Lookup.EDIR.CommLang

    During a provisioning operation, you use this lookup definition to specify a language for the user.

You must enter values in these lookup definitions before you can use them during provisioning operations. 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 definition.

  4. Enter Code Key and Decode values for each of entry.

    You can enter any value. However, you must enter the same value in both the Code Key and Decode columns.

  5. Click Save.

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