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

Part Number B32355-02
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:

If you want to configure the connector for multiple installations of Microsoft Active Directory, then perform the following procedure:

If you are going to install and use the password synchronization module for Microsoft Active Directory, then perform the following procedure:

If you are using Oracle Identity Manager release 9.0.1.3, then perform the following procedure:

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 with Service Pack 4 or later

  • Microsoft Windows 2003

Other software Certificate Services
External code JNDI LDAP Booster package (ldapsdk-4.1.jar)
Target system user account Microsoft Windows 2000/2003 Server (Domain Controller) administrator

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


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 value of the Root Context parameter in the relevant IT resource. Refer to the "Defining IT Resources" section for more information about this parameter.

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 directory on the installation media:
Directory Servers\Microsoft Active Directory\Microsoft Active Directory Base

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

File in the Installation Media Directory Destination Directory
Files in the ext directory
OIM_home\xellerate\ThirdParty
lib\xliActiveDirectory.jar
OIM_home\xellerate\JavaTasks
OIM_home\xellerate\ScheduleTask
lib\xliADRecon.jar
OIM_home\xellerate\JavaTasks
OIM_home\xellerate\ScheduleTask
Files in the resources directory
OIM_home\xellerate\connectorResources
Files in the scripts directory
OIM_home\xellerate\scripts

After you copy the install.bat (or install.sh) file, use a text editor to open the file and specify the actual location of the JDK directory in the file.
Directories and files in the test directory
OIM_home\xellerate\test
Files in the xml directory
OIM_home\xellerate\XLIntegrations\ActiveDirectory\xml

Note:

While installing Oracle Identity Manager in a clustered environment, you copy the contents of the installation directory to each node of the cluster. Similarly, you must copy the connectorResources directory and the JAR files to the corresponding directories on each node of the cluster.

Step 4: Configuring the Oracle Identity Manager Server

Configuring the Oracle Identity Manager server involves the following procedures:

Note:

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

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.

To set the required input locale:

Note:

Depending on the operating system used, you may need to perform this procedure differently.
  1. Open Control Panel.

  2. Double-click Regional Options.

  3. On the Input Locales tab of the Regional Options dialog box, add the input locale that you want to use and then switch to the input locale.

Clearing Content Related to Connector Resource Bundles from the Server Cache

Whenever you add a new resource bundle in the OIM_home\xellerate\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.

  2. Enter one of the following commands:

    Note:

    You must perform Step 1 before you perform this step. If you run the command as follows, then an exception is thrown:
    OIM_home\xellerate\bin\batch_file_name
    
    • On Microsoft Windows:

      PurgeCache.bat ConnectorResourceBundle
      
      
    • On UNIX:

      PurgeCache.sh ConnectorResourceBundle
      
      

    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
    

Note:

You can ignore the exception that is thrown when you perform Step 2.

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 informational messages that highlight the progress of the application at 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 still 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:

  • For JBoss Application Server

    To enable logging:

    1. Add the following line in the OIM_home\xellerate\config\log.properties file:

      log4j.logger.XELLERATE=log_level
      
      
    2. In this line, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.XELLERATE=INFO
      
      

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

    JBoss_home\server\default\log\server.log
    
    
  • For IBM WebSphere:

    To enable logging:

    1. Add the following line in the OIM_home\xellerate\config\log.properties file:

      log4j.logger.XELLERATE=log_level
      
      
    2. In this line, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.XELLERATE=INFO
      
      

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

    WebSphere_home\AppServer\logs\server_name\startServer.log
    
    
  • For BEA WebLogic

    To enable logging:

    1. Add the following line in the OIM_home\xellerate\config\log.properties file:

      log4j.logger.XELLERATE=log_level
      
      
    2. In this line, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.XELLERATE=INFO
      
      

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

    WebLogic_home\user_projects\domains\domain_name\server_name\server_name.log
    
    
  • For OC4J

    To enable logging:

    1. Add the following line in the OIM_home\xellerate\config\log.properties file:

      log4j.logger.XELLERATE=log_level
      
      
    2. In this line, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.XELLERATE=INFO
      
      

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

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

Step 5: 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

  4. XliActiveDirectoryScheduleTask_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 OIM_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. Remove these nodes by right-clicking each node and then selecting Remove.

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

  13. Perform the same procedure to import the remaining connector XML files, in the specified order.

    Note:

    The IT resources that you must define are the same, regardless of the XML file that you import. Therefore, you only need to define the IT resources for the first XML file that you import.

