2 Deploying the Connector

2.5.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 Oracle Internet Directory 9.0.4.7. 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 Oracle Internet Directory 9.0.4.7.

5. Click Load.

6. To start the installation process, click Continue.

   The following tasks are performed in sequence:

   1. Configuration of connector libraries

   2. Import of the connector XML files (by using the Deployment Manager)

   3. Compilation of adapters

   On successful completion of a task, a check mark is displayed for the task. If a task fails, then an X mark and a message stating the reason for failure are displayed. Depending on the reason for the failure, make the required correction and then perform one of the following steps:

   • Retry the installation by clicking Retry.

   • Cancel the installation and begin again from Step 0.

7. If all three tasks of the connector installation process are successful, then a message indicating successful installation is displayed. In addition, a list of the steps that you must perform after the installation is displayed. These steps are as follows:

   1. Ensuring that the prerequisites for using the connector are addressed

      Note:

      At this stage, run the PurgeCache utility to load the server cache with content from the connector resource bundle in order to view the list of prerequisites. Refer to "Clearing Content Related to Connector Resource Bundles from the Server Cache" for information about running the PurgeCache utility.

      There are no prerequisites for some predefined connectors.

   2. Configuring the IT resource for the connector

      Record the name of the IT resource displayed on this page. The procedure to configure the IT resource is described later in this guide.

   3. Configuring the scheduled tasks that are created when you installed the connector

      Record the names of the scheduled tasks displayed on this page. The procedure to configure these scheduled tasks is described later in this guide.

When you run the Connector Installer, it copies the connector files and external code files to destination directories on the Oracle Identity Manager host computer. These files are listed in Table 1-1.

Installing the Connector in an Oracle Identity Manager Cluster

While installing Oracle Identity Manager in a clustered environment, you must copy all the JAR files and the contents of the connectorResources directory into the corresponding directories on each node of the cluster. See "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.5.2 Configuring the IT Resource

You must specify values for the parameters of the OID Server IT resource as follows:

1. Log in to the Administrative and User Console.

2. Expand Resource Management.

3. Click Manage IT Resource.

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

