Skip Headers
Oracle® Identity Manager Connector Guide for RSA ClearTrust
Release 9.0.4

E10440-07
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

3 Using the Connector

This chapter is divided into the following sections:

3.1 Performing First-Time Reconciliation

First-time reconciliation involves synchronizing lookup definitions in Oracle Identity Manager with the lookup fields of the target system, and performing full reconciliation. In full reconciliation, all existing user records from the target system are brought into Oracle Identity Manager.

The following is the sequence of steps involved in reconciling all existing user records:

Note:

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

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

  1. Perform lookup field synchronization by running the scheduled tasks provided for this operation.

    See Section 3.2, "Scheduled Task for Lookup Field Synchronization" for information about the attributes of the scheduled tasks for lookup field synchronization.

    See Section 3.4, "Configuring Scheduled Tasks" for information about running scheduled tasks.

  2. Perform user reconciliation by running the scheduled task for user reconciliation.

    See Section 3.3.4, "User Reconciliation Scheduled Task" for information about the attributes of this scheduled task.

    See Section 3.4, "Configuring Scheduled Tasks" for information about running scheduled tasks.

After first-time reconciliation, depending on the mode in which you configure the connector, the TimeStamp parameter of the IT resource is automatically set to the time stamp at which the reconciliation run began.

From the next reconciliation run onward, only target system user records that are added or modified after the time stamp stored in the IT resource are considered for incremental reconciliation. These records are brought to Oracle Identity Manager when you configure and run the user reconciliation scheduled task.

3.2 Scheduled Task for Lookup Field Synchronization

The Clear Trust Group Lookup Reconciliation Task scheduled task is used for lookup field synchronization. You must specify values for the attributes of this scheduled tasks. Table 3-1 describes the attributes of these scheduled tasks. Section 3.4, "Configuring Scheduled Tasks" describes the procedure to configure scheduled tasks.

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.

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

Attribute Description

LookupCodeName

Name of the lookup definition with which values are to be synchronized

You can enter either CTGroups or Property Names as the value of this attribute. See Section 1.5.1, "Lookup Definitions Synchronized with the Target System" for information about these lookup definitions.

Default value: CTGroups

Server

Name of the IT Resource

CT IT Resource

ReconMode

Enter REFRESH to completely refresh the existing lookup. Existing values in the lookup definition are deleted and then new values are added.Enter UPDATE if you want to update the lookup definition with new values. Existing values in the lookup definition are left untouched.

Default value: REFRESH


3.3 Configuring Reconciliation

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:

3.3.1 Full Reconciliation vs. Incremental Reconciliation

The TimeStamp parameter of the IT resource store the time stamp at which a reconciliation run begins. During the next reconciliation run, the scheduled task fetches only target system records that are added or modified after the time stamp stored in the TimeStamp parameter. This is incremental reconciliation.

If you delete the value of the TimeStamp parameter, then full reconciliation is performed when the scheduled task is run. In full reconciliation, all existing target system records are fetched into Oracle Identity Manager.

You can switch from incremental to full reconciliation at any time by deleting the value of the TimeStamp parameter. At the end of the reconciliation run, the TimeStamp parameter again stores the time stamp at which the reconciliation run began. In this way, incremental reconciliation is performed during the next reconciliation run.

3.3.2 Paged 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 paged reconciliation to avoid these problems.

To configure paged reconciliation, you must specify a value for the Paging Range attribute of the user reconciliation scheduled task while performing the procedure described in Section 3.3.4, "User Reconciliation Scheduled Task."

3.3.3 Specifying the Attributes That Must Be Used During Reconciliation

Note:

This section describes an optional procedure. Perform this procedure only if you want to specify a subset of the available target system attribute mappings for reconciliation.

If you want to specify the subset of target system attributes that must be reconciled:

  1. In the Design Console, open the Lookup.CTReconciliation.FieldMap lookup definition.

  2. For attributes that must be reconciled from the target system, retain or add entries in the lookup definition.

    For each target system attribute that you want to add, enter the name of the attribute in both the Code Key and Decode columns. The following table shows the default entries in this lookup definition:

    Code Key Decode
    userId userId

    Note: Do not remove this row from the lookup definition.

    lastName lastName

    Note: Do not remove this row from the lookup definition.

    endDate endDate

  3. Save and close the lookup definition.

  4. Open the ClearTrust Reconciliation Task scheduled task.

  5. Set true as the value of the UseReconFieldMap atribute.

  6. Ensure that the CTReconciliationFields attribute is set to Lookup.CTReconciliation.FieldMap.

    Note:

    If you create and use a different lookup definition for storing these attribute names, then set the value of that lookup definition as the value of the CTReconciliationFields attribute.
  7. Save and close the scheduled task.

From each subsequent run of the ClearTrust Reconciliation Task scheduled task, only attributes specified in the Lookup.CTReconciliation.FieldMap are reconciled.

