| Oracle® Identity Manager Connector Guide for Oracle Internet Directory Release 9.0.4 Part Number E10436-07 |
|
|
View PDF |
| Oracle® Identity Manager Connector Guide for Oracle Internet Directory Release 9.0.4 Part Number E10436-07 |
|
|
View PDF |
To deploy the connector, perform the procedures described in the following sections:
Depending on the release of Oracle Identity Manager that you use, perform the procedures described in one of the following sections:
The following table lists the deployment requirements for the connector.
You must configure incremental reconciliation by making the modifytimestamp attribute a searchable attribute.
To configure the target system for incremental reconciliation:
To make modifytimestamp a searchable attribute, use the catalog.sh file to index modifytimestamp.
See Oracle Identity Management User Reference Release 10g (10.1.4.0.1) for information about the procedure.
Restart Oracle Internet Directory for the change to take effect.
The ldap.jar file contains APIs that are used to connect to the target system. The ldapbp.jar file is used by the connector to enable LDAP-based search of user records on the target system. You must download this file from the Sun Web site and copy it into the ThirdParty directory as follows:
Log on to the JNDI Downloads section of the Sun Web site at
On the JNDI Downloads page, click Download JNDI 1.2.1 & More.
Select the I agree to the Software License Agreement check box, and then click Continue.
Select LDAP Service Provider, 1.2.4.
Click jndi-1_2_4.zip.
Specify the temporary directory into which you want to download the ldap-1_2_4.zip file.
Extract the contents of the ldap-1_2_4.zip file.
From the lib directory inside the ldap-1_2_4.zip file, copy the ldap.jar and ldapbp.jar files into the OIM_HOME/xellerate/ThirdParty directory.
Note:
In an Oracle Identity Manager cluster, copy this JAR file into the
ThirdParty directory on each node of the cluster.In the xlconfig.xml file, you must provide a higher value, 50,000 or more, for the checkouttimeout attribute. This XML file is in the OIM_HOME/xellerate/config directory. You must modify the checkouttimeout attribute value to ensure that the connector XML files are correctly imported.
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:
To run the Connector Installer:
Copy the contents of the connector installation media into the following directory:
OIM_HOME/xellerate/ConnectorDefaultDirectory
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.
Click Deployment Management, and then click Install Connector.
From the Connector List list, select Oracle Internet Directory 9.0.4.5. 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:
In the Alternative Directory field, enter the full path and name of that directory.
To repopulate the list of connectors in the Connector List list, click Refresh.
From the Connector List list, select Oracle Internet Directory 9.0.4.5.
Click Load.
To start the installation process, click Continue.
The following tasks are performed in sequence:
Configuration of connector libraries
Import of the connector XML files (by using the Deployment Manager)
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.
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:
Ensuring that the prerequisites for using the connector are addressed
Note:
At this stage, run thePurgeCache 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.
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.
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.
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 OID Server IT resource as follows:
Log in to the Administrative and User Console.
Expand Resource Management.
Click Manage IT Resource.
In the IT Resource Name field on the Manage IT Resource page, enter OID Server and then click Search.
Click the edit icon for the IT resource.
From the list at the top of the page, select Details and Parameters.
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: |
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: |
Root DN |
Base DN on which all the user operations are to be carried out
Sample value: dc=host_name, dc=com
Here, |
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 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
The value must be |
Recon Attribute Lookup Code |
Name of the lookup definition that has the target attribute mappings required for reconciliation
The value must be |
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 ou=org1,dc=corp,dc=company,dc=com In the preceding sample, you can choose In the preceding sample, the lookup must be populated with specific organization values. Oracle recommends that you first run a full reconciliation with 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 If set to |
Last Recon TimeStamp |
For the first reconciliation run, the timestamp value is not set. For subsequent rounds of reconciliation, the time at which the previous round of reconciliation was completed is stored in this parameter.
You do not need to provide a value for this parameter. Sample value: |
CustomizedReconQuery |
Query condition on which reconciliation must be based
If you specify a query condition for this parameter, then the target system records are searched based on the query condition. If you want to reconcile all the target system records, then do not specify a value for this parameter. The query can be composed with the AND (&) and OR (|) logical operators. Sample value: For more information about this parameter, refer to the "Partial Reconciliation" section. |
To save the values, click Update.
Installing the connector on any Oracle Identity Manager release between releases 8.5.3.1 and 9.0.3.x involves the following procedures:
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 |
|---|---|
Files in the Batch/custom directory |
Refer to the "Configuring the Target System" section for instructions on copying these files. |
lib/OIDProv.jar |
OIM_HOME/xellerate/JavaTasks
|
lib/OIDRecon.jar |
OIM_HOME/xellerate/ScheduleTasks
|
Files in the resources directory |
OIM_HOME/xellerate/connectorResources
|
Files in the test/troubleshoot directory |
OIM_HOME/xellerate/test/troubleshoot
|
Files in the xml directory |
OIM_HOME/xellerate/OID/xml
|
Note:
In a clustered environment, copy the JAR files and the contents of theconnectorResources directory to the corresponding directories on each node of the cluster.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:
Open the Oracle Identity Manager Administrative and User Console.
Click the Deployment Management link on the left navigation bar.
Click the Import link under Deployment Management. A dialog box for opening files is displayed.
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.
Click Add File. The Substitutions page is displayed.
Click Next. The Confirmation page is displayed.
Click Next. The Provide IT Resource Instance Data page for the OID Server IT resource is displayed.
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: |
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: |
Root DN |
Base DN on which all the user operations are to be carried out
Sample value: dc=host_name, dc=com
Here, |
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 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
The value must be |
Recon Attribute Lookup Code |
Name of the lookup definition that has the target attribute mappings required for reconciliation
The value must be |
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 ou=org1,dc=corp,dc=company,dc=com In the preceding sample, you can choose In the preceding sample, the lookup must be populated with specific organization values. Oracle recommends that you first run a full reconciliation with 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 If set to |
Last Recon TimeStamp |
For the first reconciliation run, the timestamp value is not set. For subsequent rounds of reconciliation, the time at which the previous round of reconciliation was completed is stored in this parameter.
You do not need to provide a value for this parameter. Sample value: |
CustomizedReconQuery |
Query condition on which reconciliation must be based
If you specify a query condition for this parameter, then the target system records are searched based on the query condition. If you want to reconcile all the target system records, then do not specify a value for this parameter. The query can be composed with the AND (&) and OR (|) logical operators. Sample value: For more information about this parameter, refer to the "Partial Reconciliation" section. |
Click Next. The Provide IT Resource Instance Data page for a new instance of the LDAP Server IT resource type is displayed.
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.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.
Click Import. The connector XML file is imported into Oracle Identity Manager.
Configuring the Oracle Identity Manager server involves performing 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 (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.
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:
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
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
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:
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
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:
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
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:
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>
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:
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
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
The Lookup.OID.PrefLang lookup definition is created in Oracle Identity Manager when you deploy the connector. During a provisioning operation, you use the Lookup.OID.PrefLang lookup definition to specify a language for the user.
You must enter values in the Lookup.OID.PrefLang lookup definition before you can use it during provisioning operations. To enter values in a lookup definition:
Log in to the Design Console.
Expand Administration, and double-click Lookup Definition.
Search for and open the lookup definition.
Enter Code Key and Decode values for each of entry.
You can enter any value. However, you must enter the same value in both the Code Key and Decode columns.
Click Save.
To enable incremental reconciliation, you made modifytimestamp a searchable attribute by performing the procedure described in "Configuring the Target System". In addition, you must modify the AttrName.Recon.Map.OID lookup definition by changing the Decode value of the ldapTargetResourceTimeStampField Code Key from [NONE] to modifytimestamp.
Note:
This is an optional step of the deployment procedure.
The connector supports only Mode 1 secure connections to Oracle Internet Directory.
To set up SSL connectivity between Oracle Identity Manager and the Oracle Internet Directory server:
Configure SSL on Oracle Internet Directory and then export the Oracle Internet Directory server certificate using Wallet Manager.
See the "Secure Sockets Layer and the Directory" chapter of Oracle Internet Directory Administrator's Guide for detailed instructions.
Note:
For Mode 1 secure connection, you must select SSL Server Authentication as the SSL Authentication.The default non-SSL port is 389. The default SSL port is 636. When you create a configuration set of Oracle Internet Directory, it is recommended that you select a different port (for example, 1636) for SSL communication with Oracle Identity Manager.
Check if the Oracle Internet Directory server is listening at the SSL port. If it is not, then set it to the SSL port (typically, the default SSL port is 636). Then, restart the server.
Import the certificate from the target system into the JSDK (the JSDK that is used during installation of Oracle Identity Manager) cacerts keystore as follows:
keytool -import –alias alias_name -file certificate_file_name_with_complete_path –keystore java_home/jre/lib/security/cacerts
Restart the Oracle Identity Manager server.
In the OID Server IT resource definition:
Set the SSL parameter value to true.
Set the Port parameter value to the SSL port number. Typically, this number is 636.
|
 Copyright © 2009, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|