5. Click the edit icon for the IT resource.

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

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

   Parameter	Description
   Admin Id	DN value of the user who has administrator rights on the Oracle Internet Directory server Sample value: cn=Admin,ou=People, o=xyz
   Admin Password	Password of the user who has administrator rights on the target Oracle Internet Directory server
   Server Address	IP address of the Oracle Internet Directory server
   Port	Port number to connect to the Oracle Internet Directory server Sample value: 389
   Root DN	Base DN on which all the user operations are to be carried out Sample value: dc=host_name, dc=com Here, host_name is the host name under which Oracle ConText is created.
   SSL	If this parameter is set to true, then SSL is used to secure communication between Oracle Identity Manager and the Oracle Internet Directory server. In this case, the authentication certificate of the Oracle Internet Directory server must be imported into the Oracle Identity Manager server. If this parameter is set to false, then SSL is not used to secure communication between Oracle Identity Manager and the Oracle Internet Directory server. Note: It is recommended that you enable SSL to secure communication with the target system.
   Prov Attribute Lookup Code	Name of the lookup definition that has the target attribute mappings required for provisioning a user. The value must be AttrName.Prov.Map.OID.
   Prov Group Attribute Lookup Code	Name of the lookup definition that has the target attribute mappings required for provisioning a group. The value must be AttrName.Group.Prov.Map.OID.
   Prov Role Attribute Lookup Code	Name of the lookup definition that has the target attribute mappings required for provisioning a role. The value must be AttrName.Role.Prov.Map.OID.
   Use XL Org Structure	If set to true, then the Oracle Identity Manager organization structure is used during provisioning and reconciliation. During provisioning, you can configure the users to be provisioned in a different organization instead of the default Xellerate Users in Oracle Identity Manager. Consider the following example. Suppose a custom organization org1 exists in the target system: ou=org1,dc=corp,dc=company,dc=com In the preceding sample, you can choose org1 from the lookup in the Xellerate form and provision the user to the target system. In the preceding sample, the lookup must be populated with specific organization values. Oracle recommends that you first run a full reconciliation with Use XL Org Structure=true and then provision a user. Once the full reconciliation is run, the data in the target system is replicated in Oracle Identity Manager. As a result lookup gets populated with the organization/organizational unit values automatically during the reconciliation. If you do not run a full reconciliation, then the organization must first be manually created and then the user should be provisioned. The name of the entity should be the same as that in the target system with identical casing. During reconciliation, if this attribute is set to true, then the users are reconciled in the respective organization as specified in the target system. Suppose, a user belongs to ou=org2,dc=corp,dc=company,dc=com in the target system. During reconciliation, the user gets updated in org2 in Oracle Identity Manager. This helps in maintaining the same organization structure in the target system and Oracle Identity Manager. If set to false, then the value of the Organization field in the process form is used for provisioning and the organization or container in the target Oracle Internet Directory is used for reconciliation. If the value is set to false, then all the users are provisioned and reconciled in the default Oracle Identity Manager organization, Xellerate Users.
   Last Trusted Recon TimeStamp	For the first trusted user reconciliation run, the timestamp value is not set. For subsequent rounds of reconciliation, the time at which the previous round of trusted user reconciliation was completed is stored in this parameter. You do not need to provide a value for this parameter. Sample value: 20060524110907Z
   Last Target Recon TimeStamp	For the first target user reconciliation run, the timestamp value is not set. For subsequent rounds of reconciliation, the time at which the previous round of target user reconciliation was completed is stored in this parameter. You do not need to provide a value for this parameter. Sample value: 20060524110907Z
   Last Trusted Delete Recon TimeStamp	For the first trusted user delete reconciliation run, the timestamp value is not set. For subsequent rounds of reconciliation, the time at which the previous round of trusted delete user reconciliation was completed is stored in this parameter. You do not need to provide a value for this parameter. Sample value: 20060524110907Z
   Last Target Delete Recon TimeStamp	For the first target delete user reconciliation run, the timestamp value is not set. For subsequent rounds of reconciliation, the time at which the previous round of target delete user reconciliation was completed is stored in this parameter. You do not need to provide a value for this parameter. Sample value: 20060524110907Z
   Group Reconciliation Time Stamp	For the first group reconciliation run, the timestamp value is not set. For subsequent rounds of reconciliation, the time at which the previous round of group reconciliation was completed is stored in this parameter. You do not need to provide a value for this parameter. Sample value: 20060524110907Z
   Role Reconciliation Time Stamp	For the first role reconciliation run, the timestamp value is not set. For subsequent rounds of reconciliation, the time at which the previous round of role reconciliation was completed is stored in this parameter. You do not need to provide a value for this parameter. Sample value: 20060524110907Z

   
   

8. To save the values, click Update.

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

lib/OIDProv.jar

OIM_HOME/xellerate/JavaTasks

lib/OIDRecon.jar

OIM_HOME/xellerate/ScheduleTasks

OIM_HOME/xellerate/connectorResources

OIM_HOME/xellerate/test/troubleshoot

OIM_HOME/xellerate/OID/xml

2.6.2 Importing the Connector XML File

As mentioned in the "Files and Directories on the Installation Media" section, the connector XML file contains definitions of the components of the connector. By importing the connector XML file, you create these components in Oracle Identity Manager.

