3 Using the Connector

This chapter is divided into the following sections:

3.1 Guidelines on Using the Connector

This section discusses the following topics:

3.1.1 Guidelines on Configuring Reconciliation

The following are guidelines that you must apply while configuring reconciliation:

  • Before a target resource reconciliation run is performed, lookup definitions must be synchronized with the lookup fields of the target system. In other words, scheduled jobs for lookup field synchronization must be run before user reconciliation runs.

  • The scheduled job for user reconciliation must be run before the scheduled job for reconciliation of deleted user data.

  • There is no support for group entities in Oracle Identity Manager. Therefore, apply the following guidelines before you run the scheduled job for groups reconciliation:

  • For OUD target systems, the OUD changelog is based on the replication database. By default, the replication keeps changelog entries for only 100 hours. The replication purge delay must be tuned based on your specific requirements. The database size on disk will vary accordingly. For more information, see the changelog documentation for the OUD target system.

  • Reconciliation of roles is supported only for ODSEE and Novell eDirecotory target systems.

  • Run the User Search Reconciliation scheduled job, if only changes with regard to group membership are made to a user. This is because neither the changelog nor modifiedTimestamp attribute is updated. Therefore, performing full reconciliation by running the User Search Reconciliation scheduled job shoud reconcile such changes.

3.1.2 Guidelines on Performing Provisioning Operations

The following are guidelines that you must apply while performing provisioning operations:

  • Before you perform provisioning operations, lookup definitions must be synchronized with the lookup fields of the target system. In other words, scheduled tasks for lookup field synchronization must be run before provisioning operations.

  • If you want to provision a User, Group, Role, or an Organizational Unit directly under base context, then add a new entry in the Lookup.LDAP.Organization lookup definition with both the Code Key and the Decode values set to the base context name.

    For OID, use Lookup.OID.Organization and for eDirectory, use Lookup.EDIR.Organization.

    Sample value:

    Code Key: 281~dc=example,dc=com (where 281 is the IT resource key)

    Decode: LDAP_server~dc=example,dc=com (where LDAP_server is the IT resource name)

    Note:

    Provisioning in Non-Organization Containers for an eDirectory Target

    To provision an entity in a non-organization container, add that container value manually in the eDirectory container Lookup.EDIR.Organization lookup definition. For example:

    Code Key: 8~dc=home

    Decode Key: eDirectory~"randomvalue"

  • On the Oracle Internet Directory target system, the Manager Name field accepts only DN values. Therefore, when you set or modify the Manager Name field in Oracle Identity Manager, you must enter the DN value.

    For example: cn=abc,ou=lmn,dc=corp,dc=com

  • Provisioning of roles is supported only for ODSEE and Novell eDirecotory target systems.

3.2 Scheduled Jobs for Lookup Field Synchronization

Note:

The procedure to configure these scheduled jobs is described later in the guide.

The following are the scheduled jobs for lookup field synchronization for ODSEE:

  • LDAP Connector Group Lookup Reconciliation

    This scheduled job is used to synchronize group lookup fields in Oracle Identity Manager with group data in the target system.

  • LDAP Connector Role Lookup Recon

    This scheduled job is used to synchronize role lookup fields in Oracle Identity Manager with role data in the target system.

    Note:

    If you are using OUD as the Target System, then you must not run the LDAP Connector Role Lookup Recon scheduled job.

  • LDAP Connector OU Lookup Reconciliation

    This scheduled job is used to synchronize organization lookup fields in Oracle Identity Manager with organization data in the target system.

The following are the scheduled jobs for lookup field synchronization for Oracle Internet Directory:

  • OID Connector Group Lookup Reconciliation

    This scheduled job is used to synchronize group lookup fields in Oracle Identity Manager with group data in the target system.

  • OID Connector OU Lookup Reconciliation

    This scheduled job is used to synchronize organization lookup fields in Oracle Identity Manager with organization data in the target system.

The following are the scheduled jobs for lookup field synchronization for Novell eDirectory:

  • eDirectory Connector Group Lookup Reconciliation

    This scheduled job is used to synchronize group lookup fields in Oracle Identity Manager with group data in the target system.

  • eDirectory Connector Role Lookup Reconciliation

    This scheduled job is used to synchronize role lookup fields in Oracle Identity Manager with role data in the target system.

  • eDirectory Connector Org Lookup Reconciliation

    This scheduled job is used to synchronize organization lookup fields in Oracle Identity Manager with organization data in the target system.

  • eDirectory Connector Domain Scope Lookup Reconciliation

    This scheduled job is used to synchronize organization lookup fields in Oracle Identity Manager with organization data in the target system. These domains are associated with roles as trustee.

  • eDirectory Connector Profile Lookup Reconciliation

    This scheduled job is used to synchronize profile lookup fields in Oracle Identity Manager with profile data in the target system.

  • eDirectory Connector Role Container Lookup Reconciliation

    This scheduled job is used to synchronize Role Container lookup fields in Oracle Identity Manager with Role Containers on the target system. An eDirectory role can be provisioned only under a Role Container.

Table 3-1 describes the attributes of the scheduled jobs.

Table 3-1 Attributes of the Scheduled Jobs for Lookup Field Synchronization

Attribute Description

Code Key Attribute

Name of the connector or target system attribute that is used to populate the Code Key column of the lookup definition (specified as the value of the Lookup Name attribute).

Note: You must not change the value of this attribute.

Decode Attribute

Enter the name of the connector or target system attribute that is used to populate the Decode column of the lookup definition (specified as the value of the Lookup Name attribute).

