2 Deploying the Connector

To deploy the connector, perform the procedures described in the following sections:

2.1 Preinstallation

Note:

This is an optional step of the deployment procedure.

The procedures described in the following sections are applicable to Sun Java System Directory Server 5.2.

See Sun Java System Directory Server Administration Guide for procedures applicable to other versions of Sun Java System Directory Server.

This section is divided into the following topics:

2.1.1 Preinstallation on Oracle Identity Manager

This section contains the following topics:

2.1.1.1 Files and Directories on the Installation Media

Table 2-1 describes the files and directories on the installation media.

Table 2-1 Files and Directories on the Installation Media

File in the Installation Media Directory Description

configuration/SJSDS-CI.xml

This XML file contains configuration information that is used during connector installation.

Files in the dataset directory

  • ModifyResourceiPlanet User.xml

  • ProvisionResourceiPlanet User.xml

These XML files specify the information to be submitted by the requester during a request-based provisioning operation.

lib/SJSDSProv.jar

This JAR file contains the class files required for provisioning. During connector installation, this file is copied to the following location:

  • For Oracle Identity Manager release 9.1.0.x: OIM_HOME/xellerate/JavaTasks

  • For Oracle Identity Manager release 11.1.1: Oracle Identity Manager database

lib/SJSDSRecon.jar

This JAR file contains the class files required for reconciliation. During connector installation, this file is copied to the following location:

  • For Oracle Identity Manager release 9.1.0.x: OIM_HOME/xellerate/ScheduleTask

  • For Oracle Identity Manager release 11.1.1: Oracle Identity Manager database

Files in the resources directory

Each of these resource bundles contains language-specific information that is used by the connector. During connector installation, these resource bundles are copied to the following location:

  • For Oracle Identity Manager release 9.1.0.x: OIM_HOME/xellerate/connectorResources

  • For Oracle Identity Manager release 11.1.1: Oracle Identity Manager database

Note: A resource bundle is a file containing localized versions of the text strings that are displayed on the Administrative and User Console. These text strings include GUI element labels and messages.

test/troubleshoot/TroubleShootingUtilityIPlanet.class

This is the standalone class that interacts with the target system. This is the class that has the code required to run the test cases.

test/troubleshoot/log.properties

This file is used to specify the log level and the directory in which the log file is to be created when you run the testing utility.

test/troubleshoot/TroubleShootIPlanet.properties

This file contains the connection details that are required to connect to the target system and user details. It also contains details about the commands to be run.

xml/iPlanetResourceObject.xml

This XML file contains definitions for the following components of the connector:

  • IT resource type

  • Process form

  • Process task and rule-generator adapters (along with their mappings)

  • Resource object

  • Provisioning process

  • Pre-populate rules

  • Reconciliation process

  • Lookup definitions

xml/iPlanetXLResourceObject.xml

This XML file contains the configuration for the Xellerate User (OIM User). You must import this file only if you plan to use the connector in trusted source reconciliation mode.

xml/SJSDSConnectorRequestDatasets.xml

This file contains the request dataset for the connector. You import this file by using the Deployment Manager.

See Section 2.3.1.7.1, "Importing Request Datasets Using Deployment Manager" for more information.


Note:

The files in the troubleshooting directory are used only to run tests on the connector.

2.1.1.2 Determining the Release Number of the Connector

Note:

If you are using Oracle Identity Manager release 9.0.3.x or release 9.1.0.x, then the procedure described in this section is optional.

If you are using Oracle Identity Manager release 11.1.1, then skip this section.

You might have a deployment of an earlier release of the connector. While deploying the latest release, you might want to know the release number of the earlier release. To determine the release number of the connector that has already been deployed:

  1. In a temporary directory, extract the contents of the following JAR file:

    OIM_HOME/xellerate/JavaTasks/SJSDSProv.jar

  2. Open the Manifest.mf file in a text editor. The manifest.mf file is one of the files bundled inside the SJSDSProv.jar file.

    In the Manifest.mf file, the release number of the connector is displayed as the value of the Version property.

2.1.1.3 Using External Code Files

Note:

While installing Oracle Identity Manager in a cluster, you copy the contents of the installation directory to each node of the cluster. Similarly, you must copy the contents of the connectorResources directory and the JAR files to the corresponding directories on each node of the cluster.

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 JAR file from the Sun Web site and copy it into the ThirdParty directory as follows:

  1. Log on the Oracle Web site at

    http://download.oracle.com/otn-pub/java/jndi/1.2.1/ldap-1_2_4.zip

  2. Click Download JNDI 1.2.1 & More.

  3. From the table on the page that is displayed, select and download the file containing the ldapbp.jar file.

  4. Copy the ldapbp.jar file into the following directory:

    Note:

    In an Oracle Identity Manager cluster, copy this JAR file into the ThirdParty directory on each node of the cluster.

    • For Oracle Identity Manager release 9.0.3.x or release 9.1.0.x:

      OIM_HOME/xellerate/ThirdParty

    • For Oracle Identity Manager release 11.1.1:

      OIM_HOME/server/ThirdParty

2.1.2 Preinstallation on the Target System

This section describes the following procedures, which have to be performed on the target system to create a user account with limited rights:

2.1.2.1 Creating a Target System User Account for Connector Operations

Oracle Identity Manager requires a target system user account to access the target system during reconciliation and provisioning operations. You provide the credentials of this user account while performing the procedure described in Section 2.2.1.2, "Configuring the IT Resource."

To create this user account:

See Also:

Sun Java System Directory documentation for detailed information about performing this procedure

  1. Log in to the Sun One Server Console by using administrator credentials.

  2. Expand the host name folder.

  3. Expand Server Group.

  4. Select Directory Server, and then click Open on the right pane.

  5. On the Directory tab, right-click the root context. You can also select the OU under the root context in which you want to create the user.

  6. From the shortcut menu that is displayed, select New and then select User.

  7. In the Create New User dialog box, enter information about the user account and then click OK.

    The newly created user account is displayed on the right pane.

  8. To determine the entryDN value of the user account:

    1. Right-click the user account, and select Edit with Generic Editor.

    2. In the Generic Editor dialog box, copy the value that is displayed in the entrydn field. Record this value for future reference. You use the entrydn while assigning permissions to the user account. In addition, while configuring the IT resource, you specify the entrydn as the value of the AdminId IT resource parameter.

After creating the user account, you must assign the following permissions to the user account for each target system attribute that is used during reconciliation and provisioning:

  • Read: View the value of the attribute.

  • Write: Modify the value of the attribute.

  • Add: Set a value for the attribute.

  • Delete: Remove the value of the attribute.