To import the connector XML file:

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 oimOIDUser.xml file, which is in the OIM_HOME/xellerate/OID/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 OID Server IT resource is displayed.

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

   Parameter	Description
   Admin Id	DN value of the user who has administrator rights on the Oracle Internet Directory server Sample value: cn=Admin,ou=People, o=xyz
   Admin Password	Password of the user who has administrator rights on the target Oracle Internet Directory server
   Server Address	IP address of the Oracle Internet Directory server
   Port	Port number to connect to the Oracle Internet Directory server Sample value: 389
   Root DN	Base DN on which all the user operations are to be carried out Sample value: dc=host_name, dc=com Here, host_name is the host name under which Oracle ConText is created.
   SSL	If this parameter is set to true, then SSL is used to secure communication between Oracle Identity Manager and the Oracle Internet Directory server. In this case, the authentication certificate of the Oracle Internet Directory server must be imported into the Oracle Identity Manager server. If this parameter is set to false, then SSL is not used to secure communication between Oracle Identity Manager and the Oracle Internet Directory server. Note: It is recommended that you enable SSL to secure communication with the target system.
   Prov Attribute Lookup Code	Name of the lookup definition that has the target attribute mappings required for provisioning a user The value must be AttrName.Prov.Map.OID.
   Prov Group Attribute Lookup Code	Name of the lookup definition that has the target attribute mappings required for provisioning a group The value must be AttrName.Group.Prov.Map.OID.
   Prov Role Attribute Lookup Code	Name of the lookup definition that has the target attribute mappings required for provisioning a role The value must be AttrName.Role.Prov.Map.OID.
   Use XL Org Structure	If set to true, then the Oracle Identity Manager organization structure is used during provisioning and reconciliation. During provisioning, you can configure the users to be provisioned in a different organization instead of the default Xellerate Users in Oracle Identity Manager. Consider the following example. Suppose a custom organization org1 exists in the target system: ou=org1,dc=corp,dc=company,dc=com In the preceding sample, you can choose org1 from the lookup in the Xellerate form and provision the user to the target system. In the preceding sample, the lookup must be populated with specific organization values. Oracle recommends that you first run a full reconciliation with Use XL Org Structure=true and then provision a user. Once the full reconciliation is run, the data in the target system is replicated in Oracle Identity Manager. As a result lookup gets populated with the organization/organizational unit values automatically during the reconciliation. If you do not run a full reconciliation, then the organization must first be manually created and then the user should be provisioned. The name of the entity should be the same as that in the target system with identical casing. During reconciliation, if this attribute is set to true, then the users are reconciled in the respective organization as specified in the target system. Suppose, a user belongs to ou=org2,dc=corp,dc=company,dc=com in the target system. During reconciliation, the user gets updated in org2 in Oracle Identity Manager. This helps in maintaining the same organization structure in the target system and Oracle Identity Manager. If set to false, then the value of the Organization field in the process form is used for provisioning and the organization or container in the target Oracle Internet Directory is used for reconciliation. If the value is set to false, then all the users are provisioned and reconciled in the default Oracle Identity Manager organization, Xellerate Users.
   Last Trusted Recon TimeStamp	For the first trusted user reconciliation run, the timestamp value is not set. For subsequent rounds of reconciliation, the time at which the previous round of trusted user reconciliation was completed is stored in this parameter. You do not need to provide a value for this parameter. Sample value: 20060524110907Z
   Last Target Recon TimeStamp	For the first target user reconciliation run, the timestamp value is not set. For subsequent rounds of reconciliation, the time at which the previous round of target user reconciliation was completed is stored in this parameter. You do not need to provide a value for this parameter. Sample value: 20060524110907Z
   Last Trusted Delete Recon TimeStamp	For the first trusted user delete reconciliation run, the timestamp value is not set. For subsequent rounds of reconciliation, the time at which the previous round of trusted user delete reconciliation was completed is stored in this parameter. You do not need to provide a value for this parameter. Sample value: 20060524110907Z
   Last Target Delete Recon TimeStamp	For the first target user delete reconciliation run, the timestamp value is not set. For subsequent rounds of reconciliation, the time at which the previous round of target user delete reconciliation was completed is stored in this parameter. You do not need to provide a value for this parameter. Sample value: 20060524110907Z
   Group Reconcilition Time Stamp	For the first group reconciliation run, the timestamp value is not set. For subsequent rounds of reconciliation, the time at which the previous round of group reconciliation was completed is stored in this parameter. You do not need to provide a value for this parameter. Sample value: 20060524110907Z
   Role Reconcilition Time Stamp	For the first role reconciliation run, the timestamp value is not set. For subsequent rounds of reconciliation, the time at which the previous round of role reconciliation was completed is stored in this parameter. You do not need to provide a value for this parameter. Sample value: 20060524110907Z

   
   

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

10. Click Skip to specify that you do not want to define another IT resource. The Confirmation page is displayed.

    See Also:

    If you want to define another IT resource, then refer to Oracle Identity Manager Administrative and User Console Guide for instructions.

11. Click View Selections.

    The contents of the XML file are displayed on the Import page. You may see a cross-shaped icon along with some nodes. These nodes represent Oracle Identity Manager entities that are redundant. Before you import the connector XML file, you must remove these entities by right-clicking each node and then selecting Remove.

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