Filter

Enter a filter to filter out records to be stored in the lookup definition.

For more information about the Filter attribute, see Section 3.3.2, "Limited Reconciliation."

IT Resource Name

Name of the IT resource for the target system installation from which you reconcile records.

Default values are:

  • ODSEE or OUD target resource: DSEE Server

  • OID target resource: OID Server

  • eDirectory target resource: eDirectory Server

Lookup Name

Enter the name of the lookup definition in Oracle Identity Manager that must be populated with values fetched from the target system.

Note: If the lookup name that you specify as the value of this attribute is not present in Oracle Identity Manager, then this lookup definition is created while the scheduled job is run.

Object Type

This attribute holds the name of the type of object you want to reconcile.


3.3 Configuring Reconciliation

When you run the Connector Installer, scheduled jobs for user reconciliation are automatically created in Oracle Identity Manager. Configuring reconciliation involves providing values for the attributes of these scheduled jobs.

The following sections provide information about the attributes of the scheduled jobs:

Note:

Consider this scenario. You provision a user to an organization (org1) and then move the user to a second organization (org2). You run Trusted Reconciliation and Target User Sync reconciliation. As result, two resources are attached to the user: revoked and provisioned.

This behavior is normal for the connector. After moving the user to org2, the target directory considers the user in org1 to be deleted (revoked) even though the user still exists in org1. However, in org2 the user also exists and is considered to be provisioned.

3.3.1 Full Reconciliation and Incremental Reconciliation

Full reconciliation involves reconciling all existing records from the target system into Oracle Identity Manager. After you deploy the connector, you must first perform full reconciliation. In addition, you can switch from incremental reconciliation to full reconciliation whenever you want to ensure that all target system records are reconciled in Oracle Identity Manager.

Full reconciliation: To perform a full reconciliation run, ensure that a value is not specified for the Filter and Latest Token attributes of the search reconciliation scheduled job for users, groups, or roles.

Incremental reconciliation: If the target system supports changelog, Sync reconciliation can be used for performing incremental reconciliation. To perform an incremental reconciliation run, specify a value for the Sync Token attribute in the sync reconciliation scheduled job for users, groups, or roles. From the next run onward, only records created or modified after the value in the Sync Token attribute are considered for reconciliation.

Incremental reconciliation can also be performed by filtered search based on the modifyTimestamp value. The timestamp value is updated in the search reconciliation scheduled task after full reconciliation. From the next run onward, the task runs in incremental reconciliation mode.

Note:

Sync reconciliation is not supported for eDirectory target systems.

3.3.2 Limited Reconciliation

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.

The following are the ways in which limited reconciliation can be achieved:

3.3.2.1 Limited Reconciliation By Using Filters

You can perform limited reconciliation by creating filters for the reconciliation module. This connector provides a Filter attribute (a scheduled task attribute) that allows you to use any of the OID resource attributes to filter the target system records.

For detailed information about ICF Filters, see the "ICF Filter Syntax" section of the Oracle Fusion Middleware Developer's Guide for Oracle Identity Manager.

While deploying the connector, follow the instructions in Section 3.4, "Configuring Scheduled Jobs" to specify attribute values.

3.3.2.2 Limited Reconciliation Based on Group Membership

Limited Reconciliation can be performed based on Group Membership. If you wish to reconcile only the users associated with a particular group, configure the filter as follows:

  • For ODSEE and OUD:

    In the Lookup.LDAP.Configuration lookup definition, set:

    • ldapGroupFilterBehavior=accept

    • ldapGroupMembershipAttribute=ismemberof

    Specify the filter as:

    containsAllValues('ldapGroups','cn=grp1,ou=groups,dc=example,dc=com')
    
  • For OID:

    In the Lookup.OID.Configuration lookup definition, set:

    • ldapGroupFilterBehavior=ignore

    • ldapGroupMembershipAttribute=ismemberof

    Specify the filter as:

    containsAllValues('ldapGroups','cn=grp1,ou=groups,dc=example,dc=com')
    

In these examples, grp1 is the group with which users are associated.

3.3.3 Reconciliation Scheduled Jobs

When you run the Connector Installer, the following reconciliation scheduled tasks are automatically created in Oracle Identity Manager:

3.3.3.1 Scheduled Jobs for Reconciliation of User Records

Depending on your target system, you must specify values for the attributes of the following user reconciliation scheduled jobs.

For ODSEE/OUD:

  • LDAP Connector User Search Reconciliation

  • LDAP Connector User Sync Reconciliation

  • LDAP Connector Trusted User Reconciliation

For OID:

  • OID Connector User Search Reconciliation

  • OID Connector User Sync Reconciliation

  • OID Connector Trusted User Reconciliation

For eDirectory:

  • eDirectory Connector User Search Reconciliation

  • eDirectory Connector Trusted User Reconciliation

The following sections describe the scheduled jobs and their attributes for ODSEE/OUD, which are similar for other target systems:

3.3.3.1.1 LDAP Connector User Search Reconciliation

This scheduled job is used to reconcile user data in the target resource (account management) mode of the connector. Use this scheduled job if either of the following conditions is true:

  • You want to perform Full or Incremental Reconciliation.

  • Your target system supports modifyTimestamp.

Note:

Run the User Search Reconciliation scheduled job, if only changes with regard to group membership are made to a user. This is because neither the changelog nor modifiedTimestamp attribute is updated. Therefore, performing full reconciliation by running the User Search Reconciliation scheduled job shoud reconcile such changes.

The same information has been listed in Section 3.1.1, "Guidelines on Configuring Reconciliation."