3.3.4 User Reconciliation Scheduled Task

The ClearTrust Reconciliation Task scheduled task is used for reconciling user data. Table 3-1 describes the attributes of this scheduled task.

Table 3-2 Attributes of the ClearTrust Reconciliation Task Scheduled Task

Attribute Description

Server

Name of the IT Resource

ClearTrust

Target System CT Recon - Resource Object name

Name of the target system parent resource object

ClearTrust

Trusted Source Recon - Resource Object name

Name of the trusted source resource object

Default value: Xellerate User

Specify false (in lowercase) if you do not want to configure trusted source reconciliation

Paging Range

Paging range to extract user accounts from the target system

10

TrialRecNum

Use this parameter if you only want to check connectivity with the target and reconcile a few records to ensure that reconciliation with the relevant target is working.

Specify the number of records that you want to reconcile as the value of this parameter.

3

UseReconFieldMap

If this attribute is set to true, then only user attributes mapped in the lookup definition specified by the CTReconciliationFields attribute are fetched from the target system for reconciliation. The CTReconciliationFields attribute is described later in this table. If the UseReconFieldMap attribute is set to false, then all the attributes for which there are reconciliation field mappings in the resource object are fetched for reconciliation.

Default value: false

CTReconciliationFields

Name of the lookup definition that stores the reconciliation field data used in customized reconciliation

Lookup.CTReconciliation.FieldMap

Date Format

Format in which date values sent from the target system are to be saved during reconciliation

The value that you specify must be the same as the value specified in Section 2.3.5, "Configuring the Oracle Identity Manager System Property for the Date Format."

yyyy/MM/dd hh:mm:ss z


3.4 Configuring Scheduled Tasks

Table 3-3 lists the scheduled tasks that form part of the connector.

Table 3-3 Scheduled Tasks for Lookup Field Synchronization and Reconciliation

Scheduled Task Description

Clear Trust Group Lookup Reconciliation Task

This scheduled task is used to synchronize the values of the group lookup field between Oracle Identity Manager and the target system. See Section 3.2, "Scheduled Task for Lookup Field Synchronization" for information about this scheduled task.

ClearTrust Reconciliation Task

This scheduled task is used for user reconciliation. See Section 3.3.4, "User Reconciliation Scheduled Task" for information about this scheduled task.


To configure these scheduled tasks, perform the procedure described in one of the following sections depending on the Oracle Identity Manager release that you are using:

3.4.1 Configuring Scheduled Tasks on Oracle Identity Manager Releases 9.0.1 Through 9.0.3.2

To configure a scheduled task Oracle Identity Manager releases 9.0.1 through 9.0.3.2:

  1. Open the Oracle Identity Manager Design Console.

  2. Expand the Xellerate Administration folder, and then select Task Scheduler.

  3. Click Find. The details of the predefined scheduled tasks are displayed on two different tabs.

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

  5. Ensure that the Disabled and Stop Execution check boxes are not selected.

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

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

  8. Provide values for the attributes of the scheduled task.

  9. Click 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.

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:

  1. Perform Steps 1 through 3 of the procedure to configure reconciliation scheduled tasks.

  2. Select the Stop Execution check box.

  3. Click Save.

3.4.2 Configuring Scheduled Tasks on Oracle Identity Manager Release 9.1.0.x and 11.1.1

This section describes the procedure to configure scheduled tasks on Oracle Identity Manager release 9.1.0.x and 11.1.1. You can apply this procedure to configure the scheduled tasks for lookup field synchronization and reconciliation.

To configure a scheduled task:

  1. Log in to the Administrative and User Console.

  2. Perform one of the following steps:

    1. If you are using Oracle Identity Manager release 9.1.0.x, expand Resource Management, and then click Manage Scheduled Task.

    2. If you are using Oracle Identity Manager release 11.1.1, then on the Welcome to Oracle Identity Manager Self Service page, click Advanced in the upper-right corner of the page.

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

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

      1. On the Scheduled Task Management page, enter the name of the scheduled task as the search criteria and then click Search.

      2. In the search results table, click the edit icon in the Edit column for the scheduled task.

      3. On the Scheduled Task Details page where the details of the scheduled task that you selected is displayed, click Edit.

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

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

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

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

  4. Modify the details of the scheduled task. To do so:

    1. If you are using Oracle Identity Manager release 9.1.0.x, then on the Edit Scheduled Task Details page, modify the following parameters, and then click Continue:

      • Status: Specify whether you want to leave the task in the enabled state. In the enabled state, the task is ready for use.

      • Max Retries: Enter an integer value in this field. This number represents the number of times Oracle Identity Manager must attempt to complete the task before assigning the ERROR status to the task. The default value is 1.

      • Next Start: Use the date editor to specify the date when you want the task to run. After you select a date value in the date editor, you can modify the time value that is automatically displayed in the Next Start field.

      • Frequency: Specify the frequency at which you want the task to run.

    2. If you are using Oracle Identity Manager release 11.1.1, then on the Job Details tab, you can modify the following parameters:

      • 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 Oracle Fusion Middleware System 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.

  5. Specify values for the attributes of the scheduled task. To do so:

    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.

    • Attributes of the scheduled task are discussed in Section 3.3.4, "User Reconciliation Scheduled Task."

    • If you are using Oracle Identity Manager release 9.1.0.x, then on the Attributes page, select the attribute from the Attribute list, specify a value in the field provided, and then click Update.

    • If you are using Oracle Identity Manager release 11.1.1, then on the Job Details tab, in the Parameters region, specify values for the attributes of the scheduled task.

  6. After specifying the attributes, perform one of the following steps:

    • If you are using Oracle Identity Manager release 9.1.0.x, then click Save Changes to save the changes.

      Note:

      The Stop Execution option is not available in the Administrative and User Console. If you want to stop a task, then click Stop Execution on the Task Scheduler form of the Design Console.
    • If you are using Oracle Identity Manager release 11.1.1, then 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.