After you import the connector XML file, proceed to the "Step 6: Configuring Reconciliation" section.

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 Description
Admin FQDN Fully qualified domain name corresponding to the administrator

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

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

Admin Login User ID of the administrator account that is used to create the OU/user
Admin Password Password of the administrator account that is used to create the OU/user
Root Context 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

Server Address Host name or IP address of the target Microsoft Windows 2000 computer on which Microsoft Active Directory 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

See Also: The Known Issues list in Chapter 4 for information about a limitation arising from setting this parameter to false.

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

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

Target Locale: Country Country code

Default value: US

Note: You must specify the value in uppercase.

Target Locale: Language Language code

Default value: en

Note: You must specify the value in lowercase.

CustomizedReconQuery Specify the LDAP query that you want to use to customize reconciliation. The reconciliation engine uses this LDAP query to filter the records that must be fetched from the target system.

Sample value: memberOf=cn=AcmeAdmin,cn=Users,dc=GLOBAL,dc=com

Note: You can use this value in conjunction with the GroupObject attribute defined in the "User Reconciliation Scheduled Task" section.

ADDisableAttr Lookup Definition Specify the name of the lookup table that lists the nonmandatory user attributes defined in Microsoft Active Directory. This attribute is used in conjunction with the Use Disable Attr parameter.

Note: Nonmandatory attributes of Microsoft Active Directory can accept NULL values during provisioning. You must manually create the lookup definition containing the nonmandatory attributes of Microsoft Active Directory. For each attribute that you add to this lookup definition, you must ensure that both the code key and decode key values are set to the name of the attribute.

Refer to Oracle Identity Manager Design Console Guide for information about creating the lookup definition.

Use Disable Attr Specifies whether or not nonmandatory attributes defined in Microsoft Active Directory must be set to NULL when a user is disabled through a provisioning operation. The value of this parameter can be True or False. The default value is False.

Note: You can use this parameter only if you specify a value for the ADDisableAttr Lookup Definition parameter.

AD Sync installed (yes/no) If you are going to install and use the Microsoft Active Directory Password Synchronization module, then specify yes as the value of this parameter. Otherwise, specify no. The default value is no.
OIM User UDF Specify the name of the user-defined field that you create in Oracle Identity Manager.

You must specify a value for this parameter only if you specify yes as the value of the AD Sync installed (yes/no) parameter.

Note: You must specify the column name and not the field label that you enter while adding the custom attribute in Oracle Identity Manager. For example, if you enter the label PWDCHANGEDINDICATION, then the column name that you must specify is USR_UDF_PWDCHANGEDINDICATION. Oracle Identity Manager adds the USR_UDF_ prefix while creating a column.

Custom Attribute Name Specify the name of the custom attribute that you create in Microsoft Active Directory.

You must specify a value for this parameter only if you specify yes as the value of the AD Sync installed (yes/no) parameter.


After you specify values for these IT resource parameters, proceed to Step 9 of the procedure to import connector XML files.

Microsoft Windows 2003

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

Parameter Description
Admin FQDN Fully qualified domain name corresponding to the administrator

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
Admin Password Password of the administrator account that is used to create the OU/user
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

See Also: The Known Issues list in Chapter 4 for information about a limitation arising from setting this parameter to false.

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

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

Country Country code

Default value: US

Note: You must specify the value in uppercase.

Language Language code

Default value: en

Note: You must specify the value in lowercase.

CustomizedReconQuery Specify the LDAP query that you want to use to customize reconciliation. The reconciliation engine uses this LDAP query to filter the records that must be fetched from the target system.

Sample value: memberOf=cn=AcmeAdmin,cn=Users,dc=GLOBAL,dc=com

Note: You can use this value in conjunction with the GroupObject attribute defined in the "User Reconciliation Scheduled Task" section.

ADDisableAttr Lookup Definition Specify the name of the lookup table that lists the nonmandatory user attributes defined in Microsoft Active Directory. This attribute is used in conjunction with the Use Disable Attr parameter.

Note: Nonmandatory attributes of Microsoft Active Directory can accept NULL values during provisioning. You must manually create the lookup definition containing the nonmandatory attributes of Microsoft Active Directory. For each attribute that you add to this lookup definition, you must ensure that both the code key and decode key values are set to the name of the attribute.

Refer to Oracle Identity Manager Design Console Guide for information about creating the lookup definition.

Use Disable Attr Specifies whether or not nonmandatory attributes defined in Microsoft Active Directory must be set to NULL when a user is disabled through a provisioning operation. The value of this parameter can be True or False.