Table 3-2 describes the attributes of this scheduled job.

Table 3-2 Attributes of the LDAP Connector User Search Reconciliation Scheduled Job

Attribute Description

Filter

Expression for filtering records that must be reconciled by the scheduled job.

Sample value: startsWith('cn','Samrole1')

Default value: None

See Section 3.3.2, "Limited Reconciliation" for the syntax of this expression.

Incremental Recon Attribute

Enter the name of the target system attribute that holds the time stamp at which the last reconciliation run started.

The value in this attribute is used during incremental reconciliation to determine the newest or latest record reconciled from the target system.

Default value: modifyTimestamp

IT Resource Name

Name of the IT resource instance that the connector must use to reconcile data.

Values are:

  • ODSEE or OUD target resource: DSEE Server

  • OID target resource: OID Server

  • eDirectory target resource: eDirectory Server

Latest Token

This attribute holds the time stamp value of the Incremental Recon Attribute.

Note: The reconciliation engine automatically enters a value for this attribute after execution. It is recommended that you do not change the value of this attribute. If you manually specify a value for this attribute, then only user accounts that have been modified after the time stamp specified as the value of this attribute are reconciled.

If you want to perform a full reconciliation, clear the value in this field.

Sample value: <String>20120516115131Z</String>

Object Type

This attribute holds the type of object you want to reconcile.

Default value: User

Resource Object Name

Enter the name of the resource object against which reconciliation runs must be performed.

Default value: LDAP User

Can also be OID User or eDirectory User

Scheduled Task Name

This attribute holds the name of the scheduled task.

Default value: LDAP Connector User Search Reconciliation


3.3.3.1.2 LDAP Connector User Sync Reconciliation

This scheduled job is used to reconcile user data in the target resource (account management) mode of the connector. Use this scheduled job if either of the following conditions is true:

  • You want to perform incremental reconciliation.

  • Your target system supports the changelog attribute.

Table 3-2 describes the attributes of this scheduled job.

Table 3-3 Attributes of the LDAP Connector User Sync Reconciliation Scheduled Job

Attribute Description

IT Resource Name

Name of the IT resource instance that the connector must use to reconcile data.

Values are:

  • ODSEE or OUD target resource: DSEE Server

  • OID target resource: OID Server

  • eDirectory target resource: eDirectory Server

Object Type

This attribute holds the type of object you want to reconcile.

Default value: User

Resource Object Name

Enter the name of the resource object against which reconciliation runs must be performed.

Default value: LDAP User

Can also be OID User or eDirectory User

Scheduled Task Name

This attribute holds the name of the scheduled task.

Default value: LDAP Connector User Sync Reconciliation

Sync Token

You can manually enter the first Sync Token. To retrieve this token, query cn=changelog on rootDSE on the target system. Then, every time sync reconciliation is run, Sync Token is updated.

Browse the changelog attribute of the target system to determine a value from the changelog that must be used to resume a reconciliation run. From the next reconciliation run onward, only data about records that are created or modified since the last reconciliation run ended are fetched into Oracle Identity Manager.

Or, you can also leave this field blank, which causes the entire changelog to be read.

This attribute stores values in one of the following formats:

  • If you are using a target system for which the value of the standardChangelog entry in the Configuration lookup definition is set to true, then this attribute stores values in the following format:

    <Integer>VALUE</Integer>

    Sample value: <Integer>476</Integer>

  • If you are using a target system (for example, OUD) for which the value of the standardChangelog entry in the Configuration lookup definition is set to false, then this attribute stores values in the following format:

    <String>VALUE</String>

    Sample value: <String>dc=example,dc=com:0000013633e514427b6600000013;</String>


3.3.3.1.3 LDAP Connector Trusted User Reconciliation

This scheduled job is used to reconcile user data in the trusted resource (identity management) mode of the connector.

Table 3-4 describes the attributes of this scheduled job.

Table 3-4 Attributes of the Scheduled Job for Reconciliation of User Data from a Trusted Source

Attribute Description

Filter

Expression for filtering records that must be reconciled by the scheduled job.

Sample value: startsWith('cn','Samrole1')

Default value: None

See Section 3.3.2, "Limited Reconciliation" for the syntax of this expression.

IT Resource Name

Enter the name of the IT resource instance that the connector must use to reconcile data.

Values are:

  • ODSEE or OUD target resource: DSEE Server

  • OID target resource: OID Server

  • eDirectory target resource: eDirectory Server

Object Type

This attribute holds the type of object you want to reconcile.

Default value: User

Resource Object Name

Enter the name of the resource object against which reconciliation runs must be performed.

Default value: LDAP Trusted User

Can also be OID Trusted User or eDirectory User Trusted

Scheduled Task Name

This attribute holds the name of the scheduled task.

Default value: LDAP Connector Trusted User Reconciliation

Incremental Recon Attribute

Enter the name of the target system attribute that holds the time stamp at which the last reconciliation run started.

The value in this attribute is used during incremental reconciliation to determine the newest or latest record reconciled from the target system.

Default value: modifyTimestamp

Latest Token

This attribute holds the time stamp value of the Incremental Recon Attribute.

Note:

  • The reconciliation engine automatically enters a value for this attribute after execution. It is recommended that you do not change the value of this attribute. If you manually specify a value for this attribute, then only user accounts that have been modified after the time stamp specified as the value of this attribute are reconciled.

    If you want to perform a full reconciliation, clear the value in this field.

    Sample value: <String>20120516115131Z</String>

  • If you are using a connector that has been upgraded from release 9.0.4.x of the Sun Java System Directory connector, and you want to perform incremental reconciliation in trusted source mode, then:

    1. Note down the latest timestamp value from the legacy connector.

    2. Specify a value for the Latest Token attribute in the following format:

      <String>yyyyMMddHHmmssZ</String>

      Sample value: <String>20130517055840Z</String>