To assign permissions to the user account:

  1. On the Sun One Server Console, expand the host name folder.

  2. Expand Server Group.

  3. Select Directory Server, and then click Open on the right pane.

  4. On the Directory tab, right-click the root context.

  5. From the shortcut menu that is displayed, select Edit with Generic Editor.

  6. Select aci.

  7. In the Edit region, click Add value.

  8. In the field that is displayed, copy the following:

    (targetattr = "physicalDeliveryOfficeName || homePhone || preferredDeliveryMethod || jpegPhoto || nsRoleDN || audio || internationaliSDNNumber || owner || postalAddress || roomNumber || givenName || carLicense || userPKCS12 || searchGuide || userPassword || teletexTerminalIdentifier || mobile || manager || entrydn || objectClass || userSMIMECertificate || displayName || destinationIndicator || telexNumber || employeeNumber || secretary || uid || userCertificate || st || sn || description || mail || labeledUri || businessCategory || homePostalAddress || x500UniqueIdentifier || modifyTimestamp || postOfficeBox || ou || nsAccountLock || seeAlso || registeredAddress || postalCode || photo || title || uniqueMember || street || pager || departmentNumber || dc || o || cn || l || initials || telephoneNumber || preferredLanguage || facsimileTelephoneNumber || x121Address || employeeType") (version 3.0;acl "ACI_NAME";allow (read,write,delete,add)(userdn = "ldap:///ENTRYDN_VALUE");)
    
  9. In the string that you copy:

    • Replace ACI_NAME with the name that you want to assign to the ACI, for example, OIMUserACI.

    • Replace ENTRYDN_VALUE with the entrydn value that you record in Step 8.b, for example, uid=OIMUser,ou=Org1,dc=corp,dc=oracle,dc=com.

  10. Click OK.

  11. To view or modify the access permissions you have set for the user account:

    1. In the main Sun One Server Console window, right-click the root context.

    2. From the shortcut menu, click Set Access Permissions.

    3. In the Manage Access Control dialog box, select the ACI that you create for the user account and then click Edit.

      The ACI that you create for the user account is displayed.

    4. If required, make changes in the ACI and then click OK.

2.1.2.2 Creating a VLV Index

By creating a VLV index, you can improve the performance of reconciliation runs. To create a VLV index:

  1. Log in to the Sun One Server Console by using administrator credentials.

  2. Expand the host name folder.

  3. Expand Server Group.

  4. Select Directory Server, and then click Open on the right pane.

  5. On the Directory tab, right-click the root context.

  6. From the shortcut menu that is displayed, select New and then select Other.

  7. In the New Object dialog box, select vlvindex and then click OK.

  8. In the Generic Editor dialog box, select Object class and then click Add value.

  9. In the Add Object Class dialog box, select vlvsearch and then click OK.

  10. In the Generic Editor dialog box, click Change.

  11. In the Naming Attribute column of the Change Naming Attribute dialog box, deselect the check box for the vlvsort attribute, select the check box for the cn attribute, and then click OK.

  12. Specify values for the following attributes:

    • vlvbase: Enter the tree level where you want the index to be created.

      Sample value: dc=corp,dc=example,dc=com

    • vlvfilter: Enter the search filter for the index.

      Sample value: (|(objectclass=*)(objectclass=ldapsubentry))

    • vlvscope: This attribute specifies the scope of the search. Specify one of the following values:

      • Enter 0 for a base-level search.

      • Enter 1 stands for a one-level search.

      • Enter 2 for a sub-tree search.

      Sample value: 1

    • vlvsort: This attribute specifies the sort order that the VLV ldapsearch command uses for the VLV index.

      Sample value: modifytimestamp

  13. Click OK.

2.2 Installation

Note:

This is an optional step of the deployment procedure.

The procedures described in the following sections are applicable to Sun Java System Directory Server 5.2.

See Sun Java System Directory Server Administration Guide for procedures applicable to other versions of Sun Java System Directory Server.

Depending on the Oracle Identity Manager release that you are using, perform the procedure described in one of the following sections:

2.2.1 Installing the Connector on Oracle Identity Manager Release 9.1.0.x or Release 11.1.1

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.x or release 11.1.1 or later involves the following procedures:

2.2.1.1 Running the Connector Installer

To run the Connector Installer:

  1. Copy the contents of the connector installation media directory into the following directory:

    Note:

    In an Oracle Identity Manager cluster, copy this JAR file to each node of the cluster.

    • For Oracle Identity Manager release 9.1.0.x: OIM_HOME/xellerate/ConnectorDefaultDirectory

    • For Oracle Identity Manager release 11.1.1: OIM_HOME/server/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 the following guide:

  3. Depending on the Oracle Identity Manager release you are using, perform one of the following steps:

    • For Oracle Identity Manager release 9.1.0.x:

      Click Deployment Management, and then click Install Connector.

    • For Oracle Identity Manager release 11.1.1:

      On the Welcome to Identity Manager Advanced Administration page, in the System Management region, click Install Connector.

  4. From the Connector List list, select Sun Java System Directory RELEASE_NUMBER. This list displays the names and release numbers of connectors whose installation files you copy into the default connector installation directory in Step 1.

    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 Sun Java System Directory RELEASE_NUMBER.

  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 Target Resource user configuration XML file (by using the Deployment Manager). If you want to import the target system as a trusted source for reconciliation, then see Section 2.3.1.6, "Configuring Trusted Source Reconciliation."

    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 Oracle Identity Manager PurgeCache utility to load the server cache with content from the connector resource bundle in order to view the list of prerequisites. See Section 2.3.1.2, "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

      Note:

      In Oracle Identity Manager release 11.1.1, a scheduled job is an instance of a scheduled task. In this guide, the term scheduled task used in the context of Oracle Identity Manager release 9.1.0.x is the same as the term scheduled job in the context of Oracle Identity Manager release 11.1.1.

      See Oracle Fusion Middleware Administrator's Guide for Oracle Identity Manager for more information about scheduled tasks and scheduled jobs.

      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 2-1.

Installing the Connector in an Oracle Identity Manager Cluster

While installing Oracle Identity Manager in a cluster, 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 Section 2.1.1.1, "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 host computer.

2.2.1.2 Configuring the IT Resource