Note: You can use this parameter only if you specify a value for the ADDisableAttr Lookup Definition parameter.

AD Sync installed (yes/no) If you are going to install and use the Microsoft Active Directory Password Synchronization module, then specify yes as the value of this parameter. Otherwise, specify no. The default value is no.
OIM User UDF Specify the name of the user-defined field that you create in Oracle Identity Manager.

You must specify a value for this parameter only if you specify yes as the value of the AD Sync installed (yes/no) parameter.

Note: You must specify the column name and not the field label that you enter while adding the custom attribute in Oracle Identity Manager. For example, if you enter the label PWDCHANGEDINDICATION, then the column name that you must specify is USR_UDF_PWDCHANGEDINDICATION. Oracle Identity Manager adds the USR_UDF_ prefix while creating a column.

Custom Attribute Name Specify the name of the custom attribute that you create in Microsoft Active Directory.

You must specify a value for this parameter only if you specify yes as the value of the AD Sync installed (yes/no) parameter.


After you specify values for these IT resource parameters, proceed to Step 9 of the procedure to import connector XML files.

Step 6: Configuring Reconciliation

The scheduled tasks for reconciliation are created when you import the XliActiveDirectoryScheduleTask_DM.xml file as part of the procedure described in the "Step 5: Importing the Connector XML Files" section.

Additional tasks that you need to perform to configure reconciliation are described in the following sections:

If you are using Oracle Identity Manager release 9.0.1, then you must perform the following procedure to enable reconciliation:

Specifying the Fields to Be Reconciled

You can select the fields that must be reconciled. To do this:

  1. Open the Oracle Identity Manager Design Console.

  2. Expand the Xellerate Administration folder.

  3. Double-click Lookup Definition.

  4. Search for the Lookup.ADReconciliation.FieldMap lookup definition by entering the name in the Code field and then clicking the Query icon.

  5. To open the Lookup.ADReconciliation.FieldMap field map, double-click Lookup.ADReconciliation.FieldMap.

  6. Add the required fields to the Lookup.ADReconciliation.FieldMap field map.

    The following fields are provided by default in the Lookup.ADReconciliation.FieldMap field map:

    • memberOf

    • instanceType

    • Organization

    • givenName

    • sAMAccountName

    • IT Resource

    • objectGUID

    • name

    • password

      Note:

      The connector does not reconcile and store passwords in Oracle Identity Manager. Refer to Chapter 4, "Known Issues" for an explanation of this functionality of the connector.
    • sn

    • cn

    • whenChanged

    • distinguishedName

    • initials

    • displayName

    Note:

    The whenChanged field is a mandatory field, which means that it must be present in the field map.

Configuring Trusted Source Reconciliation

Note:

Perform this step of the procedure only if you want to configure trusted source reconciliation. Only one connector can be configured for trusted source reconciliation. If you configure trusted source reconciliation for this connector while you have another trusted source configured, then both connector reconciliations would stop working.

Refer to Oracle Identity Manager Connector Framework Guide for conceptual information about reconciliation configurations.

Use the Oracle Identity Manager Design Console to configure trusted source reconciliation as follows:

  1. In the Resource Objects form, select the fields that you want to reconcile as follows:

    1. Expand the Resource Management folder.

    2. Double-click Resource Objects.

    3. Enter Xellerate User in the Name field and then click the Query icon.

    4. Double-click Xellerate User in the list that is displayed.

    5. 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 such as User Login and First Name. However, you need not specify a value in the Password field, although it is a mandatory field.

  2. In the Process Definition form, create reconciliation field mappings as follows:

    1. Expand the Process Management folder.

    2. Double-click Process Definition.

    3. Enter Xellerate User in the Name field and then click the Query icon.

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

  3. In the Reconciliation Rules form, create a rule for the Xellerate User object as follows:

    1. Expand the Development Tools folder.

    2. Double-click Reconciliation Rules.

    3. Create a rule for the Xellerate User object, with a rule element as required.

      See:

      Oracle Identity Manager Design Console Guide for instructions
    4. Select the Active check box to enable the rule.

Creating Scheduled Tasks for Reconciliation

To create the reconciliation 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. For the first scheduled task, enter a number in the Max Retries field. This number represents the number of times Oracle Identity Manager must attempt to complete the task before assigning the ERROR status to the task.

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

  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 "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 "Enabling Reconciliation in Oracle Identity Manager Release 9.0.1" 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 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, proceed 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. Refer to Appendix B for more information about these attributes.
