Skip Headers
Oracle® Identity Manager Connector Guide for Microsoft Active Directory
Release 9.0.1

Part Number B31119-01
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

Deploying the connector involves the following steps:

Step 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 or later
Target systems Microsoft Active Directory Server (Microsoft Windows 2000 or 2003)
Target system host platforms The target system host platform can be any one of the following:
  • Microsoft Windows 2000 SP 4

  • Microsoft Windows 2003

Other systems Certificate services
External code JNDI LDAP Booster package (ldapsdk-4.1.jar)

Step 2: Configuring the Target System

You must ensure that the parent organization exists in the target server installation. The parent organization is specified as the Root Context parameter in the relevant IT resource.

Step 3: Copying the Connector Files and External Code

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

Note:

The directory paths given in the first column of this table correspond to the location of the connector files in the following ZIP file on the installation media:
Directory Servers\Microsoft Active Directory\Microsoft Active Directory Rev 4.4.0.zip

Refer to "Files and Directories That Comprise the Connector" for more information about these files.

File in the Installation Media Directory Destination Directory
The following files in the xml directory:
xliADOrganizationObject_DM.xml
xliADGroupObject_DM.xml
xliADUserObject_DM.xml
xliActiveDirectoryScheduleTask_DM.xml

xellerate_home\XLIntegrations\ActiveDirectory\xml
lib\xliActiveDirectory.jar
xellerate_home\xellerate\JavaTasks
lib\xliADRecon.jar
xellerate_home\xellerate\ScheduleTask
ext\ldapsdk-4.1.jar
xellerate_home\xellerate\XLIntegrations\ActiveDirectory\lib
The following files in the scripts directory:
install.bat
install.sh
xellerate_home\xellerate\scripts
The following contents of the test directory:
config\config.properties
lib\xliADTest.jar
logs
scripts\runADTest.bat
xellerate_home\xellerate\test
The following contents of the docs directory:
B31119_01.pdf
html
xellerate_home\xellerate\docs

Step 4: Importing the Connector XML Files

You must import the connector XML files in the following sequence:

  1. xliADOrganizationObject_DM.xml

  2. xliADGroupObject_DM.xml

  3. xliADUserObject_DM.xml

Caution:

If you do not import the connector files in the specified sequence, then the connector may not work.

To import the connector XML files 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 locating files is displayed.

  4. Locate and open the xliADOrganizationObject_DM.xml file, which is in the xellerate_home\xellerate\XLIntegrations\ActiveDirectory\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 AD Server IT resource is displayed.

  8. Specify values for the parameters of the AD Server IT resource. Depending on whether the operating system is Microsoft Windows 2000 or Microsoft Windows 2003, refer to the appropriate table in the "Defining IT Resources" section for information about the values to be specified.

  9. Click Next. The Provide IT Resource Instance Data page for a new instance of the AD 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 Tools Reference 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. You must remove these nodes. To do this, right-click each such node and then select Remove.

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

Defining IT Resources

This section provides IT resource parameter values for the following operating systems:

Microsoft Windows 2000

The following table provides values for the parameters of the AD Server IT resource, for Microsoft Windows 2000.

Parameter Name Parameter Description
Admin FQDN Fully qualified domain name corresponding to the admin user

Format: cn=ADMIN_LOGIN,cn=Users,dc=DOMAIN

Sample value: cn=administrator,cn=Users,dc=adomain

Admin Login User ID of the admin account that is used to create the OU/user

Sample value: administrator

Admin Password Password of the admin account that is used to create the OU/user

Sample value: password

Root Context Usually, this is the fully qualified domain name of the parent or root organization.

For example, the root suffix.

Value: ou=ORGANIZATION_NAME,dc=DOMAIN

Sample value: ou=Adapters, dc=adomain

Server Address Host name or the IP address of the target Microsoft Windows 2000 computer where the Microsoft Active Directory server is installed

Sample value: w2khost

Last Modified Time Stamp Date and time at which the last AD User reconciliation run was completed

The reconciliation engine automatically fills a value in this attribute each time it runs the AD User reconciliation.

Default value: 0

Last Modified Time Stamp Group Date and time at which the last AD Group reconciliation run was completed

The reconciliation engine automatically fills a value in this attribute each time it runs AD Group reconciliation.

Default value: 0

Use SSL Specifies whether or not to use SSL to secure communication between Oracle Identity Manager and Microsoft Active Directory

Default value: false

SSL Port Number Port at which SSL is running on the Microsoft Active Directory server

Default value: 636

AtMap ADUser Attribute map name for the Microsoft Active Directory user