3.3.3.2 Scheduled Jobs for Reconciliation of Deleted User Records

Depending on whether you want to implement trusted source or target resource delete reconciliation, you must specify values for the attributes of one of the following scheduled jobs:

  • LDAP Connector User Search Delete Reconciliation, OID Connector User Search Delete Reconciliation, and eDirectory Connector User Search Reconciliation

    These scheduled jobs are used to reconcile data about deleted users in the target resource (account management) mode of the connector. During a reconciliation run, for each deleted user account on the target system, the target system resource is revoked for the corresponding OIM User.

  • LDAP Connector Trusted User Delete Reconciliation, OID Connector Trusted User Delete Reconciliation, and eDirectory Connector Trusted User Reconciliation

    These scheduled jobs are used to reconcile data about deleted users in the trusted source (identity management) mode of the connector. During a reconciliation run, for each deleted target system user account, the corresponding OIM User is deleted.

Table 3-5 describes the attributes of these scheduled jobs.

Table 3-5 Attributes of the Scheduled Jobs for Delete User Reconciliation

Attribute Description

IT Resource Name

Enter the name of the IT resource instance that the connector must use to reconcile data.

Note. For Trusted Delete Reconciliation, use the Trusted Configuration Lookup in the IT Resource.

The default value of this attribute in the LDAP Connector User Search Delete Reconciliation scheduled job is DSEE Server.

OID target resource: OID Server

eDirectory target resource: eDirectory Server

There is no default value for this attribute in the LDAP Connector Trusted User Delete Reconciliation scheduled job.

Object Type

This attribute holds the type of object you want to reconcile.

Default value: User

Resource Object Name

Enter the name of the resource object against which reconciliation runs must be performed.

Depending on the scheduled job you are using, the default values are as follows:

  • For LDAP Connector User Search Delete Reconciliation:

    LDAP User, OID User, or eDirectory User

  • For LDAP Connector Trusted User Delete Reconciliation:

    LDAP Trusted User, OID Trusted User, or eDirectory User Trusted


3.3.3.3 Scheduled Jobs for Reconciliation of Groups, OUs, and Roles

Depending on your target system, you must specify values for the attributes of the following scheduled jobs.

For ODSEE/OUD:

  • LDAP Connector Group Search Reconciliation

  • LDAP Connector Group Sync Reconciliation

  • LDAP Connector OU Search Reconciliation

  • LDAP Connector OU Sync Reconciliation

  • LDAP Connector Role Search Reconciliation

  • LDAP Connector Role Sync Reconciliation

For OID:

  • OID Connector Group Search Reconciliation

  • OID Connector Group Sync Reconciliation

  • OID Connector OU Search Reconciliation

  • OID Connector OU Sync Reconciliation

For eDirectory:

  • eDirectory Connector Group Search Reconciliation

  • eDirectory Connector Org Search Reconciliation

  • eDirectory Connector Role Search Reconciliation

The following sections describe the scheduled jobs and their attributes for ODSEE/OUD, which are similar for other target systems:

3.3.3.3.1 LDAP Connector Group Search Reconciliation, LDAP Connector OU Search Reconciliation, and LDAP Connector Role Search Reconciliation Scheduled Jobs

The LDAP Connector Group Search Reconciliation scheduled job is used to reconcile group data from the target system. Similarly, the LDAP Connector OU Search Reconciliation and LDAP Connector Role Search Reconciliation scheduled jobs are used to reconcile OU and role data from the target system. You must use these scheduled jobs if either of the following conditions is true:

  • Your target system does not contain a changelog attribute.

  • You want to reconcile into Oracle Identity Manager changes made to group, OU, or role memberships on the target system.

Table 3-6 describes the attributes of these scheduled jobs.

Table 3-6 Attributes of the LDAP Connector Group Search Reconciliation, LDAP Connector OU Search Reconciliation, and LDAP Connector Role Search Scheduled Jobs

Attribute Description

Filter

Expression for filtering records that must be reconciled by the scheduled job.

Sample value: startsWith('cn','Samrole1')

Default value: None

See Section 3.3.2, "Limited Reconciliation" for the syntax of this expression.

Incremental Recon Attribute

Enter the name of the target system attribute that holds the time stamp at which the last reconciliation run started.

The value in this attribute is used during incremental reconciliation to determine the newest or latest record reconciled from the target system.

The default value is the same for all Search Recon Tasks: modifyTimestamp

IT Resource Name

Enter the name of the IT resource for the target system installation from which you want to reconcile group or role data.

Values are:

  • ODSEE or OUD target resource: DSEE Server (default value)

  • OID target resource: OID Server

  • eDirectory target resource: eDirectory Server

Latest Token

This attribute holds the time stamp value of the Incremental Recon Attribute.

Note: The reconciliation engine automatically enters a value for this attribute after execution. It is recommended that you do not change the value of this attribute. If you manually specify a value for this attribute, then only user accounts that have been modified after the time stamp specified as the value of this attribute are reconciled.

If you want to perform a full reconciliation, clear the value in this field.

Sample value: <String>20120516115131Z</String>

Object Type

Type of object to be reconciled.