You must specify values for the parameters of the iPlanet IT Resource IT resource as follows:

  1. Log in to the Administrative and User Console.

  2. If you are using Oracle Identity Manager release 9.1.0.x, expand Resource Management, and then click Manage IT Resource.

  3. If you are using Oracle Identity Manager release 11.1.1, then:

    • On the Welcome page, click Advanced in the upper-right corner of the page.

    • On the Welcome to Oracle Identity Manager Advanced Administration page, in the Configuration region, click Manage IT Resource.

  4. In the IT Resource Name field on the Manage IT Resource page, enter iPlanet User 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. Table 2-2 describes each parameter.

    Table 2-2 IT Resource Parameters

    Parameter Description

    Admin Id

    DN value of the user who has administrator rights on Sun Java System Directory

    The default value is uid=admin,ou=administrators,ou=topologymanagement,o=netscaperoot

    Admin Password

    Password of the user who has administrator rights on Sun Java System Directory

    Server Address

    IP address of the target Sun Java System Directory server

    Port

    Port number to connect to the target Sun Java System Directory server

    The default value is 389. This parameter is mentioned in Section 2.3.2, "Configuring SSL."

    Root DN

    Base DN where all the user operations are to be carried out

    The value can be o=xyz

    SSL

    Specifies whether or not an SSL connection is used for communication between Oracle Identity Manager and the target Sun Java System Directory server

    The value can be true or false. This parameter is mentioned in the Section 2.3.2, "Configuring SSL."

    Note: It is recommended that you enable SSL to secure communication with the target system.

    Target Resource Reconciliation Time Stamp

    Starting with the first reconciliation run, this parameter stores the time-stamp value at which a target resource reconciliation run ends.

    Note: You must not change the default value of this parameter.

    Trusted Source Reconciliation Time Stamp

    Starting with the first reconciliation run, this parameter stores the time-stamp value at which trusted source reconciliation run ends.

    Note: You must not change the default value of this parameter.

    Prov Attribute Lookup Code

    Name of the lookup definition that has the target attribute mappings required for provisioning of users

    The default value of this parameter is AttrName.Prov.Map.iPlanet

    Recon Attribute Lookup Code

    Name of the lookup definition that has the target attribute mappings required for reconciliation of users

    The default value of this parameter is AttrName.Recon.Map.iPlanet

    Use XL Org Structure

    If set to true, then the Oracle Identity Manager Organization structure is used during provisioning and reconciliation.

    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 Sun Java System Directory is used for reconciliation.

    Group Reconciliation Time Stamp

    Starting with the first reconciliation run, this parameter stores the time-stamp value at which a group reconciliation run ends.

    Note: You must not change the default value of this parameter.

    Role Reconciliation Time Stamp

    Starting with the first reconciliation run, this parameter stores the time-stamp value at which a role reconciliation run ends.

    Note: You must not change the default value of this parameter.

    Prov Group Attribute Lookup Code

    Name of the lookup definition that has the target attribute mappings required for provisioning of Groups.

    The default value of this parameter is AtMap.iPlanetGroup.

    Prov Role Attribute Lookup Code

    Name of the lookup definition that has the target attribute mappings required for provisioning of Roles.

    The default value of this parameter is AttrMap.iPlanetRole.

    Last Trusted Delete Recon TimeStamp

    Starting with the first trusted delete reconciliation run, this parameter stores the time-stamp value at which trusted source delete reconciliation run ends.

    Note: You must not change the default value of this parameter.

    Last Target Delete Recon TimeStamp

    Starting with the first target delete reconciliation run, this parameter stores the time-stamp value at which target source delete reconciliation run ends.

    Note: You must not change the default value of this parameter.

    Abandoned connection timeout

    Enter the time (in seconds) after which a connection must be automatically closed if it is not returned to the pool.

    Note: You must set this parameter to a value that is high enough to accommodate processes that take a long time to complete (for example, full reconciliation).

    Default value: 600

    Backup Servers URL

    Enter a value for this parameter when both the following conditions are true:

    • You specify true as the value of the Connection pooling supported parameter, which is described later in this table.

    • You want to configure high availability of the target system.

    Enter the complete URL of the secondary target system installations to which Oracle Identity Manager must switch to if the primary target system installation becomes unavailable.

    You must specify the complete URL in the following format:

    ldap://SERVERADDRESS:PORT/

    ldap://SERVERADDRESS1:PORT1/

    Default Value: [NONE]

    Sample value: ldap://172.20.55.191:389/ ldap://172.20.55.171:387/

    Note: Multiple URLs must be separated by space.

    LDAP Connection TimeOut

    Enter the timeout interval (in milliseconds) for which the connector must wait for a response from the target system before switching to one of the backup servers listed in the Backup Server URL parameter.Default Value: 3000

    Note: This parameter is used only if you specify a value for the Backup Server URL parameter.

    Connection pooling supported

    Enter true if you want to enable connection pooling for this target system installation. Otherwise, enter false.

    Default value: false

    Connection wait timeout

    Enter the maximum time (in seconds) for which the connector must wait for a connection to be available.

    Default value: 60

    Inactive connection timeout

    Enter the time (in seconds) of inactivity after which a connection must be dropped and replaced by a new connection in the pool.

    Default value: 600

    Initial pool size

    Enter the number of connections that must be established when the connection pool is initialized.

    The pool is initialized when it receives the first connection request from a connector.

    Default value: 1

    Sample value: 3

    Max pool size

    Enter the maximum number of connections that must be established in the pool at any point of time

    This number includes the connections that have been borrowed from the pool.

    Default value: 30

    Sample value: 10

    Min pool size

    Enter the minimum number of connections that must be in the pool at any point of time.

    This number includes the connections that have been borrowed from the pool.

    Default value: 2

    Sample value: 5

    Native connection pool class definition

    This parameter holds the name of the wrapper to the native pool mechanism that implements the GenericPool.

    Note: Do not specify a value for this parameter.

    Pool excluded fields

    This parameter holds a comma-separated list of IT parameters whose change must not trigger a refresh of the connector pool.

    Value:

    Note:

    Do not change the value of this parameter unless you are adding or deleting a parameter from the IT resource. You must ensure that the total length of the list does not exceed 2000 characters. If you are adding a parameter to the IT resource, then that parameter name must be added to the above list with a comma separator. If you are deleting a parameter from the IT resource, then that parameter must be removed from the list if it exists in the list.

    You must restart Oracle Identity Manager for changes that you make to this parameter to take effect.

    Pool preference

    This parameter specifies the preferred connection pooling implementation.

    Value: Default

    Note: Do not change this value of this parameter.

    ResourceConnection class definition

    This parameter holds the name of the implementation of the ResourceConnection class.

    Value:

    com.thortech.xl.integration.iplanet.util.iplanetResourceConnectionlmpl.

    Note: Do not change the value of this parameter.

    Target supports only one connection

    This parameter indicates whether the target system can support one or more connections at a time.

    Value: false

    Note: Do not change the value of this parameter.

    Timeout check interval

    Enter the time interval (in seconds) at which the other timeouts specified by the other parameters must be checked

    Default value: 30

    Validate connection on borrow

    Specify whether or not a connection must be validated before it is lent by the pool.

    The value can be true or false. It is recommended that you set the value to true.

    Default value: true

    Prov Org Attribute Lookup Code

    Name of the lookup definition that has the target attribute mappings required forprovisioning of Organization Units.

    Default Value: AtMap.iPlanetOrg


  8. To save the values, click Update.