Default value: AtMap.AD

AtMap Group Attribute map name for the Microsoft Active Directory group

Default value: AtMap.ADGroup


Microsoft Windows 2003

The following table provides values for the parameters of the AD Server IT resource, for Microsoft Windows 2003.

Parameter Name Parameter Description
Admin FQDN Fully qualified domain name corresponding to the admin user

Format: ADMIN_LOGIN@DOMAIN

Sample value: administrator@adomain.com

Admin Login User ID of the administrator account that is used to create the OU/user

Sample value: administrator

Admin Password Password of the administrator account that is used to create the OU/user

Sample value: password

Root Context Usually, this is the fully qualified domain name of the parent or root organization.

For example, the root suffix.

Format: ou=ORGANIZATION_NAME,dc=DOMAIN

Sample value: ou=Adapters,dc=adomain,dc=com

Server Address Host name or IP address of the target Microsoft Windows 2000 computer on which Microsoft Active Directory is installed

Sample value: w2003host

Last Modified Time Stamp Date and time at which the last AD User reconciliation run was completed

The reconciliation engine automatically fills a value in this attribute each time it runs the AD User reconciliation.

Default value: 0

Last Modified Time Stamp Group Date and time at which the last AD Group reconciliation run was completed

The reconciliation engine automatically fills a value in this attribute each time it runs AD Group reconciliation.

Default value: 0

Use SSL Specifies whether or not to use SSL to secure communication between Oracle Identity Manager and Microsoft Active Directory

Default value: false

SSL Port Number Port at which SSL is running on the Microsoft Active Directory server

Default value: 636

AtMap ADUser Attribute map name for the Microsoft Active Directory user

Default value: AtMap.AD

AtMap Group This is the attribute map name for the Microsoft Active Directory group.

Default value: AtMap.ADGroup


Step 5: Configuring Reconciliation

Configuring reconciliation involves performing the following tasks:

Adding Prerequisites for Reconciliation

Microsoft Active Directory reconciliation provides a mechanism for customizing the list of fields that are reconciled. Refer to Appendix A for information about this feature. To use this feature, you must perform the following prerequisite steps:

  1. Open Lookup.ADReconciliation.FieldMap from the Lookup Definition form in the Oracle Identity Manager Design Console.

  2. Add the required fields to the field map.

In addition, this connector also supports trusted source reconciliation. Before you implement trusted source reconciliation, you must perform the following prerequisite steps:

  1. Open the Resource Object form.

  2. Search for the Xellerate User.

  3. On the Object Reconciliation tab, add reconciliation fields as required. You must add all the reconciliation fields that are required to provide input for mandatory fields on the Xellerate User form. For example, fields like User Login and First Name. Although the Password field is a mandatory field, you can ignore it.

  4. Open the Process Definition form.

  5. Search for the Xellerate User.

  6. On the Reconciliation Field Mappings tab, add the reconciliation field mappings as required. All the mandatory fields of the User Defined process form must be mapped.

  7. Open the Reconciliation Rules form.

  8. Create a new rule for Object Xellerate User, with a rule element as required.

  9. After you create the rule, select the Active check box.

Creating Scheduled Tasks for Reconciliation

Configuring reconciliation involves creating scheduled tasks for lookup fields and user reconciliations. To create these scheduled tasks:

  1. Open the Oracle Identity Manager Design Console.

  2. Expand the Xellerate Administration folder.

  3. Select Task Scheduler.

  4. Click Find. The details of the predefined scheduled tasks are displayed on two different tabs.

  5. Enter a number in the Max Retries field. This number represents the number of times Oracle Identity Manager should attempt to complete the task before assigning the ERROR status to the task.

  6. Ensure that the Disabled and Stop Execution check boxes are cleared.

  7. In the Start region, double-click the Start Time field. From the date-time editor that is displayed, select the date and time at which you want the task to run.

  8. In the Interval region, set the following schedule parameters:

    • To set the task to run on a recurring basis, select the Daily, Weekly, Recurring Intervals, Monthly, or Yearly option.

      If you select the Recurring Intervals option, then you must also specify the time interval at which you want the task to run on a recurring basis.

    • To set the task to run only once, select the Once option.

  9. Provide values for the attributes of the scheduled task. Refer to the appropriate table in the "Specifying Values for the Scheduled Task Attributes"section for information about the values to be specified.

    See Also:

    Oracle Identity Manager Design Console Guide for information about adding and removing task attributes
  10. Click Save. The scheduled task is created. The INACTIVE status is displayed in the Status field, because the task is not currently running. The task is run at the date and time that you set in Step 7.

  11. Repeat Steps 5 through 10 to define the second scheduled task.