Depending on the scheduled job you are using, the default values are as follows:

  • For LDAP Connector Group Search Reconciliation

    Group

  • For LDAP Connector OU Search Reconciliation

    OU

  • For LDAP Connector Role Search Reconciliation

    Role

Resource Object Name

Name of the resource object that is used for reconciliation.

Depending on the scheduled job you are using, the default values are as follows:

  • For LDAP Connector Group Search Reconciliation

    LDAP Group

  • For LDAP Connector OU Search Reconciliation

    LDAP Organisation Unit

  • For LDAP Connector Role Search Reconciliation

    LDAP Role

Scheduled Task Name

Name of the scheduled task used for reconciliation.

Depending on the scheduled job you are using, the default values are as follows:

  • For LDAP Connector Group Search Reconciliation

    LDAP Connector Group Search Reconciliation

  • For LDAP Connector OU Search Reconciliation

    LDAP Connector OU Search Reconciliation

  • For LDAP Connector Role Search Reconciliation

    LDAP Connector Role Search Reconciliation


3.3.3.3.2 LDAP Connector Group Sync Reconciliation, LDAP Connector OU Sync Reconciliation, and LDAP Connector Role Sync Reconciliation Scheduled Jobs

The LDAP Connector Group Sync Reconciliation scheduled job is used to reconcile group data from the target system. Similarly, the LDAP Connector OU Sync Reconciliation, and LDAP Connector Role Sync Reconciliation scheduled job are used to reconcile OU and role data from the target system. You must use these scheduled jobs if your target system supports the changelog attribute.

Table 3-7 describes the attributes these scheduled jobs.

Table 3-7 Attributes of the LDAP Connector Group Sync Reconciliation, LDAP Connector OU Sync Reconciliation, and LDAP Connector Role Sync Reconciliation Scheduled Jobs

Attribute Description

IT Resource Name

Enter the name of the IT resource for the target system installation from which you want to reconcile group or role data. The values are:

  • For ODSEE or OUD target resource: DSEE Server

  • OID target resource: OID Server

Object Type

Type of object to be reconciled.

Depending on the scheduled job you are using, the default values are as follows:

  • For LDAP Connector Group Sync Reconciliation

    Group

  • For LDAP Connector OU Sync Reconciliation

    OU

  • For LDAP Connector Role Sync Reconciliation

    Role

Resource Object Name

Name of the resource object that is used for reconciliation.

Depending on the scheduled job you are using, the default values are as follows:

  • For LDAP Connector Group Sync Reconciliation

    LDAP Group

  • For LDAP Connector OU Sync Reconciliation

    LDAP Organization Unit

  • For LDAP Connector Role Sync Reconciliation

    LDAP Role

Scheduled Task Name

Name of the scheduled task used for reconciliation.

Depending on the scheduled job you are using, the default values are as follows:

  • For LDAP Connector Group Sync Reconciliation

    LDAP Connector Group Sync Reconciliation

  • For LDAP Connector OU Sync Reconciliation

    LDAP Connector OU Sync Reconciliation

  • For LDAP Connector Role Sync Reconciliation

    LDAP Connector Role Sync Reconciliation

Sync Token

You can manually enter the first Sync Token. To retrieve this token, query cn=changelog on rootDSE on the target system. Then, every time sync reconciliation is run, Sync Token is updated.

Browse the changelog attribute of the target system to determine a value from the changelog that must be used to resume a reconciliation run. From the next reconciliation run onward, only data about records that are created or modified since the last reconciliation run ended are fetched into Oracle Identity Manager.

Or, you can also leave this field blank, which causes the entire changelog to be read.

This attribute stores values in one of the following formats:

  • If you are using a target system for which the value of the standardChangelog entry in the Configuration lookup definition is set to true, then this attribute stores values in the following format:

    <Integer>VALUE</Integer>

    Sample value: <Integer>476</Integer>

  • If you are using a target system (for example, OUD) for which the value of the standardChangelog entry in the Configuration lookup definition is set to false, then this attribute stores values in the following format:

    <String>VALUE</String>

    Sample value: <String>dc=example,dc=com:0000013633e514427b6600000013;</String>


3.3.3.4 Scheduled Jobs for Reconciliation of Deleted Groups, OUs, and Roles

Depending on your target system, you must specify values for the attributes of the following scheduled jobs.

For ODSEE/OUD:

  • LDAP Connector Group Search Delete Reconciliation

  • LDAP Connector OU Search Delete Reconciliation

  • LDAP Connector Role Search Delete Reconciliation

For OID:

  • OID Connector Group Search Delete Reconciliation

  • OID Connector OU Search Delete Reconciliation

For eDirectory:

  • eDirectory Connector Group Search Delete Reconciliation

  • eDirectory Connector Org Search Delete Reconciliation

  • eDirectory Connector Role Search Delete Reconciliation

Table 3-8 describes the attributes of these scheduled jobs.

Table 3-8 Attributes of the Scheduled Jobs for Deleted Groups, Organizational Units, and Roles Reconciliation

Attribute Description

IT Resource Name

Name of the IT resource instance that the connector must use to reconcile data.

Default values are:

  • ODSEE or OUD target resource: DSEE Server

  • OID target resource: OID Server

  • eDirectory target resource: eDirectory Server

Object Type

This attribute holds the type of object you want to reconcile.

Resource Object Name

Enter the name of the resource object against which reconciliation runs must be performed.


3.4 Configuring Scheduled Jobs

This section describes the procedure to configure scheduled jobs. You can apply this procedure to configure the scheduled jobs for lookup field synchronization and reconciliation. For a list of scheduled jobs and their attributes, see Section 3.2, "Scheduled Jobs for Lookup Field Synchronization" and Section 3.3.3, "Reconciliation Scheduled Jobs."