2.2.2 Installing the Connector on Oracle Identity Manager Release 9.0.3.2 or Later Releases in the 9.0.3.x Series

Installing the connector on any Oracle Identity Manager release between release 9.0.3.2 or later releases in the 9.0.3.x series involves the following procedures:

2.2.2.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:

Section 2.1.1.1, "Files and Directories on the Installation Media" for more information about these files

Files in the Installation Media Directory Destination Directory

lib/SJSDSProv.jar

OIM_HOME/xellerate/JavaTasks

lib/SJSDSRecon.jar

OIM_HOME/xellerate/ScheduleTasks

Files in the resources directory

OIM_HOME/xellerate/connectorResources

Files in the test directory

OIM_HOME/xellerate/SJSDS/test/troubleshoot

Files in the xml directory

OIM_HOME/xellerate/SJSDS/xml


Note:

In an Oracle Identity Manager cluster, copy the JAR files and the contents of the connectorResources directory to the corresponding directories on each node of the cluster.

2.2.2.2 Importing the Connector XML File

As mentioned in Section 2.1.1.1, "Files and Directories on the Installation Media," 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 files into Oracle Identity Manager:

  1. Open the Oracle Identity Manager Administrative and User Console.

  2. Click the Deployment Management link on the left navigation bar.

  3. Click the Import link under Deployment Management. A dialog box for opening files is displayed.

  4. Locate and open the iPlanetResourceObject.xml file If you are using OIM 9.1.0.x, path is: OIM_HOME/xellerate/ConnectorDefaultDirectory/<iPlanet Package>/xml directory. If you are using OIM 11x, path is: OIM_HOME/server/ConnectorDefaultDirectory/<iPlanet Package>/xml directory OR iPlanetResourceObject.xml file can also be found in the connector package stored in the local machine.

    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 iPlanet User IT resource is displayed.

  8. Specify values for the parameters of the iPlanet User IT resource. Refer to Table 2-2 for information about the values to be specified.

  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 Fusion Middleware User's Guide for Oracle Identity Manager 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 file is imported into Oracle Identity Manager.

2.2.2.3 Compiling Adapters

Note:

You must perform the procedure described in this section if you want to use the provisioning features of Oracle Identity Manager for this target system.

Adapters are used to implement provisioning functions. The following adapters are imported into Oracle Identity Manager when you import the connector XML file:

See Also:

Section 1.6.6, "Provisioning Functions" for a listing of the provisioning functions that are available with this connector

  • Update iPlanet Role Details

  • iPlanet PP String

  • iPlanet Common Name PP String

  • iPlanet Create OU

  • iPlanet Delete OU

  • iPlanet Move OU

  • iPlanet Create Role

  • iPlanet Delete Role

  • iPlanet Add User to Group

  • iPlanet Create Group

  • iPlanet Remove User From Group

  • iPlanet Create User

  • iPlanet Change Org Name

  • iPlanet Delete User

  • iPlanet Remove Role from user

  • iPlanet Delete Group

  • Update iPlanet Group Details

  • Chk Process Parent Org

  • iPlanet Add Role to User

  • iPlanet Move User

  • iPlanet Modify User

  • iPlanet Add Multivalue Attribute

  • iPlanet Remove Multivalue Attribute

  • iPlanet Update Multivalue Attribute

  • Update iPlanet Group Attributes

  • Update iPlanet Role Attributes

  • iPlanet Move Group

  • iPlanet Move Role

You must compile these adapters before they can be used in provisioning operations.

To compile adapters by using the Adapter Manager form:

  1. Open the Adapter Manager form.

  2. To compile all the adapters that you import into the current database, select Compile All.

    To compile multiple (but not all) adapters, select the adapters you want to compile. Then, select Compile Selected.

    Note:

    Click Compile Previously Failed to recompile only those adapters that were not compiled successfully. Such adapters do not have an OK compilation status.

  3. Click Start. Oracle Identity Manager compiles the selected adapters.

  4. If Oracle Identity Manager is installed in a cluster, 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.

If you want to compile one adapter at a time, then use the Adapter Factory form.

See Also:

Oracle Identity Manager Tools Reference Guide for information about using the Adapter Factory and Adapter Manager forms

To view detailed information about an adapter:

  1. Highlight the adapter in the Adapter Manager form.

  2. Double-click the row header of the adapter, or right-click the adapter.

  3. Select Launch Adapter from the shortcut menu that is displayed. Details of the adapter are displayed.

2.3 Postinstallation

Note:

This is an optional step of the deployment procedure.

The procedures described in the following sections are applicable to Sun Java System Directory Server 5.2.

See Sun Java System Directory Server Administration Guide for procedures applicable to other versions of Sun Java System Directory Server.

Postinstallation steps are divided across the following sections:

2.3.1 Configuring Oracle Identity Manager

Configuring the Oracle Identity Manager involves performing the following procedures:

2.3.1.1 Changing to the Required Input Locale

Note:

In an Oracle Identity Manager cluster, 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.

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

Note:

In an Oracle Identity Manager cluster, you must perform this step on each node of the cluster. Then, restart each node.

When you deploy the connector, the resource bundles are copied from the resources directory on the installation media into the OIM_HOME/xellerate/connectorResources directory for Oracle Identity Manager release 9.0.3.x and release 9.1.0.x, and Oracle Identity Manager database for Oracle Identity Manager release 11.1.1. Whenever you add a new resource bundle to 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, perform one of the following steps:

    • If you are using Oracle Identity Manager release 9.0.3.x or release 9.1.0.x, then switch to the OIM_HOME/xellerate/bin directory.

    • If you are using Oracle Identity Manager release 11.1.1, then switch to the OIM_HOME/server/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:

    For Oracle Identity Manager release 9.0.3.x or release 9.1.0.x:

    OIM_HOME/xellerate/bin/SCRIPT_FILE_NAME
    

    For Oracle Identity Manager release 11.1.1:

    OIM_HOME/server/bin/SCRIPT_FILE_NAME
    
  2. Enter one of the following commands:

    Note:

    You can use the PurgeCache utility to purge the cache for any content category. Run PurgeCache.bat CATEGORY_NAME on Microsoft Windows or PurgeCache.sh CATEGORY_NAME on UNIX. The CATEGORY_NAME argument represents the name of the content category that must be purged.

    For example, the following commands purge Metadata entries from the server cache:

    PurgeCache.bat MetaData

    PurgeCache.sh MetaData

    • For Oracle Identity Manager release 9.0.3.x or release 9.1.0.x:

      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. This exception is different from the one mentioned in Step 1.

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

      OIM_HOME/xellerate/config/xlconfig.xml

    • For Oracle Identity Manager release 11.1.1:

      On Microsoft Windows: PurgeCache.bat All

      On UNIX: PurgeCache.sh All

      When prompted, enter the user name and password of an account belonging to the SYSTEM ADMINISTRATORS group. In addition, you are prompted to enter the service URL in the following format:

      t3://OIM_HOST_NAME:OIM_PORT_NUMBER
      

      In this format:

      • Replace OIM_HOST_NAME with the host name or IP address of the Oracle Identity Manager host computer.

      • Replace OIM_PORT_NUMBER with the port on which Oracle Identity Manager is listening.

    See Oracle Fusion Middleware Administrator's Guide for Oracle Identity Manager for more information about the PurgeCache utility.