Linking Child Tables with the Parent Table

When you import the connector XML file by using the Deployment Manager, child tables for roles and groups are created in the database but not linked with the parent table.

To manually link the child tables with the parent table:

1. Log in to the Design Console.

2. Delete reconciliation field mappings for the Status, Role, and Group fields as follows:

   1. Expand Process Management, and then double-click Process Definition.

   2. Search for and open OID User process definition.

   3. Click the Reconciliation Field Mappings tab.

   4. Select Status, and then click Delete Map.

   5. Select Role, and then click Delete Map.

   6. Select Group, and then click Delete Map.

3. Link the child tables with the parent table as follows:

   1. Expand Development Tools, and double-click Form Designer.

   2. Search for and open the OID User process form.

   3. Click Create New Version.

   4. On the Create New Version dialog box, enter a label for the version to be created and then click the Save icon.

   5. Close the Create a New Version dialog box.

   6. From the Current Version list, select the newly created version.

   7. Click the Child Tables tab.

   8. If the two child tables are linked with the parent table, then the mapping is displayed on the form and you can proceed to Step 4.

   9. If the child tables' links with the parent table are not displayed, then the table is empty. If this is the case, then:

      i. Click Assign.

      The Assign Child Tables dialog box is displayed.

      ii. In the list on the left, select UD_OID_GRP and UD_OID_ROL.

      iii. Click the right arrow to move these items to the list on the right, and then click OK.

      iv. Click Make Version Active.

4. Re-create reconciliation field mappings for the Status, Role, and Group fields as follows:

   1. Expand Process Management, and then double-click Process Definition.

   2. Search for and open the OID User process definition.

   3. Click the Reconciliation Field Mappings tab.

   4. Click Add Field Map.

   5. On the Add Reconciliation Field Mapping dialog box, enter the following values:

      Field Name: Status

      Field Type: String

      Process Data Field: OIM_OBJECT_STATUS

   6. Click the Save icon, and then close the dialog box.

   7. Click Add Table Map.

   8. On the Add Reconciliation Table Mapping dialog box, enter the following values:

      Field Name: Role

      Field Type: Multiv-Valued

      Table Name: UD_OID_ROL

   9. Click the Save icon, and then close the dialog box.

   10. Right-click the Role field in the list, and then select Define Property Field Map from the shortcut menu.

   11. On the Map Reconciliation field dialog box, enter the following values:

       Field Name: Role Name

       Field Type: String

       Process Data Field: Role

   12. Select Key Field for Reconciliation Matching.

   13. Click the Save icon and then close the dialog box.

   14. Click Add Table Map.

   15. On the Add Reconciliation Table Mapping dialog box, enter the following values:

       Field Name: Group

       Field Type: Multi-Valued

       Table Name: UD_OID_GRP

   16. Click the Save icon and then close the dialog box.

   17. Right-click the Group field in the list, and then select Define Property Field Map from the shortcut menu.

   18. On the Map Reconciliation field dialog box, enter the following values:

       Field Name: Group Name

       Field Type: String

       Process Data Field: Group

   19. Select Key Field for Reconciliation Matching.

   20. Click the Save icon, and close the dialog box.

   21. Click the Save icon to save changes to the process definition.

2.7.1 Changing to the Required Input Locale

Changing to the required input locale (language and country setting) involves installing the required fonts and setting the required input locale.

You may require the assistance of the system administrator to change to the required input locale.

2.7.2 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 one of the following commands:

   • On Microsoft Windows:

     PurgeCache.bat ConnectorResourceBundle
     

   • On UNIX:

     PurgeCache.sh ConnectorResourceBundle
     

   Note:

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

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

   OIM_HOME/xellerate/config/xlConfig.xml
   

2.7.3 Enabling Logging

When you enable logging, Oracle Identity Manager automatically stores in a log file information about events that occur during the course of provisioning and reconciliation operations. To specify the type of event for which you want logging to take place, you can set the log level to one of the following:

• ALL

  This level enables logging for all events.

• DEBUG

  This level enables logging of information about fine-grained events that are useful for debugging.

• INFO

  This level enables logging of messages that highlight the progress of the application at a coarse-grained level.

