2 Deploying the Connector

Deploying the connector involves the following steps:

• Verifying Deployment Requirements

• Configuring the Target System

• Depending on the release of Oracle Identity Manager that you use, perform the procedures described in one of the following sections:

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

  • Installing the Connector on Oracle Identity Manager Release 8.5.3.1 Through 9.0.3.1

• Configuring the Oracle Identity Manager Server

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	Microsoft Windows Server 2003
Target system host platform	Microsoft Windows Server 2003
Oracle Identity Manager host platform	Microsoft Windows Server 2003
Infrastructure requirements	An additional computer running the Microsoft Windows 2003 operating system. This computer is meant for use as a file server.
Other applications	Microsoft Active Directory
Target system user account	Microsoft Windows 2003 File Server administrator You provide the credentials of this user account while configuring the IT resource. The procedure is described later in this guide.

2.2 Configuring the Target System

To configure the target system:

1. Ensure that the Microsoft Active Directory connector is installed on the target Microsoft Windows 2003 server.

2. Configure the file server and the target Microsoft Windows 2003 server on the domain on which you install Microsoft Active directory.

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:

• Running the Connector Installer

• Configuring the IT Resource

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 Microsoft Windows 9.0.4.2. 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 Microsoft Windows 9.0.4.2.

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.

8. Copy the files listed in the first column of the following table to the destination directories specified in the second column:

   File in the Installation Media Directory	Destination Directory
   config\debug.properties	OIM_HOME\xellerate\XLIntegrations\Windows2000\config
   lib\tcWindowsNT40.dll	OIM_HOME\xellerate\XLIntegrations\Windows2000\dll For Oracle Application Server, you must also copy this file into the following directory: OAS_HOME\bin For BEA WebLogic Server, you must also copy this file into the following directory: WEBLOGIC_HOME\server\bin
   Files in the test\config directory	OIM_HOME\xellerate\XLIntegrations\Windows2000\config
   Files in the test\scripts directory	OIM_HOME\xellerate\XLIntegrations\Windows2000\scripts

   
   

Note:

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 "Files and Directories on the Installation Media" for information about the files that you must copy and their destination locations on the Oracle Identity Manager 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 IT resource as follows:

1. Log in to the Administrative and User Console.

2. Expand Resource Management.

3. Click Manage IT Resource.

4. On the Manage IT Resource page, select W2K File Server from the IT Resource Type field 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	Parameter Description
   AdminName	User ID of the admin user on the Microsoft Windows computer that is used as the file server
   AdminPassword	Password of the admin user on the Microsoft Windows computer that is used as the file server
   ComputerName	Host name or IP address of the Microsoft Windows computer that is used as the file server
   DomainName	Domain of the Microsoft Windows computer that is used as the file server

   
   

8. To save the values, click Update.

9. On the Manage IT Resource page, select Windows AD Server from the IT Resource Name list and then click Search.

   Note:

   This IT resource is used to connect to Microsoft Active Directory.

10. Click the edit icon for the IT resource.

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

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

    Parameter	Parameter Description
    Admin FQDN	Enter the fully qualified domain name of the admin user account whose user ID you enter as the value of the AdminName parameter of the W2K File Server IT resource. You can use any one of the following formats to enter the domain name: [e-mail] cn=user_login,cn=Users,dc=domain,dc=com Sample values: [e-mail] cn=OIMadmin,cn=Users,dc=domain,dc=com
    Admin Login	Enter the user ID that you specify as the value of the AdminName parameter of the W2K File Server IT resource.
    Admin Password	Enter the password that you specify as the value of the AdminPassword parameter of the W2K File Server IT resource.
    Root Context	Enter 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	Enter the host name or IP address of the Microsoft Windows computer on which Microsoft Active Directory is installed. Sample values: w2khost 172.20.55.120
    Use SSL	Use this parameter to specify whether or not SSL has been used to secure communication between Oracle Identity Manager and Microsoft Active Directory. Default value: true Note: It is recommended that you enable SSL to secure communication with the target system.
    SSL Port Number	Enter the number of the port at which SSL is running on the target system host computer. Sample values: 636, if the Use SSL parameter is set to yes 389, if the Use SSL parameter is set to no
    Target Locale: Country	Enter the country code. Default value: US Note: You must specify the value in uppercase.
    Target Locale: Language	Enter the language code. Default value: en Note: You must specify the value in lowercase.

    
    

13. To save the values, click Update.

2.4 Installing the Connector on Oracle Identity Manager Release 8.5.3.1 Through 9.0.3.1

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