2.3.1.3 Enabling Logging

Depending on the Oracle Identity Manager release you are using, perform instructions in one of the following sections:

2.3.1.3.1 Enabling Logging on Oracle Identity Manager Release 9.0.3.x or Release 9.1.0.x

Note:

In an Oracle Identity Manager cluster, perform this procedure on each node of the cluster. Then, restart each node.

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 might 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:

  • Oracle 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.SJSDS=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.SJSDS=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.SJSDS=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.SJSDS=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.SJSDS">
         <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.SJSDS">
         <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.SJSDS=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.SJSDS=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.3.1.3.2 Enabling Logging on Oracle Identity Manager Release 11.1.1

Note:

In an Oracle Identity Manager cluster, perform this procedure on each node of the cluster. Then, restart each node.

Oracle Identity Manager release 11.1.1 uses Oracle Java Diagnostic Logging (OJDL) for logging. OJDL is based on java.util.logger. 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:

  • SEVERE.intValue()+100

    This level enables logging of information about fatal errors.

  • SEVERE

    This level enables logging of information about errors that might allow Oracle Identity Manager to continue running.

  • WARNING

    This level enables logging of information about potentially harmful situations.

  • INFO

    This level enables logging of messages that highlight the progress of the application.

  • CONFIG

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

  • FINE, FINER, FINEST

    These levels enable logging of information about fine-grained events, where FINEST logs information about all events.

These log levels are mapped to ODL message type and level combinations as shown in Table 2-3.

Table 2-3 Log Levels and ODL Message Type:Level Combinations

Log Level ODL Message Type:Level

SEVERE.intValue()+100

INCIDENT_ERROR:1

SEVERE

ERROR:1

WARNING

WARNING:1

INFO

NOTIFICATION:1

CONFIG

NOTIFICATION:16

FINE

TRACE:1

FINER

TRACE:16

FINEST

TRACE:32


The configuration file for OJDL is logging.xml, which is located at the following path:

DOMAIN_HOME/config/fmwconfig/servers/OIM_SERVER/logging.xml

Here, DOMAIN_HOME and OIM_SERVER are the domain name and server name specified during the installation of Oracle Identity Manager.

To enable logging in Oracle WebLogic Server:

  1. Edit the logging.xml file as follows:

    1. Add the following block into <log_handlers> section:

      <log_handler name='sjsds-handler' level='[LOG_LEVEL]' class='oracle.core.ojdl.logging.ODLHandlerFactory'>
           <property name='logreader:' value='off'/>
           <property name='path' value='[FILE_NAME]'/>
           <property name='format' value='ODL-Text'/>
           <property name='useThreadName' value='true'/>
           <property name='locale' value='en'/>
           <property name='maxFileSize' value='5242880'/>
           <property name='maxLogSize' value='52428800'/>
           <property name='encoding' value='UTF-8'/>
       </log_handler>
      

      Add the following block into <loggers> section.

      <logger name="XL_INTG.SJSDS" level="[LOG_LEVEL]" useParentHandlers="false">
           <handler name="sjsds-handler"/>
           <handler name="console-handler"/>
      </logger>
      
    2. Replace both occurrences of [LOG_LEVEL] with the ODL message type and level combination that you require. Table 2-3 lists the supported message type and level combinations.

      Similarly, replace [FILE_NAME] with the full path and name of the log file in which you want log messages to be recorded.

      The following blocks show sample values for [LOG_LEVEL] and [FILE_NAME] :

      <log_handler name='sjsds-handler' level='NOTIFICATION:1' class='oracle.core.ojdl.logging.ODLHandlerFactory'>
           <property name='logreader:' value='off'/>
           <property name='path' value='F:\MyMachine\middleware\user_projects\domains\base_domain1\servers\oim_server1\logs\oim_server1-diagnostic-1.log'/>
           <property name='format' value='ODL-Text'/>
           <property name='useThreadName' value='true'/>
           <property name='locale' value='en'/>
           <property name='maxFileSize' value='5242880'/>
           <property name='maxLogSize' value='52428800'/>
           <property name='encoding' value='UTF-8'/>
        </log_handler>
       
      <logger name="XL_INTG.SJSDS" level="NOTIFICATION:1" useParentHandlers="false">
           <handler name="sjsds-handler"/>
           <handler name="console-handler"/>
      </logger>
      

    With these sample values, when you use Oracle Identity Manager, all messages generated for this connector that are of a log level equal to or higher than the NOTIFICATION:1 level are recorded in the specified file.

  2. Save and close the file.

  3. Set the following environment variable to redirect the server logs to a file:

    For Microsoft Windows:

    set WLS_REDIRECT_LOG=FILENAME
    

    For UNIX:

    export WLS_REDIRECT_LOG=FILENAME
    

    Replace FILENAME with the location and name of the file to which you want to redirect the output.

  4. Restart the application server.

Note:

  • You can also configure the connector logging without adding separate handler and using existing log handler.

  • It is advisable to modify logging.xml using the GUI screen in Enterprise Manager instead of manually editing the file.

2.3.1.4 Setting Up Lookup Definitions in Oracle Identity Manager

You must enter values in some of the lookup definitions that are created when you install the connector. To enter values in a lookup definition:

  1. Log in to the Design Console.

  2. Expand Administration, and double-click Lookup Definition.

  3. Search for and open the lookup definitions described in the following sections. After you enter values in each lookup definitions, save the changes.

2.3.1.4.1 Setting Up the Lookup.iPlanet.Configuration Lookup Definition

You can specify values for the following entries in the Lookup.iPlanet.Configuration lookup definition:

Note:

It is recommended that you do not change Decode values of the remaining code Key entries.

  • TimeStampSearchFormat

    Use this parameter to specify the time-stamp format used by the target system to store time stamps of events related to user data changes. During reconciliation, the connector uses the time stamp value of each event to determine whether the user data change should be fetched into Oracle Identity Manager for reconciliation.

    Default value: yyyyMMddHHmmss'Z'

  • SpecialCharacters

    Use this parameter to specify the special characters that must not be allowed in the User ID and Common Name fields during reconciliation and provisioning operations.

    Default value: #%+,<>|/()

    Note:

    Do not use a separator when you add or remove special characters from the default list of special characters.

2.3.1.4.2 Setting Up the Lookup.IPNT.CommLang Lookup Definition

Table 2-4 shows the default entries in the Lookup.IPNT.CommLang lookup definition.

Table 2-4 Entries in the Lookup.IPNT.CommLang Lookup Definition

Code Key Decode

pt

BrazilianPortuguese

en

English

fr

French

de

German

it

Italian

ja

Japanese

ko

Korean

zh-CN

SimplifiedChinese

es

Spanish

zh-TW

TraditionalChinese


2.3.1.4.3 Setting Up the Lookup.iPlanet.Constants Lookup Definition

You can specify values for the following entries in the Lookup.iPlanet.Constants lookup definition:

  • TREE_DELETE_CONTROL_OID

    Use this parameter to specify the OID of the object whose deletion you want to enable for connector operations.

    Default value: 2.5.4.11 (this is the OID of organizational units)

  • LDAP_REFERRAL

    Use this parameter if there are multiple root contexts in your organization. You can specify one of the following values:

    • NONE: Specifies that the LDAP search must not use the LDAP_REFERRAL parameter.

    • follow: Specifies that the LDAP search must follow referrals automatically.

    • ignore: Specifies that the LDAP search must ignore referrals.

    • throw: Specifies that the LDAP search must throw the ReferralException exception when a referral is encountered.

    Default value: NONE

2.3.1.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.iPlanet.BackupServers 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.iPlanet.BackupServers 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.iPlanet.BackupServers 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.

See Also:

Oracle Identity Manager Design Console Guide for information about working with lookup definitions

Table 2-5 shows samples entries for the Lookup.iPlanet.BackupServers lookup definition.

Table 2-5 Samples Entries for the Lookup.iPlanet.BackupServers Lookup Definition

Code Key Decode

172.20.55.64

172.20.55.65

172.20.55.64

172.20.55.66

172.20.55.97

172.20.55.98


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.

2.3.1.6 Configuring Trusted Source Reconciliation

While configuring the connector, the target system can be designated as a trusted source or target resource. If you designate the target system as a trusted source, then during a reconciliation run:

  • For each newly created user on the target system, an OIM User is created.

  • Updates made to each user on the target system are propagated to the corresponding OIM User.

If you designate the target system as a target resource, then during a reconciliation run:

  • For each account created on the target system, a resource is assigned to the corresponding OIM User.

  • Updates made to each account on the target system are propagated to the corresponding resource.

Note:

Skip this section if you do not want to designate the target system as a trusted source for reconciliation.

Configuring trusted source reconciliation involves the following steps:

  1. Import the XML file for trusted source reconciliation, iPlanetXLResourceObject.xml, by using the Deployment Manager. This section describes the procedure to import the XML file.

    Note:

    Only one target system can be designated as a trusted source. If you import the iPlanetXLResourceObject.xml file while you have another trusted source configured, then both connector reconciliations would stop working.

  2. Set the TrustedSource scheduled task attribute to True. You specify a value for this attribute while configuring the user reconciliation scheduled task, which is described later in this guide.

To import the XML file for trusted source reconciliation:

  1. Open the Oracle Identity Manager Administrative and User Console.

  2. Depending on the version of Oracle Identity Manager, perform one of the following procedures:

    If you are using Oracle Identity Manager release 9.0.3.x or release 9.1.0.x, then:

    1. Click the Deployment Management link on the left navigation bar.

    2. Click the Import link under Deployment Management. A dialog box for opening files is displayed.

    If you are using Oracle Identity Manager release 11.1.1, then:

    1. On the Welcome page, click Advanced in the upper-right corner of the page.

    2. On the Welcome to Oracle Identity Manager Advanced Administration page, in the System Management region, click Import Deployment Manager File. A dialog box for opening files is displayed.

  3. Locate and open the iPlanetXLResourceObject.xml file located in the following directory:

    • For Oracle Identity Manager release 9.1.0.x:

      OIM_HOME/xellerate/ConnectorDefaultDirectory/CONN_HOME/xml

    • For Oracle Identity Manager release 11.1.1:

      OIM_HOME/server/xellerate/ConnectorDefaultDirectory/CONN_HOME/xml

    Details of this XML file are shown on the File Preview page.

    Note:

    If you open the Oracle Identity Manager Administrative and User Console on a remote computer, then you cannot select the XML file from the ConnectorDefaultDirectory directory on the Oracle Identity Manager host computer.

  4. Click Add File. The Substitutions page is displayed.

  5. Click Next. The Confirmation page is displayed.

  6. Click Import.

  7. In the message that is displayed, click Import to confirm that you want to import the XML file and then click OK.

After you import the XML file for trusted source reconciliation, you must set the value of the TrustedSource reconciliation scheduled task attribute to True. This procedure is described in Section 3.5, "Configuring Scheduled Tasks."

2.3.1.7 Configuring Oracle Identity Manager for Request-Based Provisioning

Note:

Perform the procedure described in this section only if you are using Oracle Identity Manager release 11.1.1 and you want to configure request-based provisioning.

In request-based provisioning, an end user creates a request for a resource by using the Administrative and User Console. Administrators or other users can also create requests for a particular user. Requests for a particular resource on the resource can be viewed and approved by approvers designated in Oracle Identity Manager.

The following are features of request-based provisioning:

  • A user can be provisioned only one resource (account) on the target system.

    Note:

    Direct provisioning allows the provisioning of multiple target system accounts on the target system.

  • Direct provisioning cannot be used if you enable request-based provisioning.

To configure request-based provisioning, perform the following procedures:

2.3.1.7.1 Importing Request Datasets Using Deployment Manager

Note:

A request dataset is an XML file that specifies the information to be submitted by the requester during a provisioning operation. These request datasets specify information about the default set of attributes for which the requester must submit information during a request-based provisioning operation.

To import a request dataset XML file by using the Deployment Manager:

  1. Log in to 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 request dataset XML file, SJSDSConnectorRequestDatasets.xml, which is in the xml directory of the installation media.

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

  8. Close the Deployment Manager dialog box.

    The request dataset is imported into Oracle Identity Manager.

2.3.1.7.2 Copying Predefined Request Dataset