After you define both scheduled tasks, proceed to the "Step 6: Compiling Adapters" section.

Specifying Values for the Scheduled Task Attributes

This section provides information about the attribute values to be specified for the following scheduled tasks:

Lookup Fields Reconciliation Scheduled Task

You must specify values for the following attributes of the lookup fields reconciliation scheduled task.

Note:

Attribute values are predefined in the connector XML file that you import. Specify values only for those attributes that you want to change.
Attribute Name Description Default/Sample Value
Server IT resource instance name of the Microsoft Active Directory server AD Server
LookupCodeName Lookup code that contains all the reconciled group names and the corresponding object GUIDs Lookup.ADReconliation.GroupLookup

After you specify values for these scheduled task attributes, go to Step 10 of the procedure to create scheduled tasks.

User Reconciliation Scheduled Task

You must specify values for the following attributes of the user reconciliation scheduled task.

Note:

Attribute values are predefined in the connector XML file that you import. Specify values only for those attributes that you want to change.
Attribute Name Description Default/Sample Value
DeleteRecon Boolean field that specifies whether the reconciliation is an add, update, or delete reconciliation

The IT resource instance for the Delete reconciliation function must point to a root context where deleted users are stored on the Microsoft Active Directory server. A value must be specified for this attribute.

Yes
FieldLookupCode Lookup definition used for customized reconciliation

Refer to Appendix A for more information.

It is valid only when the UseFieldMapping attribute is set to true.

Lookup.ADReconciliation.FieldMap
MaintainHierarchy Specifies whether or not organization hierarchy must be maintained in Microsoft Active Directory

If this field is set to true, then the reconciliation scheduled task first creates an organization hierarchy similar to the organization hierarchy for Microsoft Active Directory in Oracle Identity Manager. It then performs reconciliation of users into the specific organization.

While using this option, you must ensure that duplicate organization names are not created. This is because Oracle Identity Manager does not allow duplicate organization names, even in separate organization trees.

A value must be specified for this attribute.

Yes
XellerateObject Name of the resource object in Oracle Identity Manager on which trusted reconciliation is to be performed

This value must be Xellerate User. If you do not want trusted reconciliation to be performed, then change the value to false.

A value must be specified for this attribute.

Xellerate User
Object Name of the AD User resource object in Oracle Identity Manager on which reconciliation is performed. For example, AD User. If AD User reconciliation need not be performed, then change the value to false.

A value must be specified for this attribute.

AD user
Server IT resource instance name of the Microsoft Active Directory server

A value must be specified for this attribute.

AD Server
TransformLookupCode Lookup code used for the transformation class map kept in the lookup tables

It is valid only when the UseTransformMapping attribute is set to true.

Refer to Appendix B for more information.

Lookup.ADReconciliation.TransformationMap
UseFieldMapping Specifies whether or not the field mappings from the FieldLookupCode attribute must be used

This is used for customized reconciliation. Refer to the "Step 5: Configuring Reconciliation" section for more information.

Yes
UseTransformMapping Specifies whether or not the transform mappings from the TransformLookupCode attribute must be used Yes
XellerateOrg Oracle Identity Manager organization in which reconciled users are to be stored

A value must be specified for this attribute.

Xellerate Users
MultiValueAttributes A comma-delimited list of all the multivalued Microsoft Active Directory attributes that must be reconciled

For AD User Group reconciliation, enter memberOf.

A value must be specified for this attribute.

memberOf
GroupObject Name of the AD Group resource object in Oracle Identity Manager on which reconciliation is being performed

If AD Group reconciliation need not be performed, then change the value to false.

A value must be specified for this attribute.

AD Group

After you specify values for these scheduled task attributes, go to Step 10 of the procedure to create scheduled tasks.

Step 6: Compiling Adapters

The following adapters are imported into Oracle Identity Manager when you import the connector XML file. You must compile these adapters before you can use them to provision accounts on the target system.

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 the Compile All option.

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

    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 adapters that you specify.

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.

Note:

To compile multiple adapters simultaneously, use the Adapter Manager form. To compile one adapter at a time, use the Adapter Factory form. Refer to Oracle Identity Manager Tools Reference Guide for information about how to use these forms.

Step 7: Configuring SSL

Note:

This is an optional step of the deployment procedure.

To configure SSL connectivity between Oracle Identity Manager and the target Microsoft Active Directory server, you must perform the following tasks:

  1. Installing Certificate Services

  2. Enabling LDAPS

  3. Setting Up the Microsoft Active Directory Certificate As a Trusted Certificate