Attribute Description Default/Sample Value
DeleteRecon Specifies whether or not Delete reconciliation is enabled

The value can be True or False. You must specify a value for this attribute.

True
UseFieldMapping Specifies whether or not field mappings from the FieldLookupCode attribute must be used

This attribute is used to enable the reconciliation of specific fields. The value can be True or False.

True
FieldLookupCode Name of the lookup definition that is used for custom reconciliation

This attribute 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

The value can be True or False. You must specify a value for this attribute.

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

If you want trusted reconciliation to be performed, then change the value to Xellerate User. Otherwise, change the value to False.

You must specify a value for this attribute.

Xellerate User
Object Name of the AD User resource object in Oracle Identity Manager on which reconciliation is performed

If you want AD User reconciliation to be performed, then change the value to AD User. Otherwise, change the value to False.

You must specify a value for this attribute.

AD User
Server Name of the IT resource representing the Microsoft Active Directory server

You must specify a value for this attribute.

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

This attribute is valid only when the UseTransformMapping attribute is set to True.

Lookup.ADReconciliation.TransformationMap
UseTransformMapping Specifies whether or not transform mappings accessed by using the TransformLookupCode attribute must be used

The value can be True or False.

True
XellerateOrg Oracle Identity Manager organization in which reconciled users are to be created

You must specify a value for this attribute.

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

For AD Group reconciliation, enter memberOf.

You must specify a value for this attribute.

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

If you want AD Group reconciliation to be performed, then change the value to AD Group. Otherwise, change the value to False.

You must specify a value for this attribute.

AD Group

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

Enabling Reconciliation in Oracle Identity Manager Release 9.0.1

If you are using Oracle Identity Manager release 9.0.1, then you must perform the following procedure to enable reconciliation:

See Also:

Oracle Identity Manager Design Console Guide
  1. Open the Design Console.

  2. Expand the Process Management folder.

  3. Open the Process Definition form for the AD User.

  4. Click the Reconciliation Field Mappings tab.

  5. For each field that is of the IT resource type:

    1. Double-click the field to open the Edit Reconciliation Field Mapping window for that field.

    2. Deselect Key Field for Reconciliation Matching.

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

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 one adapter at a time, use the Adapter Factory form. Refer to Oracle Identity Manager Tools Reference Guide for information about using the Adapter Factory and Adapter Manager forms.

Step 8: Configuring SSL

Note:

This is an optional step of the deployment procedure.

This section covers the procedure to enable SSL on Microsoft Active Directory.

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. Insert the operating system installation media into the CD-ROM or DVD drive.

  2. Click Start, Settings, and Control Panel.

  3. Double-click Add/Remove Programs.

  4. Click Add/Remove Windows Components.

  5. Select Certificate Services.

  6. Follow the instructions to start Certificate Services.

Enabling LDAPS

The target Microsoft Active Directory 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 do this, 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:

Note:

In a clustered environment, you must perform this procedure on all the nodes of the cluster.
  1. Copy the certificate to the Oracle Identity Manager server.

    If you use IBM WebSphere, then you must also copy the following files:

    • For a nonclustered configuration of IBM WebSphere:

      Copy the jsse.jar file into the WS_home\java\jre\lib\ext directory.

    • For a clustered configuration of IBM WebSphere:

      Copy the jnet.jar, jsse.jar, and jcert.jar files into the WS_home\java\jre\lib\ext directory.

    You can download these JAR files from the Sun Web site at

    http://java.sun.com/

  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
      JBoss_home\jre\lib\security\cacerts
      
      BEA WebLogic
      BEA_home\java\jre\lib\security\cacerts
      
      IBM WebSphere For a nonclustered configuration of IBM WebSphere, you must import the files into the following certificate stores:
      WS_home\java\jre\lib\security\cacerts
      
      

      For a clustered configuration of IBM WebSphere, you must import the files into the following certificate stores on each node of the cluster:

      WS_home\java\jre\lib\security\cacerts
      WS_home\etc\DummyServerTrustFile.jks
      
      
      Oracle Containers for J2EE (OC4J)
      OC4J_home\jdk\jre\lib\security\cacerts
      

    • 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 any number that is not used in the file.

  6. Restart the application server.

    Note:

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

Configuring the Connector for Multiple Installations of the Target System

Note:

Perform this procedure only if you want to configure the connector for multiple installations of Microsoft Active Directory. Refer to Oracle Identity Manager Design Console Guide for detailed instructions on performing each step of this procedure.

