Oracle® Identity Manager Connector Guide for Sun Java System Directory Release 9.0.4 Part Number E10446-04 |
|
|
View PDF |
After you deploy the connector, you must configure it to meet your requirements. This chapter discusses the following connector configuration procedures:
Note:
These sections provide both conceptual and procedural information about configuring the connector. It is recommended that you read the conceptual information before you perform the procedures.Adding New Multivalued Attributes for Target Resource Reconciliation
Configuring the Connector for Multiple Installations of the Target System
As mentioned earlier in this guide, reconciliation involves duplicating in Oracle Identity Manager the creation of and modifications to user accounts on the target system. This section discusses the following topics related to configuring reconciliation:
Note:
By default, the target system server has a limitation on the maximum number of users whose data can be reconciled. If you want to reconcile user data in bulk amounts exceeding the maximum limit allowed by the target system server, then perform the following:Open the Sun ONE Directory Server console.
Click the Configuration tab.
Select Performance on the left panel. On the Client Control tab, select the Unlimited check boxes for the Size limit and Look-through limit fields.
By default, all target system records that are added or modified after the last reconciliation run are reconciled during the current reconciliation run. You can customize this process by specifying the subset of added or modified target system records that must be reconciled. You do this by creating filters for the reconciliation module.
For this connector, you create a filter by specifying a value for the searchfilter
attribute while configuring the scheduled task for user reconciliation.
You can use the Sun Java System Directory attributes to build a query condition. You specify this query condition as the value of the searchfilter
attribute.
The following are sample query conditions that can be specified as the value of the searchfilter
attribute:
(&(objectClass=inetOrgPerson)(givenname=John))
(&(objectClass=inetOrgPerson)(sn=Doe))
(&(&(sn=Doe)(givenname=John))(objectClass=inetOrgPerson))
(|(|(sn=lastname)(givenname=firstname))(objectClass=inetOrgPerson))
Other target system attributes, such as cn
, uid
, and mail
, can also be used to build the query condition.
When you specify a value for the searchfilter
attribute, then only the records that meet both of the following criteria are reconciled:
Records that meet the matching criteria specified by the searchfilter
attribute
Records that are added or updated after the time-stamp value specified by the time-stamp IT resource parameter
Note:
As mentioned earlier in the guide, the value of the time-stamp IT resource parameter is automatically updated by Oracle Identity Manager. You must not change the value of this parameter.The following are guidelines to be followed while specifying a value for the searchfilter
attribute:
For the Sun Java System Directory attributes, you must use the same case (uppercase or lowercase) as given in the target system. This is because attribute names are case-sensitive.
You must not include unnecessary blank spaces between operators and values in the query condition.
A query condition with spaces separating values and operators would yield different results as compared to a query condition that does not contain spaces between values and operators.
You must not include special characters other than the equal sign (=), ampersand (&), vertical bar (|), and parentheses (()) in the query condition.
Note:
An exception is thrown if you include special characters other than the ones specified here.As mentioned earlier in this section, you specify a value for the searchfilter
attribute while configuring the scheduled task for user reconciliation.
During a reconciliation run, all changes in the target system records are reconciled into Oracle Identity Manager. Depending on the number of records to be reconciled, this process may require a large amount of time. In addition, if the connection breaks during reconciliation, then the process would take longer to complete.
You can configure batched reconciliation to avoid such problems.
To configure batched reconciliation, you use the BatchSize
user reconciliation scheduled task attribute. This attribute is used to specify the number of records that must be included in each batch fetched from the target system.
Note:
You must specify a numeric value for the BatchSize
attribute.
If you specify 0 as the value, then all records are fetched from the target system. In other words, batched reconciliation is not performed.
Caution:
For reconciliation of deleted users, you must accept the default value of0
. If you change this value, then records of existing users will be deleted from Oracle Identity Manager.You specify a value for the BatchSize
attribute while performing the procedure described in the "User Reconciliation Scheduled Task" section.
After you configure batched reconciliation, if reconciliation fails during a batched reconciliation run, then refer to the log file for information about the batch at which reconciliation has failed. The log file provides the following information about batched reconciliation:
Serial numbers of the batches that have been successfully reconciled
User IDs associated with the records with each batch that has been successfully reconciled
If the batched reconciliation run fails, then the serial number of the batch that has failed
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:
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 theiPlanetXLResourceObject.xml
file while you have another trusted source configured, then both connector reconciliations would stop working.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:
Open the Oracle Identity Manager Administrative and User Console.
Click the Deployment Management link on the left navigation bar.
Click the Import link under Deployment Management. A dialog box for opening files is displayed.
Locate and open the iPlanetXLResourceObject.xml
file, which is in the OIM_HOME
/xellerate/iPlanet
/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.
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 the "Configuring the Reconciliation Scheduled Tasks" section.
When you perform the procedure described in the "Importing the Connector XML File" section, the scheduled tasks for lookup fields and user reconciliations are automatically created in Oracle Identity Manager. To configure these scheduled tasks:
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 FAILED
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 configure both scheduled tasks, proceed to the "Configuring Provisioning of Users" section.
This section provides information about the attribute values to be specified for the following scheduled tasks:
The following scheduled tasks are used for lookup fields reconciliation:
iPlanet Organization Lookup Reconciliation
iPlanet Role Lookup Reconciliation
iPlanet Group Lookup Reconciliation
You must specify values for the attributes of these scheduled tasks. The following table describes these attributes:
Note:
Attribute values are predefined in the connector XML file that you import. Specify values only for those attributes that you want to change.
Values (either default or user-defined) must be assigned to all the attributes. If even a single attribute value were left empty, then reconciliation would not be performed.
After you specify values for these scheduled task attributes, proceed to Step 10 of the procedure to create scheduled tasks.
The following scheduled tasks are used for user reconciliation:
iPlanet User Trusted Recon Task
iPlanet User Target Recon Task
iPlanet Target Delete User Recon Task
iPlanet Trusted Delete User Recon Task
You must specify values for the attributes of these scheduled tasks. The following table describes these attributes:
Note:
Attribute values are predefined in the connector XML file that you import. Specify values only for those attributes that you want to change.
Values (either default or user-defined) must be assigned to all the attributes. If even a single attribute value were left empty, then reconciliation would not be performed.
Attribute | Description | Default/Sample Value |
---|---|---|
BatchSize |
This attribute is used for batched reconciliation. It specifies the number of records that must be included in each batch.
Caution: For reconciliation of deleted users, you must accept the default value of 0. If you change this value, then records of existing users will be deleted from Oracle Identity Manager. See Also: The "Batched Reconciliation" section |
Default value: 0 |
ConfigurationLookup |
Name of the lookup definition that stores configuration information used during connector operations
Do not change the default value. |
IPNT.Parameter |
ITResourceName |
Name of the IT resource for setting up a connection with Sun Java System Directory | iPlanet User |
Organization |
Name of the organization in Oracle Identity Manager to which you want to reconcile users
Note: This attribute is specific to the |
Xellerate Users |
Role |
Name of the role in Oracle Identity Manager that you want to assign to newly reconciled users
Note: This attribute is specific to the |
Consultant |
SearchBase |
DN in which the search for user accounts is rooted in
Note: For the iPlanet Target Delete User Recon Task and iPlanet Trusted Delete User Recon Task scheduled tasks, ensure that the value of this attribute is the root context. |
ou=myou,dc=corp,dc=com or dc=corp, dc=com |
SearchFilter |
LDAP search filter used to locate an organization accounts
See "Partial Reconciliation" for more information. |
(objectClass=inetOrgPerson) |
SearchScope |
Search scope used to locate user accounts
Note: For the |
subtree or onelevel |
TrustedResourceObjectName |
Name of the resource object for trusted source user reconciliation and deleted user reconciliation
Note: This attribute is specific to the |
Xellerate User |
TargetResourceObjectName |
Name of the resource object for target resource user reconciliation and deleted user reconciliation
Note: This attribute is specific to the |
iPlanet User |
After you specify values for these scheduled task attributes, proceed to Step 10 of the procedure to create scheduled tasks.
The following scheduled tasks are used for group and role reconciliation:
iPlanet Group Recon Task
iPlanet Role Recon Task
You must specify values for the attributes of these scheduled tasks. The following table describes these attributes:
Note:
Attribute values are predefined in the connector XML file that you import. Specify values only for those attributes that you want to change.
Values (either default or user-defined) must be assigned to all the attributes. If even a single attribute value were left empty, then reconciliation would not be performed.
Attribute | Description | Default/Sample Value |
---|---|---|
ConfigurationLookup |
Name of the lookup definition that stores configuration information used during connector operations
Do not change the default value. |
IPNT.Parameter |
Field Lookup Code |
Name of the lookup definition that stores reconciliation field mappings for group or role connector operations
Provide the corresponding reconciliation look up mappings |
Lookup.iPlanetRoleReconciliation.FieldMap
|
isRoleRecon |
Specifies if the recon is group or role reconciliation
If it is group recon it is |
Yes/No |
ITResourceName |
Name of the IT resource for setting up a connection with Sun Java System Directory | iPlanet User |
MultiValued Attributes |
Set of multivalued attributes are added here separated by the | operator
Example: <phones|pager> |
None |
ResourceObjectName |
Name of the resource object for reconciliation of Group or Role | iPlanet Role/iPlanet Group |
SearchBase |
DN in which the search for Group or Role is rooted in | ou=myou,dc=corp,dc=com or dc=corp, dc=com |
SearchFilter |
LDAP search filter used to locate Group or Role | (objectClass=groupOfUniqueNames)/ (objectClass=ldapsubentry) |
After you specify values for these scheduled task attributes, proceed to Step 10 of the procedure to create scheduled tasks.
Stopping Reconciliation
Suppose the User Reconciliation Scheduled Task for the connector is running and user records are being reconciled. If you want to stop the reconciliation process:
Perform Steps 1 through 4 of the procedure to configure reconciliation scheduled tasks.
Select the Stop Execution check box in the task scheduler.
Click Save.
As mentioned earlier in this guide, provisioning involves creating or modifying a user's account information on the target system through Oracle Identity Manager.
This section discusses the following topics related to configuring provisioning:
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.You need not perform the procedure to compile adapters if you have performed the procedure described in "Installing the Connector on Oracle Identity Manager Release 9.1.0 or Later".
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:
The "Supported Functionality" section for a listing of the provisioning functions that are available with this connectorUpdate 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:
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.
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 formsTo 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 section describes an optional procedure. You need not perform this procedure if you do not want to enable provisioning of users in organizations.In the AttrName.Prov.Map.iPlanet
lookup definition, the following are default settings for enabling provisioning of users in organizational units:
ldapOrgDNPrefix=ou
ldapOrgUnitObjectClass=OrganizationalUnit
If you want to enable the provisioning of users in organizations, then change these settings as follows:
See Also:
Oracle Identity Manager Design Console Guide for detailed information about modifying lookup definitionsldapOrgDNPrefix=o
ldapOrgUnitObjectClass=organization
To provision an organizational unit:
Log in to the Oracle Identity Manager Administrative and User Console.
Expand Organizations.
Click Create.
Specify a name and the type for the organization that you want to create, and then click Create Organization.
Select Resource Profile from the list.
Click Provision New Resource.
Select the organizational unit option.
Click Continue, and then click Continue again.
From the IT server lookup field, select the resource object corresponding to the required IT resource.
Click Continue, and then click Continue again on the Verification page.
To provision a group or role:
Log in to the Oracle Identity Manager Administrative and User Console.
Expand Organizations.
Click Manage.
Search for the organizational unit under which you want to provision the group or role.
Select Resource Profile from the list.
Click Provision New Resource.
On this page, the option that must select depends on what you want to create:
Select the group option if you want to create a group.
The default settings to enable provisioning of Groups in organizational units in the AtMap.iPlanetGroup lookup definition are listed in the following table:
Code Key | Decode |
---|---|
ldapGroupObjectClass | groupOfUniqueNames |
ldapGroupDNPrefix | cn |
Group Name | cn |
ldapGroupName | cn |
ldapOrgDNPrefix | ou |
ldapObjectClass | objectclass |
nsuniqueid | nsuniqueid |
Select the role option if you want to create a group.
The default settings to enable provisioning of Roles in organizational units in the AttrMap.iPlanetRole lookup definition are listed in the following table:
Code Key | Decode |
---|---|
ldapRoleObjectClass | ldapsubentry |
ldapRoleDNPrefix | cn |
Role Name | cn |
ldapRoleName | cn |
ldapOrgDNPrefix | ou |
ldapObjectClass | objectclass |
nsuniqueid | nsuniqueid |
Click Continue, and then click Continue again on the Verification page.
Enter a name for the group or role.
From the IT server lookup field, select the IT resource.
Click Continue, and then click Continue again on the Verification page.
By default, the attributes listed in the "Reconciled Resource Object Fields" section are mapped for reconciliation between Oracle Identity Manager and the target system. With this patch, if required, you can map additional attributes for reconciliation.
See Also:
Oracle Identity Manager Design Console for detailed instructions on performing the following procedureTo add a custom attribute for reconciliation:
While performing the procedure described in "Creating a Target System User Account for Connector Operations" section, you create an ACI for the user account. You must add the attribute to the ACI as follows:
Log in to the Sun One Server Console by using administrator credentials.
Expand the host name folder.
Expand Server Group.
Select Directory Server, and then click Open on the right pane.
On the Directory tab, right-click the root context.
From the shortcut menu, click Set Access Permissions.
In the Manage Access Control dialog box, select the name of the ACI that you create for the user account and then click Edit.
The ACI that you create for the user account is displayed.
Add the attribute to the list of attributes displayed in the ACI. Use two vertical bars as the delimiter.
In the following sample ACI, the passportnumber attroibute has been added to the ACI:
(targetattr = "passportnumber || 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 "OIMUserACI";allow (read,write,delete,add)(userdn = "ldap:/// uid=OIMAdmin, ou=Org1, dc=corp,dc=oracle,dc=com ");)
Click OK.
Determine the target system name for the attribute that you want to add as follows:
Log in to the target system.
On the Configuration tab of the user interface, click Schema.
Select the object class with which you want to perform reconciliation.
Search for the attribute that you want to add and record the name of the attribute. Later in this procedure, you enter this name while creating a lookup definition entry for the attribute.
Log in to the Oracle Identity Manager Design Console.
Add the new attribute on the process form as follows:
Open the Form Designer form.
Search for and open the UD_IPNT_USR form.
Create a new version of the form.
Add the new attribute on the form.
Save and close the form.
In the lookup definition for reconciliation, create an entry for the new attribute as follows:
Open the Lookup Definition form.
Search for and open the AttrName.Recon.Map.iPlanet lookup definition.
In the lookup definition, create an entry for the attribute that you want to add:
Code Key: Enter the name of the attribute that you add on the process form.
Decode Key: Enter the name of the attribute displayed on the target system, which you recorded earlier in this procedure.
In the lookup definition, add the custom object class (containing the attribute) to the existing value of the ldapUserObjectClass
attribute. For example, if the new attribute is in the accountdetails object class, then the value of the ldapUserObjectClass
attribute must be set to:
<inetorgperson|accountdetails>
In general, the format of the ldapUserObjectClass
attribute value must be as follows:
<inetorgperson|customObjectClass1|customObjectClass2| . . . customObjectClassn>
In the resource object, add a reconciliation field for the attribute as follows:
Open the Resource Objects form.
Search for the iPlanet User process.
On the Reconciliation Fields subtab of the Object Reconciliation tab, create an entry for the attribute.
In the process definition, create a reconciliation field mapping for the attribute as follows:
Open the Process Definition form.
Search for the iPlanet User process.
On the Reconciliation Field Mappings tab, create a reconciliation field mapping for the attribute.
By default, the attributes listed in the "Reconciled Resource Object Fields" section are mapped for reconciliation between Oracle Identity Manager and the target system. With this patch, if required, you can map additional attributes for reconciliation.
See Also:
Oracle Identity Manager Design Console for detailed instructions on performing the following procedureTo add a custom attribute for reconciliation:
While performing the procedure described in "Creating a Target System User Account for Connector Operations", you create an ACI for the user account. You must add the attribute to the ACI as follows:
Log in to the Sun One Server Console by using administrator credentials.
Expand the host name folder.
Expand Server Group.
Select Directory Server, and then click Open on the right pane.
On the Directory tab, right-click the root context.
From the shortcut menu, click Set Access Permissions.
In the Manage Access Control dialog box, select the name of the ACI that you create for the user account and then click Edit.
The ACI that you create for the user account is displayed.
Add the attribute to the list of attributes displayed in the ACI. Use two vertical bars as the delimiter.
In the following sample ACI, the passportnumber attroibute has been added to the ACI:
(targetattr = "passportnumber || 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 "OIMUserACI";allow (read,write,delete,add)(userdn = "ldap:/// uid=OIMAdmin, ou=Org1, dc=corp,dc=oracle,dc=com ");)
Click OK.
Determine the target system name for the attribute that you want to add as follows:
Log in to the target system.
On the Configuration tab of the user interface, click Schema.
Select the object class with which you want to perform reconciliation.
Search for the attribute that you want to add and record the name of the attribute. Later in this procedure, you enter this name while creating a lookup definition entry for the attribute.
Log in to the Oracle Identity Manager Design Console.
Add the new attribute on the process form as follows:
Open the Form Designer form.
Do one of the following:
Search for and open the UD_IPNT_GR form for Group Recon.
Search for and open the UD_IPNT_RL form for Role Recon.
Create a new version of the form.
Add the new attribute on the form.
Save and close the form.
In the lookup definition for reconciliation, create an entry for the new attribute as follows:
Open the Lookup Definition form.
Do one of the following:
Search for and open the Lookup.iPlanetGroupReconciliation.FieldMap lookup definition for Group Recon.
Search for and open the Lookup.iPlanetRoleReconciliation.FieldMap lookup definition for Role Recon.
In the lookup definition, create an entry for the attribute that you want to add:
Code Key: Enter the name of the attribute that you add on the process form.
Decode Key: Enter the name of the attribute displayed on the target system, which you recorded earlier in this procedure.
In the resource object, add a reconciliation field for the attribute as follows:
Open the Resource Objects form.
Do one of the following:
Search for the iPlanet Group process.
Search for the iPlanet Role process.
On the Reconciliation Fields subtab of the Object Reconciliation tab, create an entry for the attribute.
In the process definition, create a reconciliation field mapping for the attribute as follows:
Open the Process Definition form.
Do one of the following:
Search for the iPlanet Group process.
Search for the iPlanet Role process.
On the Reconciliation Field Mappings tab, create a reconciliation field mapping for the attribute.
Note:
You must ensure that new attributes you add for reconciliation contain only string-format data. Binary attributes must not be brought into Oracle Identity Manager natively.
If you want to add a multivalued attribute for target resource reconciliation, then see "Adding New Multivalued Attributes for Target Resource Reconciliation".
By default, the attributes listed in the "Reconciled Xellerate User (OIM User) Fields" section are mapped for reconciliation between Oracle Identity Manager and the target system. If required, you can add new attributes for trusted resource reconciliation.
To add a new attribute for trusted source reconciliation:
See Also:
Oracle Identity Manager Design Console Guide for detailed information about these stepsLog in to the Oracle Identity Manager Design Console.
Add the new attribute on the OIM User process form as follows:
Expand Development Tools.
Double-click Form Designer.
Search for and open the Users process form.
Click Add.
Enter the details of the attribute.
For example, if you are adding the Title attribute, then enter Employee ID
in the Name field, set the data type to String, enter Title
as the column name, and enter a field size value.
Click Save.
Add the new attribute to the list of reconciliation fields in the resource object as follows:
Expand Resource Management.
Double-click Resource Objects.
Search for and open the Xellerate User resource object.
On the Object Reconciliation tab, click Add Field.
Enter the details of the attribute.
For example, enter Title
in the Field Name field and select String from the Field Type list.
Later in this procedure, you will enter the attribute name as the Decode value of the entry that you create in the lookup definition for reconciliation.
Click Save.
Create a reconciliation field mapping for the new attribute in the process definition as follows:
Expand Process Management.
Double-click Process Definition.
Search for and open the Xellerate User process definition.
On the Reconciliation Field Mappings tab, click Add Field Map.
In the Field Name field, select the value for the attribute that you want to add.
For example, select Title = Title
.
Click Save.
Create an entry for the attribute in the lookup definition for reconciliation as follows:
Expand Administration.
Double-click Lookup Definition.
Search for and open the AttrName.Recon.Map.iPlanet lookup definition.
Click Add and enter the Code Key and Decode values for the attribute. The Code Key value must be the name of the attribute on the target system, which you determined at the start of this procedure. The Decode value is the name that you provide for the reconciliation field in Step 3.e.
For example, enter Title
in the Code Key field and then enter title
in the Decode field.
Click Save.
Select Field Type, and then click Save.
Note:
You must ensure that new attributes you add for reconciliation contain only string-format data. Binary attributes must not be brought into Oracle Identity Manager natively.By default, the multivalued attributes Role and Group are mapped for reconciliation between Oracle Identity Manager and the target system. If required, you can add new multivalued attributes for target resource reconciliation.
To add a new multivalued attribute for target resource reconciliation:
Log in to the Oracle Identity Manager Design Console.
Create a form for the multivalued attribute as follows:
Expand Development Tools.
Double-click Form Designer.
Create a form by specifying a table name and description, and then click Save.
Click Add and enter the details of the attribute.
Click Save and then click Make Version Active.
Add the form created for the multivalued attribute as a child form of the process form as follows:
Search for and open the UD_IPNT_USR process form.
Click Create New Version.
Click the Child Table(s) tab.
Click Assign.
In the Assign Child Tables dialog box, select the newly created child form, click the right arrow, and then click OK.
Click Save and then click Make Version Active.
Add the new attribute to the list of reconciliation fields in the resource object as follows:
Expand Resource Management.
Double-click Resource Objects.
Search for and open the IPlanet User resource object.
On the Object Reconciliation tab, click Add Field.
In the Add Reconciliation Fields dialog box, enter the details of the attribute.
For example, enter carLicense
in the Field Name field and select Multi Valued Attribute from the Field Type list.
Click Save and then close the dialog box.
Right-click the newly created attribute.
Select Define Property Fields.
In the Add Reconciliation Fields dialog box, enter the details of the newly created field.
For example, enter Mailing Address
in the Field Name field and select String from the Field Type list.
Click Save, and then close the dialog box.
Create a reconciliation field mapping for the new attribute as follows:
Expand Process Management.
Double-click Process Definition.
Search for and open the iPlanet User process definition.
On the Reconciliation Field Mappings tab of the iPlanet User
process definition, click Add Table Map.
In the Add Reconciliation Table Mapping dialog box, select the field name and table name from the list, click Save, and then close the dialog box.
Right-click the newly created field, and select Define Property Field Map.
In the Field Name field, select the value for the field that you want to add.
Double-click the Process Data Field field, and then select UD_ADDRESS.
Select Key Field for Reconciliation Field Matching and click Save.
Create an entry for the attribute in the lookup definition for reconciliation as follows:
Expand Administration.
Double-click Lookup Definition.
Search for and open the AttrName.Recon.Map.iPlanet lookup definition.
In the Decode column for the ldapMultiValAttr Code Key, enter the field name and code key separated by a semicolon. Field Name and Code Key pairs are separated by vertical bars.
For example, if Mailing Address
is the attribute name, then append the following to the entry in the Decode column of the ldapMultiValAttr Code Key:
|Mailing Address;Mailing Address
As shown in this example, the vertical bar is used to separate field name and Code Key pairs and a semicolon is used to separate the Field Name and Code Key.
Click Add, enter the Code Key and Decode values for the attribute, and then click Save. The Code Key value must be the name of the attribute on the process form. The Decode value must be the name of the attribute on the target system.
For example, enter PostalAddress
in the Code Key column and then enter postaladdress
in the Decode field.
By default, the attributes listed in the "Provisioning Module" section of the connector guide are mapped for provisioning between Oracle Identity Manager and the target system. With this patch, if required, you can map additional attributes for provisioning.
See Also:
Oracle Identity Manager Design Console for detailed instructions on performing the following procedureTo add a new attribute for provisioning:
While performing the procedure described in "Creating a Target System User Account for Connector Operations", you create an ACI for the user account. You must add the attribute to the ACI as follows:
Log in to the Sun One Server Console by using administrator credentials.
Expand the host name folder.
Expand Server Group.
Select Directory Server, and then click Open on the right pane.
On the Directory tab, right-click the root context in which created the user account for connector operations.
From the shortcut menu, click Set Access Permissions.
In the Manage Access Control dialog box, select the name of the ACI that you create for the user account and then click Edit.
The ACI that you create for the user account is displayed.
Add the attribute to the list of attributes displayed in the ACI. Use two vertical bars as the delimiter.
In the following sample ACI, the passportnumber attroibute has been added to the ACI:
(targetattr = "passportnumber || 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 "OIMUserACI";allow (read,write,delete,add)(userdn = "ldap:/// uid=OIMAdmin, ou=Org1, dc=corp,dc=oracle,dc=com ");)
Click OK.
Determine the target system name for the attribute that you want to add as follows:
Log in to the target system.
On the Configuration tab of the user interface, click Schema.
Select the object class on which you want to perform provisioning operations.
Search for the attribute that you want to add, and record the name of the attribute. Later in this procedure, you enter this name while creating a lookup definition entry for the attribute.
Log in to the Oracle Identity Manager Design Console.
Add the new attribute on the process form as follows:
Open the Form Designer form.
Search for and open the UD_IPNT_USR form.
Create a new version of the form.
Add the new attribute on the form.
Save and close the form.
In the lookup definition for provisioning, create an entry for the new attribute as follows:
Open the Lookup Definition form.
Search for and open the Attrname.Prov.Map.iPlanet lookup definition.
In the lookup definition, add an entry for the attribute that you want to add:
Code Key: Enter the name of the attribute that you add on the process form.
Decode Key: Enter the name of the attribute displayed on the target system, which you recorded earlier in this procedure.
In the lookup definition, add the custom object class (containing the attribute) to the existing value of the ldapUserObjectClass
attribute. For example, if the new attribute is in the accountdetails object class, then the value of the ldapUserObjectClass
attribute must be set to:
<inetorgperson|accountdetails>
In general, the format of the ldapUserObjectClass
attribute value must be as follows:
<inetorgperson|customObjectClass1|customObjectClass2| . . . customObjectClassn>
To test whether or not you can use the newly added attribute for provisioning, log in to the Oracle Identity Manager Administrative and User Console and perform a provisioning operation in which you specify a value for the newly added attribute.
Enabling Update of New Multivalued Attributes for Provisioning
After you add a multivalued attribute for provisioning, you must enable update operations on the attribute. If you do not perform this procedure, then you will not be able to modify the value of the attribute after you set a value for it during the Create User provisioning operation.
To enable the update of a new multivalued attribute for provisioning:
Log in to the Oracle Identity Manager Design Console.
Expand Process Management.
Double-click Process Definition and open the iPlanet User process definition.
In the process definition, add a task for setting a value for the attribute:
Click Add, enter the name of the task for adding multivalued attributes, and enter the task description.
In the Task Properties section, select the following fields:
Conditional
Required for Completion
Allow Cancellation while Pending
Allow Multiple Instances
Select the child table from the list.
For the example described earlier, select Mailing Address from the list.
Select Insert as the trigger type for adding multivalued data. Alternatively, select Delete as the trigger type for removing multivalues data.
On the Integration tab, click Add, and then click Adapter.
Select the adpIPLANETADDMULTIVALUEATTRIBUTE adapter, click Save, and then click OK in the message.
To map the adapter variables listed in this table, select the adapter, click Map, and then specify the data given in the following table:
Note:
Some of the values in this table are specific to the Mailing Address/Postal Address example. These values must be replaced with values relevant to the multivalued attributes that you require.Variable Name | Data Type | Map To | Qualifier | IT Asset Type | IT Asset Property |
---|---|---|---|---|---|
Adapter return value | Object | Response Code | NA | NA | NA |
AdminID | String | IT Resources | Server | LDAP Server | Admin Id |
AdminPwd | String | IT Resources | Server | LDAP Server | Admin Password |
processIntKey | String | Process Data | Process Instance | NA | NA |
rootContext | String | IT Resources | Server | LDAP Server | Root DN |
SSLFlag | String | IT Resources | Server | LDAP Server | SSL |
PropertyName | String | Literal | String | postaladdress
Note: This is a sample value. |
NA |
AttrLookupCode | String | IT Resources | Server | LDAP Server | Prov Attribute Lookup Code |
LDAPServer | String | IT Resources | Server | LDAP Server | Server Address |
Port | String | IT Resources | Server | LDAP Server | Port |
PropertyValue | String | Process Data and mailing address | Mailing address
Note: This is a sample value. |
NA | NA |
NsuniqueID | String | Process Data | NsuniqueID | NA | NA |
Click the Save icon and then close the dialog box.
In the process definition, add a task for removing the value of the attribute by performing Step 4. While performing Step 4.d, select the adpIPLANETREMOVEMULTIVALUEATTRIBUTE adapter.
By default, the attributes listed in the "Provisioning Module" section of the connector guide are mapped for provisioning between Oracle Identity Manager and the target system. With this patch, if required, you can map additional attributes for provisioning.
To add a new attribute for provisioning:
While performing the procedure described in "Creating a Target System User Account for Connector Operations", you create an ACI for the user account. You must add the attribute to the ACI as follows:
Log in to the Sun One Server Console by using administrator credentials.
Expand the host name folder.
Expand Server Group.
Select Directory Server, and then click Open on the right pane.
On the Directory tab, right-click the root context in which created the user account for connector operations.
From the shortcut menu, click Set Access Permissions.
In the Manage Access Control dialog box, select the name of the ACI that you create for the user account and then click Edit.
The ACI that you create for the user account is displayed.
Add the attribute to the list of attributes displayed in the ACI. Use two vertical bars as the delimiter.
In the following sample ACI, the passportnumber attroibute has been added to the ACI:
(targetattr = "passportnumber || 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 "OIMUserACI";allow (read,write,delete,add)(userdn = "ldap:/// uid=OIMAdmin, ou=Org1, dc=corp,dc=oracle,dc=com ");)
Click OK.
Determine the target system name for the attribute that you want to add as follows:
Log in to the target system.
On the Configuration tab of the user interface, click Schema.
Select the object class on which you want to perform provisioning operations.
Search for the attribute that you want to add, and record the name of the attribute. Later in this procedure, you enter this name while creating a lookup definition entry for the attribute.
Log in to the Oracle Identity Manager Design Console.
Add the new attribute on the process form as follows:
Open the Form Designer form.
Do one of the following:
Search for and open the UD_IPNT_GR form.
Search for and open the UD_IPNT_RL form.
Create a new version of the form.
Add the new attribute on the form.
Save the form.
Make the version active, and close the form.
In the lookup definition for provisioning, create an entry for the new attribute as follows:
Open the Lookup Definition form.
Do one of the following:
Search for and open the AtMap.iPlanetGroup lookup definition.
Search for and open the AttrMap.iPlanetRole lookup definition.
In the lookup definition, add an entry for the attribute that you want to add:
Code Key: Enter the name of the attribute that you add on the process form.
Decode Key: Enter the name of the attribute displayed on the target system, which you recorded earlier in this procedure.
To test whether or not you can use the newly added attribute for provisioning, log in to the Oracle Identity Manager Administrative and User Console and perform a provisioning operation in which you specify a value for the newly added attribute.
Enabling Update of New Attributes for Provisioning of Group or Role
After you add an attribute for provisioning Group or Role, you must enable update operations on the attribute. If you do not perform this procedure, then you will not be able to modify the value of the attribute after you set a value for it during the Create User provisioning operation.
To enable the update of a new multivalued attribute for provisioning:
Log in to the Oracle Identity Manager Design Console.
Expand Process Management.
Do one of the following:
Double-click Process Definition and open the iPlanet Group process definition.
Double-click Process Definition and open the iPlanet Role process definition.
In the process definition, add a task for setting a value for the attribute:
Click Add, enter the name of the task for adding multivalued attributes, and enter the task description.
In the Task Properties section, select the following fields:
Conditional
Required for Completion
Allow Cancellation while Pending
Allow Multiple Instances
Select the child table from the list.
For the example described earlier, select Mailing Address from the list.
On the Integration tab, click Add, and then click Adapter.
Do one of the following:
Select the adpUPDATEIPLANETGROUPATTRIBUTES adapter, click Save, and then click OK in the message.
Select the adpUPDATEIPLANETROLEATTRIBUTES adapter, click Save, and then click OK in the message.
To map the adapter variables listed in this table, select the adapter, click Map, and then specify the data given in the following table:
Variable Name | Data Type | Map To | Qualifier | IT Asset Type | IT Asset Property |
---|---|---|---|---|---|
Adapter return value | Object | Response Code | NA | NA | NA |
AdminID | String | IT Resources | Server | LDAP Server | Admin Id |
AdminPwd | String | IT Resources | Server | LDAP Server | Admin Password |
processIntKey | String | Process Data | Process Instance | NA | NA |
rootContext | String | IT Resources | Server | LDAP Server | Root DN |
SSLFlag | String | IT Resources | Server | LDAP Server | SSL |
PropertyName | String | Literal | String | postaladdress
Note: This is a sample value. |
NA |
AttrLookupCode | String | IT Resources | Server | LDAP Server | Prov Attribute Lookup Code |
LDAPServer | String | IT Resources | Server | LDAP Server | Server Address |
Port | String | IT Resources | Server | LDAP Server | Port |
PropertyValue | String | Process Data and mailing address | Mailing address
Note: This is a sample value. |
NA | NA |
NsuniqueID | String | Process Data | NsuniqueID | NA | NA |
Click the Save icon and then close the dialog box.
Enabling Update of New Multivalued Attributes for Provisioning of Group or Role
After you add a multivalued attribute for provisioning Group or Role, you must enable update operations on the attribute.
To update a new multivalued attribute for provisioning of Groups or Roles, perform the steps mentioned in "Adding New Attributes for Provisioning" section.
To add a new object class, perform the following procedures:
Note:
You must add the mandatory attributes of each object class that you add.Adding the Attributes of the Object Class to the Process Form
Adding the Object Class and its Attributes to the Lookup Definition for Provisioning
Adding the Attributes of the Object Class to the Resource Object
Adding the Object Class and its Attributes to the Lookup Definition for Reconciliation
Adding attributes of the Object Class to the Provisioning Process
While performing the procedure described in "Creating a Target System User Account for Connector Operations", you create an ACI for the user account. You must add the attribute to the ACI as follows:
Log in to the Sun One Server Console by using administrator credentials.
Expand the host name folder.
Expand Server Group.
Select Directory Server, and then click Open on the right pane.
On the Directory tab, right-click the root context in which you created the user account for connector operations.
From the shortcut menu, click Set Access Permissions.
In the Manage Access Control dialog box, select the name of the ACI that you create for the user account and then click Edit.
The ACI that you create for the user account is displayed.
Add the attribute to the list of attributes displayed in the ACI. Use two vertical bars as the delimiter.
In the following sample ACI, the passportnumber attroibute has been added to the ACI:
(targetattr = "passportnumber || 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 "OIMUserACI";allow (read,write,delete,add)(userdn = "ldap:/// uid=OIMAdmin, ou=Org1, dc=corp,dc=oracle,dc=com ");)
Click OK.
To add the attributes of the object class to the process form:
Open the Oracle Identity Manager Design Console.
Expand the Development Tools folder.
Double-click Form Designer.
Search for and open the UD_IPNT_USR process form.
Click Create New Version, and then click Add.
Enter the details of the attribute.
For example, if you are adding the Associated Domain attribute, enter UD_IPNT_USR_ASSOCIATEDDOMAIN
in the Name field and then enter the other details of this attribute.
Click Save, and then click Make Version Active.
To add the object class and its attributes to the lookup definition for provisioning:
Expand the Administration folder.
Double-click Lookup Definition.
Search for and open the AttrName.Prov.Map.iPlanet lookup definition.
Add the object class name to the Decode value of the ldapUserObjectClass Code Key.
Note:
In the Decode column, use the vertical bar (|) as a delimiter when you add the object class name to the existing list of object class names.For example, if you want to add MyObjectClass
in the Decode column then enter the value as follows:
inetorgperson|MyObjectClass
Click Add and then enter the Code Key and Decode values for an attribute of the object class. The Code Key value must be the name of the field on the process form and Decode value must be the name of the field on the target system.
For example, enter Associated Domain
in the Code Key field and then enter associatedDomain
in the Decode field.
Note:
You must perform this step for all the mandatory attributes of the object class. You can also perform this step for the optional attributes.Click Save.
To add the attributes of the object class to the resource object:
Note:
You must perform this step for all the mandatory attributes of the object class. You can also perform this step for the optional attributes.Expand the Resource Management folder.
Double-click Resource Objects.
Search for and open the iPlanet User resource object.
For each attribute of the object class:
On the Object Reconciliation tab, click Add Field.
Enter the details of the field.
For example, enter Associated Domain
in the Field Name field and select String from the Field Type list.
Click the save icon.
To add the object class and its attributes to the lookup definition for reconciliation, perform all the instructions given in the "Adding the Object Class and its Attributes to the Lookup Definition for Provisioning" section on the AttrName.Recon.Map.iPlanet lookup definition. In other words, while performing Step 3 of the "Adding the Object Class and its Attributes to the Lookup Definition for Provisioning" section, search for and open the AttrName.Recon.Map.iPlanet lookup definition instead of the AttrName.Prov.Map.iPlanet lookup definition.
While performing Step 5 of the "Adding the Object Class and its Attributes to the Lookup Definition for Provisioning" section, note that the Code Key value must be the name of the reconciliation field in the iPlanet User resource object and Decode value must be the name of the field on the target system. For example, enter Associated Domain
in the Code Key field and then enter associatedDomain
in the Decode field.
To add the attributes of the object class to the provisioning process:
Note:
You must perform this step for all the mandatory attributes of the object class. You can also perform this step for the optional attributes.Expand the Process Management folder.
Double-click Process Definition.
Search for and open the iPlanet User provisioning process.
On the Reconciliation Field Mappings tab, click Add Field Map.
In the Field Name field, select the value for the field that you want to add.
For example, select Associated Domain = UD_IPNT_USR_ASSOCIATEDDOMAIN
In the Field Type field, select the field type.
Click the save icon.
Note:
Perform this procedure only if you want to configure the connector for multiple installations of Sun Java System Directory.You may want to configure the connector for multiple installations of Sun Java System Directory. The following example illustrates this requirement:
The Tokyo, London, and New York offices of Example Multinational Inc. have their own installations of Sun Java System Directory. The company has recently installed Oracle Identity Manager, and they want to configure Oracle Identity Manager to link all the installations of Sun Java System Directory.
To meet the requirement posed by such a scenario, you must create and configure one IT resource for each installation of the target system.
The IT Resources form is in the Resource Management folder. The iPlanet User Resource
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.
See Also:
Oracle Identity Manager Design Console Guide for detailed instructionsWhen you use the Administrative and User Console to perform provisioning, you can specify the IT resource corresponding to the target system installation to which you want to provision the user.
Similarly, to reconcile data from a particular target system installation, specify the name of the IT resource for that target system installation as the value of the ITResource
scheduled task attribute.
Apply the following guidelines to while using the connector:
If you have configured Sun Java System Directory for target resource reconciliation, then while manually creating a user account in Sun Java System Directory through Oracle Identity Manager, you must ensure that the user ID in the process form is the same as the Oracle Identity Manager user login. Otherwise, reconciliation of the following operations would fail because these operations require direct API calls to update the information:
Enable status of user
Disable status of user
Organization update
The user search is based on the user ID only.
During provisioning, you cannot use non-English characters for the password of the user. This is because Sun Java System Directory does not support non-ASCII characters in the Password field.
During provisioning, you cannot use non-ASCII characters for the user ID or e-mail address of the user. This is because, by default, Sun Java System Directory does not permit the entry of non-ASCII characters in the User ID and E-mail fields. If you want to enable the entry of non-ASCII characters in these fields, then you must disable the 7-bit check plug-in as follows:
Open Sun ONE Directory Server.
Click the Configuration tab.
Expand Plugins.
Select 7-bit check.
Deselect the Enable plug-in check box.
Click Save.
Some Asian languages use multibyte character sets. Because the character limit for the fields in the target system is specified in bytes, the number of Asian-language characters that you can enter in a particular field is usually less than the number of English-language characters that you can enter in the same field. The following example illustrates this limitation:
Suppose you can enter 50 characters of English in the User Last Name field of the target system. If you have configured the target system for the Japanese language, then you would not be able to enter more than 25 characters in the same field.