3 Using the Oracle Identity Cloud Service Connector

You can use the connector for performing reconciliation and provisioning operations after configuring it to meet your requirements.

This chapter contains the following topics related to using the Oracle Identity Cloud Service connector:

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.

3.1 Scheduled Job for Lookup Field Synchronization for Oracle Identity Cloud Service Connector

Scheduled jobs for lookup field synchronization fetch the most recent values from specific fields in the target system to lookup definitions in Oracle Identity Manager. These lookup definitions are used as an input source for lookup fields in Oracle Identity Manager.

The following scheduled jobs are used for lookup fields synchronization:

  • IDCS Groups Lookup Reconciliation

  • IDCS Managers Lookup Reconciliation

You must specify values for the attributes of these scheduled jobs. Table 3-1 describes the attributes of the scheduled job for lookup field synchronization.

Table 3-1 Attributes of the Scheduled Job 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).

Default value: __UID__

Note:

Do not change the value of this attribute.

Decode Attribute

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

Default value: __NAME__

Note:

Do not change the value of this attribute.

IT Resource Name

Enter the name of the IT resource for the target system installation from which you want to reconcile user records.

Default value:Identity Cloud Services

Lookup Name

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

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

  • For Groups Lookup Reconciliation: Lookup.IDCS.Groups

  • For Managers Lookup Reconciliation: Lookup.IDCS.Managers

Object Type

Enter the type of object you want to reconcile.

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

  • For Groups Lookup Reconciliation: Groups

  • For Managers Lookup Reconciliation: __ACCOUNT__

3.2 Configuring Reconciliation for Oracle Identity Cloud Service Connector

You can configure the connector to specify the type of reconciliation and its schedule.

3.2.1 Performing Full Reconciliation

Full reconciliation involves reconciling all existing user 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.

To perform a full reconciliation run, ensure that no values are specified for the Latest Token and Filter attributes of the scheduled jobs for reconciling user records.

At the end of the reconciliation run, the Latest Token attribute of the scheduled job for user record reconciliation is automatically set to the time stamp at which the run ended. From the next reconciliation run onward, only records created or modified after this time stamp are considered for reconciliation. This is incremental reconciliation.

Note:

Incremental reconciliation reflects changes or modifications made in the target system when a change or modification is made in the incremental reconciliation attribute. For example, during user reconciliation, changes like updates to all the fields on the Authentication Settings page (including radius profiles) and group updates will not be reconciled as a part of incremental reconciliation, and a full reconciliation has to be performed in order to reconcile these changes into Oracle Identity Manager.

3.2.2 Performing Batched Reconciliation

This topic discusses the Batch Size, Batch Start, and Number of Batches attributes of the scheduled jobs for target resource reconciliation.

By default, all target system records that are added or modified after the last reconciliation run are reconciled during the current reconciliation run. 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.

Batch Start is an attribute that can be used to configure batched reconciliation. This attribute is used to specify the record number from which batched reconciliation must begin.

Set the value of this attribute to 0 to begin reconciliation from the first record in the target system. Similarly, set the value of this attribute to 1 to begin reconciliation from the second record in the target system and so on.

Note:

See Reconciliation Scheduled Jobs for Oracle Identity Cloud Service Connector for more information about the IDCS User Target Recociliation and IDCS Group Target Recociliation scheduled jobs.

3.2.3 Performing Limited Reconciliation

Limited or filtered reconciliation is the process of limiting the number of records being reconciled based on a set filter criteria.

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.

Note:

If you are using filters in reconciliation as described in this section, be consistent and always use the same filters for delete and normal reconciliation. By using the same filters, you will maintain consistency of the data and will ensure that you work with the same user base in all reconciliation operations.

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 Oracle Identity Cloud Service resource attributes to filter the target system records.

See ICF Filter Syntax in Oracle Fusion Middleware Developing and Customizing Applications for Oracle Identity Manager for detailed information about ICF Filters.

3.2.4 Reconciliation Scheduled Jobs for Oracle Identity Cloud Service Connector

When you run the Connector Installer, reconciliation scheduled jobs are automatically created in Oracle Identity Manager. You must configure these scheduled jobs to suit your requirements by specifying values for its attributes.

This section discusses the following scheduled jobs that you can configure for reconciliation:

Note:

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

3.2.4.1 IDCS User Reconciliation

You use the IDCS User Reconciliation scheduled job to reconcile user account data from the target system.

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

Table 3-2 Attributes of the IDCS User Reconciliation Scheduled Job

Attribute Description

Filter

Enter the search filter for fetching records from the target system during a reconciliation run.

See Performing Full Reconciliation for more information about filtered reconciliation.

Incremental Recon Attribute

Attribute that holds the date on which the token record was modified.

Default value: meta.lastModified

Note:

Do not change the value of this attribute.

IT Resource Name

Enter the name of the IT resource for the target system installation from which you want to reconcile user records.

Default value: Identity Cloud Services

Latest Token