To configure the connector for multiple installations of the target system:

  1. Create and configure one IT resource for each target system installation.

    The IT Resources form is in the Resource Management folder. An IT resource is created when you import the connector XML file. You can use this IT resource as the template for creating the remaining IT resources, of the same resource type.

  2. Configure reconciliation for each target system installation. Refer to the "Step 6: Configuring Reconciliation" section for instructions. Note that you only need to modify the attributes that are used to specify the IT resource and to specify whether or not the target system installation is to be set up as a trusted source.

    You can designate either a single or multiple installations of Microsoft Active Directory as trusted sources.

  3. If required, modify the fields to be reconciled for the Xellerate User resource object.

When you use the Administrative and User Console to perform provisioning, you can specify the IT resource corresponding to the Microsoft Active Directory installation to which you want to provision the user.

Configuring the Connector and Password Synchronization Module

The connector for Microsoft Active Directory performs the following functions:

The password synchronization module for Microsoft Active Directory updates Oracle Identity Manager with passwords changed in Microsoft Active Directory.

The connector is deployed on the Oracle Identity Manager server, and the module is deployed on the Microsoft Active Directory server. When they are deployed together (along with LDAP over SSL), the connector and the password synchronization module provide full, bidirectional synchronization of all user attributes, including passwords.

See Also:

Oracle Identity Manager Password Synchronization Module for Microsoft Active Directory Installation and Configuration Guide

The instructions in this section are aimed at solving a problem that was observed in the release 9.0.3 of the connector and password synchronization module.

Creating a Custom Attribute in Microsoft Active Directory

You must create a custom attribute in Microsoft Active Directory to act as a flag for tracking password changes initiated by Oracle Identity Manager.

The following sections describe this procedure:

Ensuring That the Microsoft Active Directory Schema Snap-In Is Installed

The Microsoft Active Directory Schema snap-in is required to create a custom attribute. Before you can create the custom attribute, you must ensure that this snap-in is installed.

To check if the snap-in is installed:

  1. On the Microsoft Active Directory server, click Start and then click Run.

  2. Enter the following command, and then click OK:

    mmc /a
    
    

If the Microsoft Active Directory Schema snap-in is already installed, then its console is displayed when you run this command.

If the console is not displayed, then you must install the Microsoft Active Directory Schema snap-in as follows:

  1. Log in to the Microsoft Active Directory server as the administrator.

  2. Insert the Windows 2000 Server compact disc into your compact disc drive, and then click Browse this CD.

  3. Double-click the I386 folder, double-click Adminpak, and then follow the instructions displayed in the Windows 2000 Administration Tools Setup Wizard.

  4. Open the Microsoft Active Directory Schema snap-in console as follows:

    1. Click Start, and then click Run.

    2. Enter the following command, and then click OK:

      mmc /a
      
      
  5. On the Console menu, click Add/Remove Snap-in and then click Add.

  6. Double-click Active Directory Schema, and then click Close.

  7. To specify that you do not want to add any more snap-ins, click OK.

  8. To save the changes that you make, click Save.

Creating a Custom Attribute

After you ensure that the Microsoft Active Directory Schema snap-in is installed, add the custom attribute in Microsoft Active Directory as follows:

  1. Open the Active Directory Schema snap-in as follows:

    1. On the Microsoft Active Directory server, click Start and then click Run.

    2. Enter the following command, and then click OK:

      mmc /a
      
      
  2. In the console tree, right-click Attributes and then select Create Attribute.

  3. Set the attribute type to Integer.

  4. In the console tree, select Classes.

  5. Right-click User, and then select Properties.

  6. On the Attribute tab, select Add to add the attribute to the "User" class.

Creating a Custom Attribute in Oracle Identity Manager

You must create a custom attribute in Oracle Identity Manager to act as a flag for tracking password changes initiated by Microsoft Active Directory.

To create a custom attribute (user-defined field) in Oracle Identity Manager:

See Also:

Oracle Identity Manager Design Console Guide
  1. Open the Design Console.

  2. Expand the Administration folder.

  3. Select User Defined Field Definition.

  4. Click the Search icon.

  5. Select USR from the results that are displayed, and then click Add.

  6. In the User Defined Fields dialog box, enter the following values:

    • Label: Enter a label for the field. For example: PWDCHANGEDINDICATION

    • Field Size: 20

      The user-defined field that you create will hold either ADSYNC_TRUE or ADSYNC_FALSE.

    • DataType: String

    • Column Name: Enter a column name for the field.

      It is recommended that you enter the same value as that you enter in the Label field. For example: PWDCHANGEDINDICATION

      Oracle Identity Manager automatically appends USR_UDF_ to the column name that you specify. So, for example, if you specify PWDCHANGEDINDICATION as the column name, then the actual column name is changed to USR_UDF_PWDCHANGEDINDICATION.

  7. Click Save.