This section also includes Section 3.4.1, "Configuring the Search Base and Search Scope in Scheduled Jobs and Tasks."

Note:

If the changelog attribute is configured, use the Sync Reconciliation task for incremental reconciliation and the Search for full and delete reconciliation.

if changelog is not configured and the modifytimestamp attribute is used, use the Search Reconciliation task for incremental, full, and delete reconciliation.

To configure a scheduled job:

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

    • For Oracle Identity Manager release 11.1.1.x:

      1. Log in to the Administrative and User Console.

      2. On the Welcome to Oracle Identity Manager Self Service page, click Advanced in the upper-right corner of the page.

      3. On the Welcome to Oracle Identity Manager Advanced Administration page, in the System Management region, click Search Scheduled Jobs.

    • For Oracle Identity Manager release 11.1.2.x:

      1. Log in to Oracle Identity System Administration.

      2. In the left pane, under System Management, click Scheduler.

  2. Search for and open the scheduled task as follows:

    1. On the left pane, in the Search field, enter the name of the scheduled job as the search criterion. Alternatively, you can click Advanced Search and specify the search criterion.

    2. In the search results table on the left pane, click the scheduled job in the Job Name column.

  3. On the Job Details tab, you can modify the parameters of the scheduled task:

    • Retries: Enter an integer value in this field. This number represents the number of times the scheduler tries to start the job before assigning the Stopped status to the job.

    • Schedule Type: Depending on the frequency at which you want the job to run, select the appropriate schedule type.

    Note:

    See the Oracle Fusion Middleware Administrator's Guide for Oracle Identity Manager for detailed information about schedule types.

    In addition to modifying the job details, you can enable or disable a job.

  4. On the Job Details tab, in the Parameters region, specify values for the attributes of the scheduled task.

    Note:

    • Attribute values are predefined in the connector XML file that you import. Specify values only for those attributes that you want to change.

    • Values (either default or user-defined) must be assigned to all the attributes. If even a single attribute value is left empty, then reconciliation is not performed.

    • The search base and search scope fields are not available in User, Group, Role, or Organizational Unit Lookup Reconciliation scheduled tasks. To add these fields, see Section 3.4.1, "Configuring the Search Base and Search Scope in Scheduled Jobs and Tasks."

  5. Click Apply to save the changes.

    Note:

    The Stop Execution option is available in the Administrative and User Console. You can use the Scheduler Status page to either start, stop, or reinitialize the scheduler.

3.4.1 Configuring the Search Base and Search Scope in Scheduled Jobs and Tasks

To configure the search base and search scope, first export the desired scheduled job and task:

  1. Go to Advanced - Export Deployment Manager File.

  2. Choose Job and search for the scheduled job you want to use.

  3. Click Select Children.

  4. Click Select Dependencies.

  5. Pick the Scheduled Task (the root of the tree shown).

  6. Click Confirmation.

  7. Click Add For Export.

  8. Choose Exit Wizard and show full selection and then click OK.

  9. Click Export,and enter a description, if needed, and then click Export again.

  10. Choose the file you want to use and click Save.

Add additional parameters to the job and task:

  1. Rename the scheduled task, so that other jobs are not affected by this change:

    1. Look for the scheduledTask xml element, and find the xml attribute name. For example:

      <scheduledTask repo-type="MDS" 
      name="LDAP Connector Search Incremental Reconciliation" 
      mds-path="/db" mds-file="LDAP Connector Search Incremental Reconciliation.xml">
      
    2. Replace all the occurrences of the old name with a new value.

      For example, replace all occurrences of "LDAP Connector Search Incremental Reconciliation" with "LDAP Connector Search Incremental Reconciliation Extended".

  2. Rename the scheduled job:

    Look for the Job element.

    Change the value of the name xml attribute. For example, change "LDAP Connector OU Search Reconciliation" to "LDAP Connector OU Search Reconciliation Extended".

  3. Add additional parameters to the scheduled task:

    1. Find the scheduledTask/completeXml/scheduledTasks/task/parameters element.

    2. Add the following parameters:

      <string-param required="false" encrypted="false" helpText="Search Scope">SCOPE</string-param>
      <string-param required="false" encrypted="false" helpText="Search Base">Base Context</string-param>
      
  4. Add additional parameters to the scheduled job:

    1. Find the Job/attributes element.

    2. Add the following parameters:

      <object>
      <key>SCOPE</key>
      <value type="jobparameter">
      <name type="string">SCOPE</name>
      <required type="boolean">false</required>
      <encrypted type="boolean">false</encrypted>
      <helpText type="string">Search Scope</helpText>
      <dataType type="string">String</dataType>
      <paramKey type="string">30</paramKey>
      <paramValue type="string"/>
      </value>
      </object>
      <object>
      <key>Base Context</key>
      <value type="jobparameter">
      <name type="string">Base Context</name>
      <required type="boolean">false</required>
      <encrypted type="boolean">false</encrypted>
      <helpText type="string">Search Base</helpText>
      <dataType type="string">String</dataType>
      <paramKey type="string">31</paramKey>
      <paramValue type="string"/>
      </value>
      </object>
      

Finally, import the updated xml back into Oracle Identity Manager:

  1. Go to Advanced - Import Deployment Manager File.

  2. Choose the updated xml file and click Open.

  3. Click Add File.

  4. Click Import.

3.5 Performing Provisioning Operations in Oracle Identity Manager Release 11.1.1.x

