Skip Headers
Oracle® Identity Manager Connector Guide for Microsoft Exchange 2000 and 2003
Release 9.0.2

Part Number B32158-01
Go to Documentation Home
Home
Go to Table of Contents
Contents
Go to Index
Index

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 Exchange 2000 and 2003, 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 Exchange 2000 and 2003
Target system host platforms The target system host platform can be any one of the following:
  • Microsoft Windows Server 2000

  • Microsoft Windows Server 2003

Other systems Microsoft Active Directory
Target system user account Because this connector requires the Microsoft Active Directory connector for its functioning, the target system user account requirements are the same as the requirements for the Microsoft Active Directory connector.


Note:

You must deploy the Microsoft Active Directory connector before you can deploy and use the Microsoft Exchange connector.

Refer to Oracle Identity Manager Connector Guide for Microsoft Active Directory for instructions to deploy the Microsoft Active Directory connector.


Step 2: Configuring the Target System

For using this connector, you do not need to perform any configuration steps on the target system.

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


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:
Collaboration and Messaging Applications\Microsoft Exchange\Microsoft Exchange Rev 3.4.0.zip

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 xml directory
OIM_home\xellerate\XLIntegrations\Exchange\xml
lib\xliExchange.jar
OIM_home\xellerate\JavaTasks
OIM_home\xellerate\ScheduleTask

Files in the resources directory
OIM_home\xellerate\connectorResources
docs\B32158_01.pdf
OIM_home\xellerate\docs\Exchange


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 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 file in the OIM_home\xellerate\connectorResources directory or make a change in an existing resource bundle file, 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.

Step 5: Importing the Connector XML Files

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 xliExchangeObject.xml file, which is in the OIM_home\xellerate\XLIntegrations\Exchange\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 Exchange Server - Dev IT resource is displayed.

  8. Specify values for the parameters of the Exchange Server - Dev IT resource. Refer to the 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 Exchange Server - Dev 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 XML file is imported into Oracle Identity Manager.

  13. Perform the same procedure to import the xliExchangeSchedulerTask.xml file, which is in the OIM_home\xellerate\XLIntegrations\Exchange\xml directory.

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

Defining IT Resources

You must specify values for the Exchange Server - Dev IT resource parameters listed in the following table.

Parameter Parameter Description
Server Name Host name of the Microsoft Windows computer on which Microsoft Exchange 2000 and 2003 is installed

Sample value: W2K_HOST

Note: The value must be specified in uppercase.

Store Name Mailbox store name

Sample value: Mailbox Store (W2K_HOST)

Here, W2K_HOST is the host name of the Microsoft Exchange 2000 and 2003 Server.

Last Modified Time Stamp Time at which the last reconciliation run was completed

This is in the timestamp format YYYYMMDDHHMMSSZ. At the end of each reconciliation run, the value is updated with the target system timestamp at that instance.

Sample value: 19721001000000Z

The initial value must be 0.


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

Configuring reconciliation involves performing the following tasks:

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 task are displayed.

  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.

After you create the scheduled task, proceed to the "Enabling Reconciliation in Oracle Identity Manager Release 9.0.1" section.

Specifying Values for the Scheduled Task Attributes

You must specify values for the following attributes of the 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
ADServer Name of the Microsoft Active Directory IT resource
Active Directory Server - Dev
Server Name of the Microsoft Exchange 2000 and 2003 IT resource
Exchange Server - Dev

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 Process Definition form. This form is in the Process Management folder.

  2. Click the Reconciliation Field Mappings tab.

  3. 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. Then, restart each node.

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.

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 Exchange 2000 and 2003. 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 need to modify only 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 Exchange 2000 and 2003 as the trusted source.

  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 Exchange 2000 and 2003 installation to which you want to provision the user.