This attribute holds the value of the target system attribute that is specified as the value of the Incremental Recon Attribute attribute. The Latest Token attribute is used for internal purposes. By default, this value is empty.

Note:

Do not enter a value for this attribute. The reconciliation engine automatically enters a value in this attribute.

Sample value: <String>2016-10-19T07:24:49Z</String>

Object Type

This attribute holds the name of the object type for the reconciliation run.

Default value: User

Note:

User is the only object that is supported. Therefore, do not change the value of this attribute.

Resource Object Name

This attribute holds the name of the resource object used for reconciliation.

Default value: IDCS User

Do not change the value of this attribute.

3.2.4.2 IDCS Delete User Reconciliation

You use the IDCS Delete User Reconciliation scheduled job to reconcile deleted user account data from the target system.

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

Table 3-3 Attributes of the IDCS Delete User Reconciliation Scheduled Job

Attribute Description

IT Resource Name

Enter the name of the IT resource for the target system installation from which you want to reconcile user records.

Default value: Identity Cloud Services

Object Type

This attribute holds the name of the object type for the reconciliation run.

Default value: User

Note:

User is the only object that is supported. Therefore, do not change the value of this attribute.

Resource Object Name

This attribute holds the name of the resource object used for reconciliation.

Default value: IDCS User

3.2.4.3 IDCS Group Reconciliation

You use the IDCS Group Reconciliation scheduled job to reconcile group data from the target system.

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

Table 3-4 Attributes of the Group Reconciliation Scheduled Job

Attribute Description

Filter

Enter the search filter for fetching records from the target system during a reconciliation run.

See Performing Full Reconciliation for more information about filtered reconciliation.

Incremental Recon Attribute

Attribute that holds the date on which the token record was modified.

Default value: meta.lastModified

Note:

Do not change the value of this attribute.

IT Resource Name

Enter the name of the IT resource for the target system installation from which you want to reconcile user records.

Default value: Identity Cloud Services

Latest Token

This attribute holds the value of the attribute that is specified as the value of the Incremental Recon Attribute. The Latest Token attribute is used for internal purposes. By default, this value is empty.

Note:

Do not enter a value for this attribute. The reconciliation engine automatically enters a value in this attribute.

Sample value: <String>2016-10-19T07:24:49Z</String>

Object Type

This attribute holds the name of the object type for the reconciliation run.

Default value: Group

Note:

Group is the only object that is supported. Therefore, do not change the value of this attribute.

OIM Organization Name

Name of the organization that is used for reconciliation.

Resource Object Name

This attribute holds the name of the resource object used for reconciliation.

Default value: IDCS Group

3.2.4.4 IDCS Delete Group Reconciliation

You use the IDCS Delete Group Reconciliation scheduled job to reconcile deleted group data from the target system.

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

Table 3-5 Attributes of the Delete Group Reconciliation Scheduled Job

Attribute Description

IT Resource Name

Enter the name of the IT resource for the target system installation from which you want to reconcile user records.

Default value: Identity Cloud Services

Object Type

This attribute holds the name of the object type for the reconciliation run.

Default value: Group

Note:

User is the only object that is supported. Therefore, do not change the value of this attribute.

OIM Organization Name

Name of the organization that is used for delete reconciliation.

Resource Object Name

This attribute holds the name of the resource object used for reconciliation.

Default value: IDCS Group

3.3 Configuring Scheduled Jobs

Configure scheduled jobs to perform reconciliation runs that check for new information on your target system periodically and replicates the data in Oracle Identity Manager.

You can apply this procedure to configure the scheduled jobs for lookup field synchronization and reconciliation.

To configure a scheduled job:

  1. Log in to Oracle Identity System Administration.
  2. In the left pane, under System Management, click Scheduler.
  3. 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.
  4. 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 Creating Jobs in Oracle Fusion Middleware Administering Oracle Identity Manager for detailed information about schedule types.
  5. 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.

    • Attributes of the scheduled job are discussed in Scheduled Jobs.

  6. Click Apply to save the changes.

    Note:

    You can use the Scheduler Status page in Identity System Administration to either start, stop, or reinitialize the scheduler.

3.4 Performing Provisioning Operations

You create a new user in Oracle Identity Self Service by using the Create User page. You provision or request for accounts on the Accounts tab of the User Details page.

To perform provisioning operations in Oracle Identity Manager:

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

  2. Create a user as follows:

    1. In Identity Self Service, click Manage. The Home tab displays the different Manage option. Click Users. The Manage Users page is displayed.

    2. From the Actions menu, select Create. Alternatively, you can click Create on the toolbar. The Create User page is displayed with input fields for user profile attributes.

    3. Enter details of the user in the Create User page.

  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.

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

  7. Click Submit.

  8. 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.5 Uninstalling the Connector

Uninstalling the connector deletes all the account related data associated with resource objects of the connector.

If you want to uninstall the connector for any reason, see Uninstalling Connectors in Oracle Fusion Middleware Administering Oracle Identity Manager