• WARN

  This level enables logging of information about potentially harmful situations.

• ERROR

  This level enables logging of information about error events that may allow the application to continue running.

• FATAL

  This level enables logging of information about very severe error events that could cause the application to stop functioning.

• OFF

  This level disables logging for all events.

The file in which you set the log level and the log file path depend on the application server that you use:

• BEA WebLogic Server

  To enable logging:

  1. Add the following lines in the OIM_HOME/xellerate/config/log.properties file:

     log4j.logger.XELLERATE=log_level
     log4j.logger.XL_INTG.OID=log_level
     

  2. In these lines, replace log_level with the log level that you want to set.

     For example:

     log4j.logger.XELLERATE=INFO
     log4j.logger.XL_INTG.OID=INFO
     

  After you enable logging, log information is displayed on the server console.

• IBM WebSphere Application Server

  To enable logging:

  1. Add the following lines in the OIM_HOME/xellerate/config/log.properties file:

     log4j.logger.XELLERATE=log_level
     log4j.logger.XL_INTG.OID=log_level
     

  2. In these lines, replace log_level with the log level that you want to set.

     For example:

     log4j.logger.XELLERATE=INFO
     log4j.logger.XL_INTG.OID=INFO
     

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

  WEBSPHERE_HOME/AppServer/logs/SERVER_NAME/SystemOut.log
  

• JBoss Application Server

  To enable logging:

  1. In the JBOSS_HOME/server/default/conf/log4j.xml file, add the following lines if they are not already present in the file:

     <category name="XELLERATE">
        <priority value="log_level"/>
     </category>
     

     <category name="XL_INTG.OID">
        <priority value="log_level"/>
     </category>
     

  2. In the second XML code line of each set, replace log_level with the log level that you want to set. For example:

     <category name="XELLERATE">
        <priority value="INFO"/>
     </category>
     

     <category name="XL_INTG.OID">
        <priority value="INFO"/>
     </category>
     

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

  JBOSS_HOME/server/default/log/server.log
  

• Oracle Application Server

  To enable logging:

  1. Add the following lines in the OIM_HOME/xellerate/config/log.properties file:

     log4j.logger.XELLERATE=log_level
     log4j.logger.XL_INTG.OID=log_level
     

  2. In these lines, replace log_level with the log level that you want to set.

     For example:

     log4j.logger.XELLERATE=INFO
     log4j.logger.XL_INTG.OID=INFO
     

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

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

2.7.4 Setting Up Lookup Definitions in Oracle Identity Manager

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

• Lookup.OID.PrefLang

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

• Lookup.OID.Configuration

  The entries in this lookup definition are used during both reconciliation and provisioning.

• Lookup.OID.Constants

  This lookup definition stores all constants defined in the Java classes that constitute the connector. During connector operations, values of constants are read from the Lookup.OID.Constants lookup definition.

  Caution:

  You must not change any entry in the Lookup.OID.Constants lookup definition. If you change any entry, then the connector will not function correctly

The following sections discuss lookup definitions that you must manually configure in Oracle Identity Manager:

• Configuring the Lookup.OID.Configuration Lookup Definition

• Configuring the Lookup.OID.PrefLang Lookup Definition

2.7.5 Configuring High Availability of the Target System

Suppose you have set up multiple, replicated installations of the target system for high availability. You can use the Lookup.OID.Backupserver lookup definition to ensure that if the primary target system installation becomes unavailable, then Oracle Identity Manager switches to one of the secondary target system installations. The Lookup.OID.Backupserver lookup definition is one of the lookup definitions created when you deploy the connector.

For a single primary installation, you can have any number of secondary installations. In addition, if you configure the connector to work with multiple primary installations, then you can specify secondary installations for each primary installation.

To use the Lookup.OID.Backupserver lookup definition, open it in the Design Console and enter code key and decode values for each combination of primary and secondary target system installation.

Table 2-1 shows samples entries for the Lookup.OID.Backupserver lookup definition.

In this table, the first two entries represent two secondary installations (172.20.55.65 and 172.20.55.66) for one primary installation (172.20.55.64). The third entry shows a one-to-one combination of primary (172.20.55.97) and secondary (172.20.55.98) installations.