Provisioning a resource for an OIM User involves using Oracle Identity Manager to create target system account for the user.

When you install the connector on Oracle Identity Manager, the direct provisioning feature is automatically enabled. This means that the process form is enabled when you install the connector.

If you configure the connector for request-based provisioning, then the process form is suppressed and the object form is displayed. In other words, direct provisioning is disabled when you configure the connector for request-based provisioning. If you want to revert to direct provisioning, then perform the steps described in Section 3.5.4, "Switching Between Request-Based Provisioning and Direct Provisioning."

The following are types of provisioning operations:

  • Direct provisioning

  • Request-based provisioning

See Also:

Oracle Fusion Middleware User's Guide for Oracle Identity Manager for information about the types of provisioning.

This section discusses the following topics:

3.5.1 Direct Provisioning

Note:

This example is for an LDAPv3 target system. However, to provision another target system such as eDirectory or OID, the steps are similar.

To provision a resource by using the direct provisioning approach:

  1. Log in to the Administrative and User Console.

  2. If you want to first create an OIM User and then provision a target system account, then:

    1. On the Welcome to Identity Administration page, in the Users region, click Create User.

    2. On the user details page, enter values for the OIM User fields, and then click Save. Figure 3-1 shows this page.

      Figure 3-1 User Details Page

      Description of Figure 3-1 follows
      Description of "Figure 3-1 User Details Page"

  3. If you want to provision a target system account to an existing OIM User, then:

    1. On the Welcome to Identity Administration page, search for the OIM User by selecting Users from the list on the left pane.

    2. From the list of users displayed in the search results, select the OIM User. The user details page is displayed on the right pane.

  4. On the user details page, click the Resources tab.

  5. From the Action menu, select Add Resource. Alternatively, you can click the add resource icon with the plus (+) sign. The Provision Resource to User page is displayed in a new window.

  6. On the Step 1: Select a Resource page, select LDAP User resources from the list and then click Continue.

    Figure 3-2 shows the Step 1: Select a Resource page.

    Figure 3-2 Step 1: Select a Resource Page

    Description of Figure 3-2 follows
    Description of "Figure 3-2 Step 1: Select a Resource Page"

  7. On the Step 2: Verify Resource Selection page, click Continue.

    Figure 3-3 shows the Step 2: Verify Resource Selection page.

    Figure 3-3 Step 2: Verify Resource Selection Page

    Description of Figure 3-3 follows
    Description of "Figure 3-3 Step 2: Verify Resource Selection Page"

  8. On the Step 5: Provide Process Data for LDAP User Form page, enter the details of the account that you want to create on the target system and then click Continue. Figure 3-4 shows the user details added.

    Figure 3-4 Step 5: Provide Process Data for LDAP User Form Page

    Description of Figure 3-4 follows
    Description of "Figure 3-4 Step 5: Provide Process Data for LDAP User Form Page"

  9. If required, on the Step 5: Provide Process Data for LDAP User Group page, search for and select a group for the user on the target system and then click Continue. Figure 3-5 shows this page.

    Figure 3-5 Step 5: Provide Process Data for LDAP User Group Page

    Description of Figure 3-5 follows
    Description of "Figure 3-5 Step 5: Provide Process Data for LDAP User Group Page"

  10. If required, On the Step 5: Provide Process Data for LDAP User Role page, search for and select role, and then click Continue. Figure 3-6 shows this page.

    Figure 3-6 Step 5: Provide Process Data for LDAP User Role Page

    Description of Figure 3-6 follows
    Description of "Figure 3-6 Step 5: Provide Process Data for LDAP User Role Page"

  11. On the Step 6: Verify Process Data page, verify the data that you have provided and then click Continue. Figure 3-7 shows Step 6: Verify Process Data page.

    Figure 3-7 Step 6: Verify Process Data Page

    Description of Figure 3-7 follows
    Description of "Figure 3-7 Step 6: Verify Process Data Page"

  12. Close the window displaying the "Provisioning has been initiated" message.

  13. On the Resources tab, click Refresh to view the newly provisioned resource.

3.5.2 Direct Provisioning for Groups, Roles, and Organizations

Note:

This example is for an LDAPv3 target system. However, to provision another target system such as eDirectory or OID, the steps are similar.

Groups, Roles, and Organizations of directory can be provisioned to OIM organizations. To provision a resource by using the direct provisioning approach:

  1. Log in to the Administrative and User Console.

  2. If you want to first create an OIM Organization and then provision a target system account, then:

    1. On the Welcome to Identity Administration page, in the Organizations region, click Create Organization.

    2. On the organization details page, enter values for the OIM Organization fields, and then click Save.

  3. If you want to provision a target system account to an existing OIM Organization, then:

    1. On the Welcome to Identity Administration page, search for the OIM Organization by selecting Organizations from the list on the left pane.

    2. From the list of users displayed in the search results, select the OIM Organization. The user details page is displayed on the right pane.

  4. On the user details page, click the Resources tab.

  5. From the Action menu, select Provision. Alternatively, you can click the add resource icon with the plus (+) sign. The Provision Resource to Organization page is displayed in a new window.

  6. On the Step 1: Select a Resource page, select LDAP Group resources from the list and then click Continue.

    Note:

    If you want to provision Role or Organizational Unit, then select LDAP Role or LDAP Organisation Unit respectively.

  7. On the Step 2: Verify Resource Selection page, click Continue.

  8. On the Step 5: Provide Process Data for LDAP Group Form page, enter the details of the account that you want to create on the target system and then click Continue.

  9. On the Step 6: Verify Process Data page, verify the data that you have provided and then click Continue.

  10. Close the window displaying the "Provisioning has been initiated" message.

  11. On the Resources tab, click Refresh to view the newly provisioned resource.