Specifying Values for IT Resource Parameters

While performing the procedure described in the "Defining IT Resources" section, you must specify values for the following parameters:

  • AD Sync installed (yes/no)

    If you are going to install and use the Microsoft Active Directory Password Synchronization module, then specify yes as the value of this parameter. Otherwise, specify no. The default value is no.

  • OIM User UDF

    Specify the name of the user-defined field that you create in Oracle Identity Manager.

    You must specify a value for this parameter only if you specify yes as the value of the AD Sync installed (yes/no) parameter.

    Note: You must specify the column name and not the field label that you enter while adding the custom attribute in Oracle Identity Manager. For example, if you enter the label PWDCHANGEDINDICATION, then the column name that you must specify is USR_UDF_PWDCHANGEDINDICATION. Oracle Identity Manager adds the USR_UDF_ prefix while creating a column.

  • Custom Attribute Name

    Specify the name of the custom attribute that you create in Microsoft Active Directory.

    You must specify a value for this parameter only if you specify yes as the value of the AD Sync installed (yes/no) parameter.

Sequence of Events That Occur During a Password Change

This section describes the sequence of events that take place during a password change operation.

Suppose user John Doe changes his password in Microsoft Active Directory. This events initiates the following sequence of events:

  1. The password synchronization module changes the user's password in Oracle Identity Manager.

  2. The password synchronization module changes the value of the Oracle Identity Manager user-defined field to ADSYNC_TRUE.

  3. Because the value of the Oracle Identity Manager user-defined field is ADSYNC_TRUE, the Password Updated process task does not change the password in Microsoft Active Directory.

  4. The password synchronization module changes the value of the Oracle Identity Manager user-defined field back to ADSYNC_FALSE.

Suppose user Jane Doe changes her password in Oracle Identity Manager. This event initiates the following sequence of events:

  1. The Password Updated process task changes the user's password in Microsoft Active Directory.

  2. The Password Updated process task changes the value of the Microsoft Active Directory custom attribute to 1.

  3. Because the value of the Microsoft Active Directory custom attribute is 1, the password synchronization module does not change the password in Oracle Identity Manager.

  4. The Password Updated process task changes the value of the Microsoft Active Directory custom attribute back to 0.

Configuring the xlconfig.xml File for the Password Synchronization Module

After you install the Microsoft Active Directory connector, you must make changes in the xlconfig.xml of the password synchronization to reflect the properties of the connector.

This is part of the installation procedure for the password synchronization module. It is described in the "Configuring the xlconfig.xml File After Installing the Connector" of Oracle Identity Manager Password Synchronization Module for Microsoft Active Directory Installation and Configuration Guide.

Configuring the Connector for Oracle Identity Manager Release 9.0.1.3

Note:

You must perform this procedure only if you are using Oracle Identity Manager release 9.0.1.3.

In Oracle Identity Manager release 9.0.1.3, user accounts that are disabled or enabled are not reconciled correctly into Oracle Identity Manager during nontrusted (target resource) reconciliation. If you are using this release of Oracle Identity Manager, then you must perform the following procedure to resolve this problem:

  1. Log in to the Design Console.

  2. Create the userAccountControl reconciliation field in the AD User resource object as follows:

    1. Expand the Resource Management folder.

    2. Open the Resource Objects form.

    3. Click the Search button.

    4. From the list of resource objects that is displayed, double-click AD User.

    5. On the Object Reconciliation tab, select the Reconciliation Fields tab.

    6. On the Reconciliation Fields tab, click Add Field and then enter the following values:

      • Field Name: Enter userAccountControl.

      • Field Type: Select String.

      • Required: Select this check box.

    7. Save the changes.

  3. Map the userAccountControl reconciliation field to the OIM_OBJECT_STATUS field as follows:

    1. Expand the Process Management folder.

    2. Open the Process Definition form.

    3. Click the Search button.

    4. From the list of process definitions that is displayed, double-click the AD User process definition.

    5. On the Reconciliation Field Mappings tab, double-click userAccountControl and then enter the following values:

      • Field Name: Select userAccountControl.

      • Field Type: Select String.

      • Process Data Field: Enter OIM_OBJECT_STATUS.

    6. Save the changes.