• Copying the Connector Files

• Importing the Connector XML File

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" section for more information about these files

File in the Installation Media Directory	Destination Directory
config\debug.properties	OIM_HOME\xellerate\XLIntegrations\Windows2000\config
lib\tcWindowsNT40.dll	OIM_HOME\xellerate\XLIntegrations\Windows2000\dll For Oracle Application Server, you must also copy this file into the following directory: OAS_HOME\bin For BEA WebLogic Server, you must also copy this file into the following directory: WEBLOGIC_HOME\server\bin
Files in the test\config directory	OIM_HOME\xellerate\XLIntegrations\Windows2000\config
Files in the test\scripts directory	OIM_HOME\xellerate\XLIntegrations\Windows2000\scripts
xml\Windows2000Object_DM.xml	OIM_HOME\xellerate\XLIntegrations\Windows2000\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

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 Windows2000Object_DM.xml file, which is in the OIM_HOME\xellerate\XLIntegrations\Windows2000\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 W2K File Server IT resource is displayed.

8. Specify values for the parameters of the W2K File Server IT resource. Refer to the following table for information about the values to be specified:

   Parameter	Description
   AdminName	User ID of the admin user on the Microsoft Windows computer that is used as the file server
   AdminPassword	Password of the admin user on the Microsoft Windows computer that is used as the file server
   ComputerName	Host name or IP address of the Microsoft Windows computer that is used as the file server
   DomainName	Domain of the Microsoft Windows computer that is used as the file server

   
   

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

10. Click Skip to specify that you do not want to define another IT resource. The Provide IT Resource Instance Data page for a new instance of the Windows AD Server IT resource type is displayed.

11. Specify values for the parameters of the Windows AD Server IT resource. Refer to the following table for information about the values to be specified:

    Parameter	Parameter Description
    Admin FQDN	Enter the fully qualified domain name of the admin user account whose user ID you enter as the value of the AdminName parameter of the W2K File Server IT resource. You can use any one of the following formats to enter the domain name: [e-mail] cn=user_login,cn=Users,dc=domain,dc=com Sample values: [e-mail] cn=OIMadmin,cn=Users,dc=domain,dc=com
    Admin Login	Enter the user ID that you specify as the value of the AdminName parameter of the W2K File Server IT resource.
    Admin Password	Enter the password that you specify as the value of the AdminPassword parameter of the W2K File Server IT resource.
    Root Context	Enter 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	Enter the host name or IP address of the Microsoft Windows computer on which Microsoft Active Directory is installed. Sample values: w2khost 172.20.55.120
    Use SSL	Use this parameter to specify whether or not SSL has been used to secure communication between Oracle Identity Manager and Microsoft Active Directory. Default value: true Note: It is recommended that you enable SSL to secure communication with the target system.
    SSL Port Number	Enter the number of the port at which SSL is running on the target system host computer. Sample values: 636, if the Use SSL parameter is set to yes 389, if the Use SSL parameter is set to no
    Target Locale: Country	Enter the country code. Default value: US Note: You must specify the value in uppercase.
    Target Locale: Language	Enter the language code. Default value: en Note: You must specify the value in lowercase.

    
    

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

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

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

15. 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 steps:

Note:

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

• Deploying the Microsoft Active Directory Connector

• Modifying the xlStartServer.bat File

• Changing to the Required Input Locale

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

• Enabling Logging

2.5.1 Deploying the Microsoft Active Directory Connector

Deploy the Microsoft Active Directory connector before you can deploy and use the Microsoft Windows connector. In addition, the Microsoft Windows user account must be provisioned only to an Xellerate User (OIM User) who already has a Microsoft Active Directory user account provisioned.

You must deploy the connector for Microsoft Active Directory in the following directory:

OIM_HOME\xellerate\XLIntegrations\ActiveDirectory

See Also:

Oracle Identity Manager Connector Guide for Microsoft Active Directory

2.5.2 Modifying the xlStartServer.bat File

Use a text editor to open the following file:

OIM_HOME\xellerate\bin\xlStartServer.bat

Add the following line at the start of this file:

SET PATH=OIM_HOME\xellerate\XLIntegrations\Windows2000\dll

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

While performing the instructions described in the "Copying the Connector 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 the following command:

   PurgeCache.bat 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.5 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 operations.

To enable logging:

1. Use a text editor to open the following file:

   OIM_HOME\xellerate\XLIntegrations\Windows2000\config\debug.properties
   

2. In this file, set the value of the debug attribute to true.

   Note:

   If you want to disable logging, set the value of the debug attribute to false.