Note:

OIM created Organizations do not relate to the OU objects on the Directory Resources of OID or Microsoft Active Directory. The OIM connector does not support the creation of any OU objects in OIM which can then be provisioned to OID or Microsoft Active Directory. Instead, OUs can be created directly on the Directory Services of OID or Microsoft Active Directory.

Additionally, as best practice, ensure that all newly created OUs and other objects are imported through Trusted Resource Reconciliation from OID or Microsoft Active Directory into OIM.

3.5.3 Request-Based Provisioning

A request-based provisioning operation involves both end users and approvers. Typically, these approvers are in the management chain of the requesters. The following sections discuss the steps to be performed by end users and approvers during a request-based provisioning operation:

Note:

The procedures described in these sections are built on an example in which the end user raises or creates a request for provisioning a target system account. This request is then approved by the approver.

3.5.3.1 End User's Role in Request-Based Provisioning

The following steps are performed by the end user in a request-based provisioning operation:

See Also:

Oracle Fusion Middleware User's Guide for Oracle Identity Manager for detailed information about these steps

  1. Log in to the Administrative and User Console.

  2. On the Welcome page, click Advanced on the top right corner of the page.

  3. On the Welcome to Identity Manager Advanced Administration page, click Requests on the Administration tab.

  4. From the Actions menu on the left pane, select Create Request.

    The Select Request Template page is displayed.

  5. From the Request Template list, select Provision Resource and click Next.

  6. On the Select Users page, specify a search criterion in the fields to search for the user that you want to provision the resource, and then click Search. A list of users that match the search criterion you specify is displayed in the Available Users list.

  7. From the Available Users list, select the user to whom you want to provision the account.

    If you want to create a provisioning request for more than one user, then from the Available Users list, select users to whom you want to provision the account.

  8. Click Move or Move All to include your selection in the Selected Users list, and then click Next.

  9. On the Select Resources page, click the arrow button next to the Resource Name field to display the list of all available resources.

  10. From the Available Resources list, select the following, move it to the Selected Resources list, and then click Next:

    For target resource configuration: LDAP User

  11. On the Resource Details page, enter details of the account that must be created on the target system, and then click Next.

  12. On the Justification page, you can specify values for the following fields, and then click Finish.

    • Effective Date

    • Justification

    A message confirming that your request has been sent successfully is displayed along with the Request ID.

  13. If you click the request ID, then the Request Details page is displayed.

  14. To view details of the approval, on the Request Details page, click the Request History tab.

3.5.3.2 Approver's Role in Request-Based Provisioning

The following are steps performed by the approver in a request-based provisioning operation:

The following are steps that the approver can perform:

  1. Log in to the Administrative and User Console.

  2. On the Welcome page, click Self-Service in the upper-right corner of the page.

  3. On the Welcome to Identity Manager Self Service page, click the Tasks tab.

  4. On the Approvals tab, in the first section, you can specify a search criterion for request task that is assigned to you.

  5. From the search results table, select the row containing the request you want to approve, and then click Approve Task (twice).

    A message confirming that the task was approved is displayed.

3.5.4 Switching Between Request-Based Provisioning and Direct Provisioning

Note:

It is assumed that you have performed the procedure described in Section 2.3.1.5, "Configuring Oracle Identity Manager for Request-Based Provisioning."

If you want to switch from request-based provisioning to direct provisioning, then:

  1. Log in to the Design Console.

  2. Disable the Auto Save Form feature as follows:

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

    2. Search for and open the LDAP User process definition.

    3. Deselect the Auto Save Form check box.

    4. Click the Save icon.

  3. If the Self Request Allowed feature is enabled, then:

    1. Expand Resource Management, and then double-click Resource Objects.

    2. Search for and open the LDAP User resource object.

    3. Deselect the Self Request Allowed check box.

    4. Click the Save icon.

If you want to switch from direct provisioning back to request-based provisioning, then:

  1. Log in to the Design Console.

  2. Enable the Auto Save Form feature as follows:

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

    2. Search for and open the LDAP User process definition.

    3. Select the Auto Save Form check box.

    4. Click the Save icon.

  3. If you want to enable end users to raise requests for themselves, then:

    1. Expand Resource Management, and then double-click Resource Objects.

    2. Search for and open the LDAP User resource object.

    3. Select the Self Request Allowed check box.

    4. Click the Save icon.

3.6 Performing Provisioning Operations in Oracle Identity Manager Release 11.1.2 or Later

To perform provisioning operations in Oracle Identity Manager release 11.1.2 or later:

  1. Log in to Oracle Identity Administrative and User console.

  2. Create a user. See the "Managing Users" chapter in Oracle Fusion Middleware User's Guide for Oracle Identity Manager for more information about creating a user.

  3. On the Account tab, click Request Accounts.

  4. In the Catalog page, search for and add to cart the application instance created in Step 3, and then click Checkout.

  5. Specify value for fields in the application form and then click Ready to Submit.

  6. Click Submit.

  7. If you want to provision entitlements, then:

    1. On the Entitlements tab, click Request Entitlements.

    2. In the Catalog page, search for and add to cart the entitlement, and then click Checkout.

    3. Click Submit.

3.7 Uninstalling the Connector

If you want to uninstall the connector for any reason, see "Uninstalling Connectors" in the Oracle Fusion Middleware Administrator's Guide for Oracle Identity Manager.