Stopping Reconciliation

If you want to stop a scheduled task while it is running, open the scheduled task in the Design Console and then select the Stop Execution check box.

3.5 Performing Provisioning Operations

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

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

If you have configured 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.6, "Switching Between Request-Based Provisioning and Direct Provisioning on Oracle Identity Manager Release 11.1.1."

The following are types of provisioning operations:

See Also:

For conceptual information about the types of provisioning, see one of the following guides:
  • For Oracle Identity Manager release 9.0.1 through 9.0.3.2 and release 9.1.0.x: Oracle Identity Manager Connector Concepts

  • For Oracle Identity Manager release 11.1.1: Oracle Fusion Middleware User's Guide for Oracle Identity Manager

This section discusses the following topics:

3.5.1 Direct Provisioning

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:

    • If you are using Oracle Identity Manager releases 9.0.1 through 9.0.3.2 and 9.1.0.x, then:

      1. From the Users menu, select Create.

      2. On the Create User page, enter values for the OIM User fields and then click Create User.

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

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

      2. On the Create User page, enter values for the OIM User fields, and then click Save.

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

    • If you are using Oracle Identity Manager releases 9.0.1 through 9.0.3.2 and 9.1.0.x, then:

      1. From the Users menu, select Manage.

      2. Search for the OIM User and select the link for the user from the list of users displayed in the search results.

    • If you are using Oracle Identity Manager release 11.1.1, 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. Depending on the Oracle Identity Manager release you are using, perform one of the following steps:

    • If you are using Oracle Identity Manager releases 9.0.1 through 9.0.3.2 or 9.1.0.x, then:

      1. On the User Detail page, select Resource Profile from the list at the top of the page.

      2. On the Resource Profile page, click Provision New Resource.

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

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

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

  5. On the Step 1: Select a Resource page, select ClearTrust from the list and then click Continue.

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

  7. On the Step 5: Provide Process Data for ClearTrust User Details page, enter the details of the account that you want to create on the target system and then click Continue.

  8. On the Step 5: Provide Process Data for ClearTrust Property Updation Details page, if required, search for and select a group for the user on the target system and then click Continue. If you do not want to specify a group, then directly click Continue.

  9. On the Step 5: Provide Process Data for ClearTrust User Group Membership Details page, if required, search for and select a group for the user on the target system and then click Continue. If you do not want to specify a group, then directly click Continue.

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

  11. The "Provisioning has been initiated" message is displayed. Perform one of the following steps:

    • If you are using Oracle Identity Manager release 9.0.1 through 9.0.3.2 or release 9.1.0.x, click Back to User Resource Profile. The Resource Profile page shows that the resource has been provisioned to the user.

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

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

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

3.5.2 Request-Based Provisioning

Note:

The information provided in this section is applicable only if you are using Oracle Identity Manager release 11.1.1.

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.2.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 in the upper-right corner of the page.

  3. On the Welcome to Identity Administration page, click the Administration tab, and then click the Requests 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 Clear Trust, move it to the Selected Resources list, and then click Next.

  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

    On the resulting page, 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.2.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.

    A message confirming that the task was approved is displayed.

3.6 Switching Between Request-Based Provisioning and Direct Provisioning on Oracle Identity Manager Release 11.1.1

Note:

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

On Oracle Identity Manager release 11.1.1, 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 CT Users 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 ClearTrust resource object.

    3. Deselect the Self Request Allowed check box.

    4. Click the Save icon.

On Oracle Identity Manager release 11.1.1, 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 CT 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 ClearTrust resource object.

    3. Select the Self Request Allowed check box.

    4. Click the Save icon.