17 Installing Predefined Connectors

You use a predefined connector to integrate Oracle Identity Manager with a specific third-party application. This chapter discusses the procedure to install predefined connectors.

Note:

The predefined connectors are distributed in the Oracle Identity Manager Connector Pack, independent from the Oracle Identity Manager core server release.

See the Oracle Identity Manager Connector Pack documentation to determine whether or not you can install the required release of the connector by using the Connector Installer feature of the Administrative and User Console.

This chapter is divided into the following sections:

• Overview of the Connector Installation Process

• Creating the User Account for Installing Connectors

• Installing a Predefined Connector

Overview of the Connector Installation Process

The installation of most predefined connectors requires you to perform some or all of the following tasks:

1. Verify the installation requirements.

2. Configure the target system.

3. Copy the connector files and external code files to directories on the Oracle Identity Manager server.

4. Configure the Oracle Identity Manager server.

5. Import the connector XML files.

6. Configure reconciliation.

7. Configure provisioning.

8. Configure Secure Sockets Layer (SSL).

Of these tasks, the Administrative and User Console can be used to perform the following:

• Copying the connector files and external code files to directories on the Oracle Identity Manager server

• Importing the connector XML files

• Compiling adapters (which is part of the procedure to configure provisioning)

Note:

You must manually perform the remaining tasks. For instructions on performing these tasks, see the connector-specific documentation in the Oracle Identity Manager Connector Pack documentation library.

Creating the User Account for Installing Connectors

All users belonging to the SYSTEM ADMINISTRATORS group of Oracle Identity Manager can install connectors. Alternatively, members of a group to which you assign the required menu items and permissions can install connectors.

See Also:

Chapter 10, "Creating and Managing User Groups" for information about creating groups and assigning menu items and permissions to them

The required permissions are the following:

• Form Designer (Allow Insert, Write Access, Delete Access)

• Structure Utility.Additional Column (Allow Insert, Write Access, Delete Access)

• Meta-Table Hierarchy (Allow Insert, Write Access, Delete Access)

The required menu item is Deployment Management Install Connector.

To install a connector, if you want to use a user account that does not belong to the SYSTEM ADMINISTRATORS group, then you must apply these permissions and menu item to one of the groups to which the user account belongs.

Installing a Predefined Connector

To install a predefined connector:

1. Log in to the Administrative and User Console by using the user account described in the "Creating the User Account for Installing Connectors" section.

2. Click Deployment Management, and then click Install Connector.

3. From the Connector List list, select the connector that you want to install. This list displays the names and release numbers of connectors whose installation files you copy into the default connector installation directory:

   OIM_HOME/xellerate/ConnectorDefaultDirectory 
   

   If you have copied the installation files into a different directory, then:

   1. In the Alternative Directory field, enter the full path and name of that directory.

   2. To repopulate the list of connectors in the Connector List list, click Refresh.

   3. From the Connector List list, select the connector that you want to install.

4. Click Load.

   Information about the following is displayed:

   • Connector installation history

     The connector installation history is information about previously installed releases of the same connector.

   • Connector dependency details

     There are some connectors that require the installation of some other connectors before you can start using them. For example, before you use the Novell GroupWise connector, you must install the Novell eDirectory connector. Novell eDirectory is called the dependency connector for Novell GroupWise.

     The connector dependency details include the list of connectors that must be installed before you install the selected connector. These details also include information about any dependency connectors that are already installed, and whether or not any of the installed dependency connectors must be upgraded.

     You must ensure that the correct versions of dependency connectors are installed before you proceed with the connector installation.

5. To start the installation process, click Continue.

   The following tasks are performed in sequence:

   1. Configuration of connector libraries

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

   3. Compilation of adapters

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

   • Retry the installation by clicking Retry.

   • Cancel the installation and begin again from Step 0.

   One of the reasons for installation failure could be a mismatch between information about files and directory paths in the configuration XML file and the actual files and directory paths. If this happens, then an error message is displayed.

   For example, suppose the actual name of the JAR file for reconciliation is recon.jar. If the name is provided as recon1.jar in the configuration XML file, then an error message is displayed.

   If such an error message is displayed, then perform any one of the following steps:

   • Make the change in the configuration XML file, and then retry installation from the Step 1: Select Connector to Install page onward.

     In the example described earlier, change the name of the JAR file to recon.jar in the configuration XML file, and then retry installation from the Step 1: Select Connector to Install page onward.

   • Make the change in the actual name or path of the file or directory, and then use the Retry option.

     In the example described earlier, change the name of the JAR file to recon1.jar and then click the Retry button.

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

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

      Note:

      At this stage, run the PurgeCache utility to load the server cache with content from the connector resource bundle in order to view the list of prerequisites. See Oracle Identity Manager Best Practices Guide for information about running the PurgeCache utility.

      There are no prerequisites for some predefined connectors.

   2. Creating an IT resource for the connector

      The IT resource type is displayed. You must create an IT resource of the specified type.

      See Also:

      The "Creating IT Resources" section

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

      The names of the scheduled tasks that are created during the XML file import process are displayed. You must configure these scheduled tasks.

      See Also:

      The "Managing Scheduled Tasks" section

   Note:

   You can also access links to the Administrative and User Console pages for creating the IT resource and configuring the scheduled tasks by expanding the Resource Management menu on the left navigation pane of the console.