6-12 Oracle Fusion Middleware Administrators Guide for Oracle Identity Manager
When you define a connector, a record representing the connector is created in the Oracle Identity Manager database. If this record already exists, then it updates:
■
The name of the connector. For example, Microsoft Active Directory.
■
The release number of the connector. For example, 9.1.1.
■
The connector XML definitions.
A connector is automatically defined when you install it using the Install Connectors feature or when you upgrade it using the Upgrade Connectors feature. Therefore, if
you install a connector and want to clone it without customizing the connector, then there is no need to define the connector.
You must manually define a connector if:
■
You import the connector by using the Deployment Manager.
■
You customize or reconfigure the connector.
■
You upgrade Oracle Identity Manager.
■
It is a custom connector that you develop.
Note: You must add only those Oracle Identity Manager artifacts
that are specific to the connector and do not add default objects or any other connector objects that are shared across connectors. The defined
XML is the source for life cycle operations such as upgrade, clone, and uninstall. If an object is used in define and is shared across connectors
or a default Oracle Identity Manager object, then there will be un-intended behavior. For example, a Lookup Definition which is
there by default in Oracle Identity Manager is added as a part of define, then clone operation will create another copy of the object,
which is not required. The uninstall will delete this default object from Oracle Identity Manager as it is defined specific to a connector. Such
incorrect definition will have impact on Oracle Identity Manager functionality. Therefore, you must be careful while adding an object
while defining a connector.
Note:
■
You can define the connector XML definitions in the form of an XML file. See the Exporting Connector Object Definitions in
Connector XML Format section of the connector guide for more information. You can then use this connector XML file to build the
installation package for installing the connector on a different Oracle Identity Manager installation.
■
Oracle recommends defining a connector immediately after customizing the connector or updating the DM XML file with the
customization changes.
Note: You can continue to use a connector without defining it after
you customize or reconfigure a connector or after you upgrade Oracle Identity Manager. However, if you want to upgrade, clone, or
uninstall the connector, then you must first define it.
Managing Connector Lifecycle 6-13
To define a connector:
1.
Log in to Oracle Identity Manager Administrative and User Console and click Advanced Administration
.
2. On the left pane, expand System Management, Deployment Management and
then click Manage Connector. 3.
On the Connector Management window, click Define. The Connector Management Wizard is displayed, as shown in
Figure 6–6 :
Figure 6–6 Connector Management Wizard for Defining Connectors
4. On the first page of the wizard, select either Resource or Process from the Search
list. In the adjoining field, you can enter a search string and the asterisk as a wildcard character to refine your search for resource objects or process definitions
belonging to the connector. Then, click Search.
Most of the objects that constitute a connector are linked to the resource objects and process definition of the connector. By selecting the resource objects or
process definition, you automatically select the objects linked with them. Some of the connector objects, for example, scheduled task, do not have dependency with
the resource object. Ensure that you search all the attributes and add them while defining.
When you click Search, the list of resource objects or process definitions that meet the specified search criteria are displayed.
5. Select the check boxes for the resource objects or process definitions that are part
of the connector.
Note: To determine whether you can define a particular release of a
connector by using the Oracle Identity Manager Administrative and User Console, see the documentation for that release of the connector.
6-14 Oracle Fusion Middleware Administrators Guide for Oracle Identity Manager
Figure 6–7 shows step 1 of the Connector Management Wizard with search results
for connector objects:
Figure 6–7 Step 1 of the Connector Management Wizard
6. Click Select Children.
7.
From the list of connector objects displayed, ensure that all the objects belonging to the connector are selected. Then, click Select Dependencies.
Figure 6–8 shows step 2 of the Connector Management Wizard:
Note: For an Oracle-released connector, the adapters that are part of
the connector are listed in the connector guide. Select the check boxes for those adapters.
Managing Connector Lifecycle 6-15
Figure 6–8 Step 2 of the Connector Management Wizard
8. After you review the list of objects that you have selected, click Confirmation.
Figure 6–9 shows step 3 of the Connector Management Wizard with the list of
selected connector objects:
6-16 Oracle Fusion Middleware Administrators Guide for Oracle Identity Manager
Figure 6–9 Step 3 of the Connector Management Wizard
9. Click Add For Define.
Figure 6–10 shows step 4 of the Connector Management Wizard:
Managing Connector Lifecycle 6-17
Figure 6–10 Step 4 of the Connector Management Wizard
10. To proceed, select any one of the following options, and click OK:
■
Add more Go to Step 1: Select this option if you want to go to step 1 of the
Connector Management Wizard and select more connector objects.
■
Exit wizard and show full selection: Select this option if you want to exit the
Connector Management Wizard and display the complete list of selected connector objects.
Figure 6–11 shows the page with the options to add more connector objects or to
exit the wizard:
6-18 Oracle Fusion Middleware Administrators Guide for Oracle Identity Manager
Figure 6–11 Options to Select More Objects or Exit
11. On the page that is displayed, only objects shown in the Current Selections list are
included in the connector definition. You can drag objects across lists. For example, you can drag an adapter from the Current Selections list to the
Unselected Children list. After you make the required changes, click Define.
Note:
Make sure that you have added all the Oracle Identity Manager connector objects specific to defining connector. If you do
not have a specific connector object while defining the connector, then upgrade, clone, or uninstall may not handle the undefined object.
The following are Oracle Identity Manager artifacts that are generally associated with almost all the connectors:
■
Resource objects
■
Event handlers
■
Process forms
■
IT resources
■
Data object definitions
■
Prepopulate adapters
■
Processes
■
IT resource type definitions
■
Task adapters
■
Lookups
■
Scheduled tasks
Managing Connector Lifecycle 6-19
Figure 6–12 shows the page with the complete list of selected connector objects
that are to be included in the connector definition and the unselected connector dependencies:
Figure 6–12 Selected Connector Objects
12. In the dialog box that is displayed, select one of the following options:
■
Select the name of the connector, and then enter a release number for it:
Select this option if an earlier release of this connector already exists on this Oracle Identity Manager installation. In addition, select a connector name and
enter a release number.
■
Enter a name and release number of the connector: Select this option if an
earlier release of this connector does not exist on this Oracle Identity Manager installation. In addition, enter a connector name and release number.
Figure 6–13 shows the dialog box to specify the connector name and release
number:
6-20 Oracle Fusion Middleware Administrators Guide for Oracle Identity Manager
Figure 6–13 Connector Name and Release Number
13. Click Define.
14. At the end of the process, a message stating that the operation was successful is
displayed. Click Close.
6.6 Cloning Connectors
This section describes the procedure to create a copy of a connector by setting new names for some of the objects that comprise the connector. The outcome of the process
is a new connector XML file. Most of the connector objects, such as Resource Object, Process Definition, Process Form, IT Resource Type Definition, IT Resource Instances,
Lookup Definitions, Adapters, Reconciliation Rules and so on in the new connector XML file have new names.
Note: In this guide, the term Clone Connectors feature refers to the
set of Oracle Identity Manager Administrative and User Console pages that you can use to clone connectors.
Managing Connector Lifecycle 6-21
This section contains the following topics:
■
Guidelines for Cloning a Connector
■
Cloning a Connector
■
Postcloning Steps
6.6.1 Guidelines for Cloning a Connector
Apply the following guidelines while using the Clone Connectors feature:
■
The Clone Connectors feature does not support request dataset cloning. This is because request dataset definitions are not usually included in the connector XML
file. Cloned copy of the connector is needed when there is a change in attributes of the same target but for different instances. If attributes are different, then the same
request dataset cannot be used.
■
A connector must be compatible with the Clone Connectors feature before you can use the utility to create a clone of the connector. For an Oracle-released connector,
see the connector guide for information about whether or not the connector is supported by the Clone Connectors feature.
■
Validation performed on the names of connector objects does not cover the names of objects that belong to other connectors. However, when you import the
connector XML file that is created by the Clone Connectors feature, the Deployment Manager throws an error when it encounters duplicate object names.
This is illustrated by the following example:
AD USER is the name of a resource object belonging to the Microsoft Active Directory connector. Suppose My_RO is the name of an existing resource object
defined in the Oracle Identity Manager database. If the new name that you specify for the AD_USER resource object is My_RO, then the Clone Connectors feature
does not display an error message stating that a resource object with the specified name already exists.
6.6.2 Cloning a Connector
Cloning a connector involves performing a two-step procedure:
■
Step 1: Create the connector XML file for the cloned connector
■
Step 2: Install the clone connector
Note: Oracle Identity Manager offers a different feature for using a
single connector to integrate:
■
Multiple installations of a particular target system with Oracle Identity Manager
■
A target system that stores data about multiple user types for example, employee and contractor and requires Oracle Identity
Manager to provide a different resource object for each user type
See the connector guide for information about how to use access policies to create resource objects for different user types on a
particular target system.