Predefined request dataset XML files are shipped with the connector. The following dataset XML files are available in the DataSets directory on the installation media:

  • ModifyResourceiPlanet User.xml

  • ProvisionResourceiPlanet User.xml

Copy these dataset XML files from the installation media to any directory on the Oracle Identity Manager host computer. It is recommended that you create a directory structure as follows:

/custom/connector/RESOURCE_NAME

For example:

E:\MyDatasets\custom\connector\SJSDSStd

Note:

Until you complete the procedure to configure request-based provisioning, ensure that there are no other files or directories inside the parent directory in which you create the directory structure. In the preceding example, ensure that there are no other files or directories inside the E:\MyDatasets directory.

The directory structure to which you copy the dataset files is the MDS location into which these files are imported after you run the Oracle Identity Manager MDS Import utility. The procedure to import dataset files is described in the next section.

Depending on your requirement, you can modify the file names of the request datasets. In addition, you can modify the information in the request datasets. See Oracle Fusion Middleware Developer's Guide for Oracle Identity Manager for information on modifying request datasets.

2.3.1.7.3 Importing Request Datasets into MDS

You can configure request-based provisioning by importing the request datasets into into the metadata store (MDS) by using the Oracle Identity Manager MDS Import utility.

To import a request dataset definition into MDS:

  1. Ensure that you have set the environment for running the MDS Import utility. See Oracle Fusion Middleware Developer's Guide for Oracle Identity Manager for detailed information about setting up the environment for MDS utilities.

    Note:

    While setting up the properties in the weblogic.properties file, ensure that the value of the metadata_from_loc property is the parent directory of the /custom/connector/RESOURCE_NAME directory. For example, while performing the procedure in Section 2.3.1.7.2, "Copying Predefined Request Dataset," if you copy the files to the E:\MyDatasets\custom\connector\SJSDSStd directory, then set the value of the metada_from_loc property to E:\MyDatasets.

  2. In a command window, change to the OIM_HOME\server\bin directory.

  3. Run one of the following commands:

    • On Microsoft Windows

      weblogicImportMetadata.bat
      
    • On UNIX

      weblogicImportMetadata.sh
      
  4. When prompted, enter the following values:

    • Please enter your username [weblogic]

      Enter the username used to log in to the WebLogic server

      Sample value: WL_User

    • Please enter your password [weblogic]

      Enter the password used to log in to the WebLogic server.

    • Please enter your server URL [t3://localhost:7001]

      Enter the URL of the application server in the following format:

      t3://HOST_NAME_IP_ADDRESS:PORT

      In this format, replace:

      • HOST_NAME_IP_ADDRESS with the host name or IP address of the computer on which Oracle Identity Manager is installed.

      • PORT with the port on which Oracle Identity Manager is listening.

    The request dataset is imported into MDS.

2.3.1.7.4 Enabling the Auto Save Form Feature

To enable the Auto Save Form feature:

  1. Log in to the Design Console.

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

  3. Search for and open the iPlanet User process definition.

  4. Select the Auto Save Form check box.

  5. Click the Save icon.

2.3.1.7.5 Running the PurgeCache Utility

Run the PurgeCache utility to clear content belonging to the Metadata category from the server cache. See Section 2.3.1.2, "Clearing Content Related to Connector Resource Bundles from the Server Cache" for instructions.

The procedure to configure request-based provisioning ends with this step.

2.3.2 Configuring SSL

To enable SSL communication between Oracle Identity Manager and Sun Java System Directory, you must perform the following tasks:

  1. Section 2.3.2.1, "Creating the CA and SSL Certificates"

  2. Section 2.3.2.2, "Importing the CA and SSL Certificates into Sun Java System Directory"

  3. Section 2.3.2.3, "Importing the CA and SSL Certificates into Oracle Identity Manager"

  4. Section 2.3.2.4, "Enabling SSL Communication on Sun Java System Directory"

2.3.2.1 Creating the CA and SSL Certificates

Creating the CA and SSL certificates involves performing the following procedures:

2.3.2.1.1 Generating the Certificate Signing Request on Sun Java System Directory

To generate the certificate signing request:

  1. Export the certificate file on the target system as follows:

    1. Log in to the Sun One Server Console by using administrator credentials.

    2. Expand the host name folder.

    3. Expand Server Group.

    4. Select Directory Server, and then click Open on the right pane.

    5. On the Tasks tab, click Manage Certificates.

    6. When you are prompted for the Security Device password, specify the password.

      Note:

      You use this password again while importing the SSL certificate into Sun Java System Directory.

    7. On the Server Certs tab of the Manage Certificates dialog box, click Request.

    8. On the first page of the Certificate Request Wizard, ensure that Request Certificate Manually is selected and then click Next.

    9. On the Requestor Information page of the wizard, enter the required information and then click Next.

    10. On the Token Password page of the wizard, enter the security device password that you provided earlier and then click Next.

    11. On the Request Submission page of the wizard, click Save to file.

    12. In the Save dialog box, specify a location and name for the file and then click Save.

    13. On the Request Submission page of the wizard, click Done.

2.3.2.1.2 Using the Certificate Signing Request to Generate the CA and SSL Certificates

To generate CA and SSL certificates, follow the procedure defined by the certificate authority (CA) that you want to use. While performing that procedure, use the certificate signing request that you created earlier. Download and save the certificate (.cer) files to the Sun Java System Directory host computer.

2.3.2.2 Importing the CA and SSL Certificates into Sun Java System Directory

The following sections describe the procedure to import the CA and SSL certificates into Sun Java System Directory:

2.3.2.2.1 Importing the CA Certificate into Sun Java System Directory

To import the CA certificate to Sun Java System Directory:

  1. Log in to the Sun One Server Console by using administrator credentials.

  2. Expand the host name folder.

  3. Expand Server Group.

  4. Select Directory Server, and then click Open on the right pane.

  5. On the Tasks tab, click Manage Certificates.

  6. On the CA Certs tab of the Manage Certificates dialog box, click Install.

  7. On the Certificate Location page of the Certificate Install Wizard, use the Browse button to navigate to the CA certificate file that you saved on this computer. Then, click Next.

  8. On the Certificate Information page of the Certificate Install Wizard, click Next.

  9. On the Certificate Type page of the Certificate Install Wizard, click Next.

  10. On the Intended Purpose page of the Certificate Install Wizard, ensure that both check boxes are selected and then click Done.

2.3.2.2.2 Importing the SSL Certificate into Sun Java System Directory

To import the SSL certificate to Sun Java System Directory:

  1. Log in to the Sun One Server Console by using administrator credentials.

  2. Expand the host name folder.

  3. Expand Server Group.

  4. Select Directory Server, and then click Open on the right pane.

  5. On the Tasks tab, click Manage Certificates.

  6. On the Server Certs tab of the Manage Certificates dialog box, click Install.

  7. On the Certificate Location page of the Certificate Install Wizard, use the Browse button to navigate to the SSL certificate file that you saved on this computer. Then, click Next.

  8. On the Certificate Information page of the Certificate Install Wizard, click Next.

  9. On the Certificate Type page of the Certificate Install Wizard, click Next.

  10. On the Token Password of the Certificate Install Wizard, enter the security device password and then click Done.

2.3.2.3 Importing the CA and SSL Certificates into Oracle Identity Manager

To import the CA and SSL certificates into the certificate store of the Oracle Identity Manager host computer:

Note:

In an Oracle Identity Manager cluster, you must perform this procedure on each node of the cluster.

  1. Copy both certificate files to the Oracle Identity Manager host computer.

  2. Change to the directory where you copy the certificate files.

  3. For each certificate, enter a command similar to the following:

    keytool -import -alias ALIAS -file CER_FILE -keystore MY_CACERTS -storepass PASSWORD
    

    In this command:

    • ALIAS is the alias for the certificate (for example, the server name).

    • CER_FILE is the full path and name of the certificate (.cer) file.

    • MY_CACERTS is the full path and name of the certificate store.

      Table 2-6 shows the location of the certificate store for each of the supported application servers.

      Table 2-6 Certificate Store Locations

      Application Server Certificate Store Location

      Oracle WebLogic Server

      • If you are using Oracle jrockit_R27.3.1-jdk, then copy the certificate into the following directory:

        JROCKIT_HOME/jre/lib/security

      • If you are using the default Oracle WebLogic Server JDK, then copy the certificate into the following directory:

        WEBLOGIC_HOME/java/jre/lib/security/cacerts

      IBM WebSphere Application Server

      • For a noncluster configuration of any supported IBM WebSphere Application Server release, import the certificate into the following certificate store:

        WEBSPHERE_HOME/java/jre/lib/security/cacerts

      • For IBM WebSphere Application Server 6.1.x, in addition to the cacerts certificate store, you must import the certificate into the following certificate store:

        WEBSPHERE_HOME/AppServer/profiles/SERVER_NAME/config/cells/CELL_NAME/nodes/NODE_NAME/trust.p12

        For example:

        C:\Program Files\IBM\WebSphere\AppServer\profiles\AppSrv02\config\cells\wkslaurel3224Node02Cell\nodes\wkslaurel3224Node02\trust.p12 
        
      • For IBM WebSphere Application Server 5.1.x, in addition to the cacerts certificate store, you must import the certificate into the following certificate store:

        WEBSPHERE_HOME/etc/DummyServerTrustFile.jks

      JBoss Application Server

      JAVA_HOME/jre/lib/security/cacerts

      Oracle Application Server

      ORACLE_HOME/jdk/jre/lib/security/cacerts


  4. If you are using Oracle Identity Manager release 11.1.1, then import each certificate into the WebLogic keystore by running the following command:

    keytool -import -keystore WEBLOGIC_HOME/server/lib/DemoTrust.jks -file CERT_FILE_NAME -storepass PASSWORD
    

    In this command:

    • CERT_FILE_NAME is the full path and name of the certificate file.

    • PASSWORD is the password of the keystore.

    The following is a sample command:

    keytool -import -keystore WEBLOGIC_HOME/server/lib/DemoTrust.jks -file /home/testoc4j/OIM/globalv.crt -storepass DemoTrustKeyStorePassPhrase

  5. To confirm whether the certificate has been imported successfully, enter a command similar to the following:

    keytool -list -alias ALIAS -keystore MY_CACERTS -storepass PASSWORD
    

    For example:

    keytool -list -alias MyAlias -keystore C:\mydir\java\jre\lib\security\cacerts -storepass changeit
    
  6. For a noncluster configuration of IBM WebSphere Application Server, download the jsse.jar file from the Sun Web site and copy this file into the WEBSPHERE_HOME/java/jre/lib/ext directory.

  7. For a cluster configuration of IBM WebSphere Application Server, download the jnet.jar, jsse.jar, and jcert.jar files from the Sun Web site and copy these files into the WEBSPHERE_HOME/java/jre/lib/ext directory.

2.3.2.4 Enabling SSL Communication on Sun Java System Directory

To enable SSL communication on Sun Java System Directory:

  1. Log in to the Sun One Server Console by using administrator credentials.

  2. Expand the host name folder.

  3. Expand Server Group.

  4. Select Directory Server, and then click Open on the right pane.

  5. On the Configuration tab, select the Encryption tab.

  6. Select Enable SSL for this server.

  7. Select Use this cipher family RSA.

  8. Select Certificate, and then click Save.

  9. Restart Sun Java System Directory.

Determining the Port Number for SSL Communication with LDAP

To determine the port number for SSL communication with LDAP, perform the following steps:

  1. Log in to Sun Java System Directory.

  2. Click the Configuration tab, and then the Network tab.

The Secure Port number that is displayed is the SSL port number.

2.3.3 Configuring the Target System

Configuring the target system consists of the following procedure:

Enabling Retro Change Log Plug-in on the Target System

The retro change log is a plug-in that is used to maintain application compatibility with earlier versions of the Directory Server. The retro change log is stored under the suffix cn=changelog. When you enable the retro change log plug-in, updates to all suffixes on that server are logged by default.

To enable the Retro Change Log Plug-in on the Target System, perform one of the following procedures depending on the version of Sun Java System Directory:

If you are using Sun ONE Directory Server 5.2:

  1. Log in to the Sun One Server Console using administrator credentials.

  2. Expand the host name directory.

  3. Expand Server Group.

  4. Select Directory Server, and then click Open on the right pane.

  5. On the top-level Configuration tab on the Directory Server console, expand the Plugins node, and scroll down to select Retro Change Log plug-in.

  6. In the right panel, select the Enable Plug-in check box and click Save.

    Note:

    To disable the plug-in, clear the Enable plug-in check box.

  7. Restart the Directory Server after enabling the plug-in.

If you are using Sun Java System Directory Server Enterprise Edition 6.3:

  1. Log in to the Sun Java Web Console using administrator credentials.

  2. Select Directory Service Control Center (DSCC) and log in to access the Common Tasks tab.

  3. Click the Directory Servers tab.

  4. Click the server currently in use and ensure it is in the Started state.

  5. Click the Server Configuration tab, and then on the Plug-Ins sub-tab.

  6. Select the Retro Change Log check box and click Save.

See Also:

Sun Java System Directory Server Administration Guide for information about working with the Retro Change Log plug-in