| Oracle® Identity Manager Connector Guide for Oracle Internet Directory Release 9.0.3 Part Number B32363-02 |
|
|
View PDF |
| Oracle® Identity Manager Connector Guide for Oracle Internet Directory Release 9.0.3 Part Number B32363-02 |
|
|
View PDF |
Deploying the connector involves the following steps:
The following sections discuss procedures to customize the connector:
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 | Oracle Internet Directory 9.x (9.2.0.1) or 10.x |
| Target system host platforms | The target system host platform can be any one of the following:
|
| Target system user account | User account to which the BROWSE, ADD, DELETE, READ, WRITE, and SEARCH rights have been assigned
You provide the credentials of this user account while performing the procedure in the "Defining IT Resources" section. |
You must add a custom object class and custom attribute to the Oracle Internet Directory schema for the provisioning and reconciliation of user roles.
To add a custom object class and custom attribute:
Ensure that Oracle Internet Directory is running.
Copy the contents of the Batch\custom directory from the installation media ZIP file to a directory on the target Oracle Internet Directory server.
Using any text editor, open the custom.bat file.
In the commands listed in the custom.bat file, provide the host name, port, and Oracle Internet Directory superuser DN and password.
The following is the syntax for providing these values:
ldapmodify -h hostname -p port_number -D SuperUser_DN -w SuperUser_Password -c -f customRoleOccupant.ldif ldapadd -h hostname -p port_number -D SuperUser_DN -w SuperUser_Password -c -f customIndex.ldif ldapmodify -h hostname -p port_number -D SuperUser_DN -w SuperUser_Password -c -f customOrganizationalRole.ldif
For example:
ldapmodify -h bk2b3f-2809 -p 4389 -D "cn=orcladmin" -w "welcome" -c -f customRoleOccupant.ldif ldapadd -h bk2b3f-2809 -p 4389 -D "cn=orcladmin" -w "welcome" -c -f customIndex.ldif ldapmodify -h bk2b3f-2809 -p 4389 -D "cn=orcladmin" -w "welcome" -c -f customOrganizationalRole.ldif
Run the custom.bat file.
Open Oracle Directory Manager and click Schema Management in the left pane. The details of all schema elements are displayed in the right pane. Check if the customOrganizationalRole object class and customRoleOccupant attributes have been added to the schema.
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 directory on the installation media:Directory Servers\Oracle Internet Directory
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 Batch\custom directory |
Refer to the "Step 2: Configuring the Target System" section for instructions on copying these files. |
lib\xliOID.jar |
OIM_home\xellerate\JavaTasks
|
Files in the resources directory |
OIM_home\xellerate\connectorResources
|
Files in the Troubleshoot directory |
OIM_home\xellerate\Troubleshoot
|
Files in the xml directory |
OIM_home\xellerate\OID\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.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.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.
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.Open Control Panel.
Double-click Regional Options.
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.
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:
In a command window, change to the OIM_home\xellerate\bin directory.
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.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:
In the JBoss_home\server\default\conf\log4j.xml file, locate the following lines:
<category name="XELLERATE">
<priority value="log_level"/>
</category>
In the second XML code line, replace log_level with the log level that you want to set. For example:
<category name="XELLERATE"> <priority value="INFO"/> </category>
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:
Add the following line in the OIM_home\xellerate\config\log.properties file:
log4j.logger.XELLERATE=log_level
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:
Add the following line in the OIM_home\xellerate\config\log.properties file:
log4j.logger.XELLERATE=log_level
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:
Add the following line in the OIM_home\xellerate\config\log.properties file:
log4j.logger.XELLERATE=log_level
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
To import the connector XML files:
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 locating 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 table in the "Defining IT Resources" section for information about the values to be specified.
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.
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.
Click Import. The connector XML file is imported into Oracle Identity Manager.
After you import the connector XML files, proceed to the "Step 6: Configuring Reconciliation" section.
You must specify values for the OID Server IT resource parameters listed in the following table.
| 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.
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: |
After you specify values for these IT resource parameters, proceed to Step 9 of the procedure to import connector XML files.
Configuring reconciliation involves the following steps:
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 import theoimUser.xml file 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.
To configure trusted source reconciliation, you must first import the XML file for trusted source reconciliation as follows:
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 locating files is displayed.
Locate and open the oimUser.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 Import.
In the message that is displayed, click Import to confirm that you want to import the XML file and then click OK.
Then, set the value of the IsTrusted reconciliation scheduled task attribute to True while performing the procedure described in the following section.
To create the scheduled tasks for lookup fields and user reconciliations:
Expand the Xellerate Administration folder.
Select Task Scheduler.
Click Find. The details of the predefined scheduled tasks are displayed on two different tabs.
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.
Ensure that the Disabled and Stop Execution check boxes are not selected.
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.
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.
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 attributesClick 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.
Repeat Steps 5 through 10 to create the second scheduled task.
After you create both scheduled tasks, proceed to the "Step 7: Compiling Adapters" section.
This section provides information about the values to be specified for the following scheduled tasks:
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.Note:
TheCodeKeyLTrimStr and CodeKeyRTrimStr attributes control the value that becomes the code key of the lookup definition. The description of the value is the cn of the master value.For lookup reconciliation for groups in Oracle Identity Manager:
Perform steps 1 through 4 of the procedure to create scheduled tasks.
Select OID Group Lookup Reconciliation Task.
Ensure that the Disabled and Stop Execution check boxes are not selected.
Provide values for the attributes of the scheduled task. For example:
ObjectClass as groupOfUniqueNames
LookupCodeName as Lookup.OID.UserGroup
SearchContext as cn=Groups,dc=bmphktf120,dc=com
For lookup reconciliation for roles in Oracle Identity Manager:
Perform steps 1 through 4 of the procedure to create scheduled tasks.
Select OID Group Lookup Reconciliation Task.
Ensure that the Disabled and Stop Execution check boxes are not selected.
Provide values for the attributes of the scheduled task. For example:
ObjectClass as customOrganizationalRole
LookupCodeName as Lookup.OID.UserRole
SearchContext as cn=Roles,dc=bmphktf120,dc=com
After you specify values for these task attributes, proceed to Step 10 of the procedure to create scheduled tasks.
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.After you specify values for these task attributes, proceed to Step 10 of the procedure to create scheduled tasks.
The following adapters are imported into Oracle Identity Manager when you import the connector XML file:
OID Create User
OID Delete User
OID Modify User
OID Move User
OID Add User to Group
OID Remove User from Group
OID Add User to Role
OID Remove User from Role
OID Prepop String
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:
Open the Adapter Manager form.
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 anOK compilation status.Click Start. Oracle Identity Manager compiles the selected adapters.
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:
Highlight the adapter in the Adapter Manager form.
Double-click the row header of the adapter, or right-click the adapter.
Select Launch Adapter from the shortcut menu that is displayed. Details of the adapter are displayed.
Note:
This is an optional step of the deployment procedure.To set up SSL connectivity between Oracle Identity Manager and the Oracle Internet Directory server:
Export the Oracle Internet Directory server certificate using Wallet 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.
Note:
Perform this procedure only if you want to configure the connector for multiple installations of Oracle Internet 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:
Create and configure one resource object for each target system installation.
The Resource Objects form is in the Resource Management folder. The OID User resource object is created when you import the connector XML file. You can use this resource object as the template for creating the remaining resource objects.
Create and configure one IT resource for each resource object.
The IT Resources form is in the Resource Management folder. The OID Server 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.
Design one process form for each resource object.
The Form Designer form is in the Development Tools folder. The following process forms are created when you import the connector XML file:
UD_OID_USR (main form)
UD_OID_ROLE (child form for multivalue attributes)
UD_OID_GRP (child form for multivalue attributes)
You can use these process forms as templates for creating the remaining process forms.
Create and configure one process definition for each resource object.
The Process Definition form is in the Process Management folder. The OID User process definition is created when you import the connector XML file. You can use this process definition as the template for creating the remaining process definitions.
While creating process definitions for each target system installation, the following steps that you must perform are specific to the creation of each process definition:
From the Object Name lookup field, select the resource object that you create in Step 1.
From the Table Name lookup field, select the process form that you create in Step 3.
While mapping the adapter variables for the IT Resource data type, ensure that you select the IT resource that you create in Step 2 from the Qualifier list.
Configure reconciliation for each target system installation. Refer to the "Step 6: Configuring Reconciliation" section for instructions. Note that only the values of the following attributes are to be changed for each reconciliation scheduled task:
ITResourceName
ResourceObjectName
IsTrusted
Set the IsTrusted attribute to True for the Oracle Internet Directory installation that you want to designate as a trusted source. You can designate either a single or multiple installations of Oracle Internet Directory as the trusted source. For the remaining Oracle Internet Directory installations, set this attribute to False.
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 Oracle Internet Directory installation to which you want to provision the user.
Note:
The procedure described in this section is not part of the deployment procedure. You must perform this procedure only if you want to customize the mapping between the user ID fields of Oracle Internet Directory and Oracle Identity Manager.While creating a user account on Oracle Internet Directory through Oracle Identity Manager, the user ID that you specify is assigned to the cn field of Oracle Internet Directory. If required, you can customize the mapping so that the user ID is assigned to the uid field of Oracle Internet Directory.
See Also:
Oracle Identity Manager Design Console Guide for information about modifying lookup definitionsIn the Design Console, open the AttrName.Prov.Map.OID lookup definition.
Change the decode value of the ldapUserDNPrefix code key to uid.
Save the changes.
Now, when you create a user account on Oracle Internet Directory through Oracle Identity Manager, the user ID assigned in Oracle Identity Manager will be assigned to the uid field of Oracle Internet Directory.