Installing Certificate Services

The connector requires Certificate Services to be running on the host computer. To install Certificate Services:

  1. Click Start, and then click Control Panel.

  2. Double-click Add/Remove Programs.

  3. Click Add/Remove Windows Components.

  4. Select Certificate Services.

  5. Follow the instructions to start Certificate Services.

Enabling LDAPS

The target server must have LDAP over SSL (LDAPS) enabled. To enable LDAPS, generate a certificate as follows:

Note:

Use the Enterprise CA option when you perform the following steps.
  1. On the Active Directory Users and Computers console, right-click the domain node, and select Properties.

  2. Click the Group Policy tab.

  3. Select Default Domain Policy.

  4. Click Edit.

  5. Click Computer Configuration, Windows Settings, Security Settings, and Public Key Policies.

  6. Right-click Automatic Certificate Request Settings, and then select New and Automatic Certificate Request. A wizard is started.

  7. Use the wizard to add a policy with the Domain Controller template.

At the end of this procedure, the certificate is created and LDAP is enabled using SSL on port 636.

Setting Up the Microsoft Active Directory Certificate As a Trusted Certificate

If the Microsoft Active Directory certificate is not issued or certified by a certification authority (CA), then set it up as a trusted certificate.

To make the Microsoft Active Directory certificate a trusted certificate, you first export the certificate and then import it into the keystore of the Oracle Identity Manager server as a trusted CA certificate.

Exporting the Microsoft Active Directory Certificate

To export the Microsoft Active Directory certificate:

  1. Click Start, Programs, Administrative Tools, and Certification Authority.

  2. Right-click the Certification Authority that you create, and then select Properties.

  3. On the General tab, click View Certificate.

  4. On the Details tab, click Copy To File.

  5. Use the wizard to create a certificate (.cer) file using base-64 encoding.

Importing the Microsoft Active Directory Certificate

To import the Microsoft Active Directory certificate into the certificate store of the Oracle Identity Manager server:

  1. Copy the certificate to the Oracle Identity Manager server.

  2. Change to the directory where you copy the certificate file, and then enter a command similar to the following:

    keytool -import -alias alias  -file cer_file  -keystore my_cacerts -storepass password
    
    

    In this command:

    • alias is the alias for the certificate (for example, the server name)

    • cer_file is the full path and name of the certificate (.cer) file

    • my_cacerts is the full path and name of the certificate store (the default is cacerts)

      The path of the certificate store depends on the application server as shown in the following table.

      Application Server Certificate Store Location
      JBoss Application Server
      JAVA_HOME\jre\lib\security\cacerts
      
      BEA WebLogic
      BEA_HOME\java\jre\lib\security\cacerts
      
      IBM WebSphere
      WS_HOME\java\jre\lib\security\cacerts
      WS_HOME\etc\DummyServerTrustFile.jks
      

      Note:

      For IBM WebSphere, you must also copy the jnet.jar, jsee.jar, jcert.jar files to the WS_HOME\java\jre\lib\ext directory.
    • password is the keystore password (the default is changeit)

      For example:

      keytool -import -alias thorADCert -file c:\thor\ActiveDir.cer -keystore C:\mydir\java\jre\lib\security\cacerts -storepass changeit
      
      

      Note:

      changeit is the default password for the cacerts file stored in the Sun JVM. This may change depending on the JVM that you are using.
  3. In the command prompt window, when you are prompted to specify whether or not you want to trust this certificate, enter YES.

  4. To confirm whether or not the certificate has been imported successfully, enter a command similar to the following:

    keytool -list -alias alias -keystore mycacerts -storepass password
    
    

    In the example given in Step 2, to confirm that the certificate has been successfully imported, use the following command and look for the certificate name, thorADCert, that you provide while importing the certificate into the keystore:

    keytool -list -alias thorADCert -keystore C:\mydir\java\jre\lib\security\cacerts -storepass changeit
    
    
    
  5. Perform this step only if you are registering the certificate file in a new certificate store.

    Add the following line in the jre\lib\security\java.security file:

    security.provider.N=com.sun.net.ssl.internal.ssl.Provider
    
    

    In this line, N is a number that is not in use in the file.

  6. Restart the Oracle Identity Manager server and the application server.

    Note:

    The user password cannot be set unless 128-bit SSL is being used. In addition, the computer on which Microsoft Active Directory is installed must have Microsoft Windows 2000 Service Pack 2 or Microsoft Windows 2003 running on it.