3 Using the Connector

This chapter provides information about the following topics:

3.1 Performing First-Time Reconciliation

First-time recon 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 release 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.5, "Configuring Scheduled Tasks" for information about running scheduled tasks.

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

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

    See Section 3.5, "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 SIEBEL IT Resource IT resource is automatically set to the time stamp at which the reconciliation run began.

See Also:

Section 2.2.1.2, "Configuring the IT Resource" for information about the parameters of the IT resource

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 Siebel LookupRecon scheduled task is used for lookup field synchronization. Table 3-1 describes the attributes of this scheduled task. See Section 3.5, "Configuring Scheduled Tasks" for information about configuring 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 Siebel LookupRecon Scheduled Task

Attribute Description

ITResource

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

Default value: SIEBEL IT Resource


3.3 Guidelines on Performing Provisioning

The following is a guideline on performing provisioning:

Activating and Deactivating Employee Accounts

To activate an employee account on the target system, assign any responsibility from Oracle Identity Manager.

To deactivate an employee account on the target system, delete all responsibilities of the employee from Oracle Identity Manager.

Note:

To perform a provisioning operation for users of type User, customize the Siebel process form and make the Position field optional.

3.4 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.4.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, set the TimeStamp parameter of the SIEBEL IT resource to 0. At the end of the reconciliation run, the TimeStamp parameter of the SIEBEL IT resource is automatically set to the time stamp at which the run started. From the next run onward, only records created or modified after this time stamp are considered for reconciliation. This is incremental reconciliation.

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

For this connector, you create a filter by specifying values for the CustomizedReconQuery IT resource parameter while configuring the IT resource.

The following table lists the target system attributes, and the corresponding Oracle Identity Manager attributes, that you can use to build the query condition. You specify this query condition as the value of the CustomizedReconQuery parameter.

Oracle Identity Manager Attribute Target System Attribute

User ID

Login Name

First Name

First Name

Last Name

Last Name

Email

EMail Addr

Job Title

Job Title

Middle Name

Middle Name

Organization

Organization

Responsibility

Responsibility

Position

Position

Employee Type

Employee Type

Alias

Alias


The following are sample query conditions:

  • First Name=John&Last Name=Doe

    With this query condition, records of users whose first name is John and last name is Doe are reconciled.

  • First Name=John&Last Name=Doe|group=contractors

    With this query condition, records of users who meet either of the following conditions are reconciled:

    • The user's first name is John or last name is Doe.

    • The user belongs to the contractors group.

If you do not specify values for the CustomizedReconQuery parameter, then all the records in the target system are compared with existing Oracle Identity Manager records during reconciliation.

The following are guidelines to be followed while specifying a value for the CustomizedReconQuery parameter:

  • For the target system attributes, you must use the same case (uppercase or lowercase) as given in the table shown earlier in this section. This is because the attribute names are case-sensitive.

  • You must not include unnecessary blank spaces between operators and values in the query condition.

    A query condition with spaces separating values and operators would yield different results as compared to a query condition that does not contain spaces between values and operators. For example, the output of the following query conditions would be different:

    First Name=John&Last Name=Doe

    First Name= John&Last Name= Doe

    In the second query condition, the reconciliation engine would look for first name and last name values that contain a space at the start.

  • You must not include special characters other than the equal sign (=), ampersand (&), and vertical bar (|) in the query condition.

    Note:

    An exception is thrown if you include special characters other than the equal sign (=), ampersand (&), and vertical bar (|).

  • The query condition must be an expression without any braces.

  • Searching users based on multiple value roles and groups are not supported. Only one value for roles and profiles can be queried at a time. For example, if the query condition is Usergroup=a,b,c, then the query generates an error.

  • Searching users based on more than three user attributes are not supported. For example, if the query condition is userid=JOHN&firstname=John&lastname=Doe&country=US, then the query generates an error.

You specify a value for the CustomizedReconQuery parameter while configuring the IT resource.

3.4.3 Reconciliation Based on User Type

Note:

This section discusses the UserType attribute of the scheduled task.

Siebel supports the definition of the following user types:

  • Employee

  • Partner User

  • Customer

  • User

You can specify the user type for which reconciliation must be performed.

To specify the user type for which reconciliation must be performed, you use the UserType scheduled task attribute. This attribute is discussed in Section 3.4.4, "User Reconciliation Scheduled Task."

3.4.4 User Reconciliation Scheduled Task

When you run the Connector Installer or import the connector XML file, the Siebel Recon scheduled task is automatically created in Oracle Identity Manager. This scheduled task is used to reconcile user data from the target system.

You must specify values for the following attributes of the Siebel Recon scheduled task. Table 3-2 describes the attributes of this scheduled task.

Table 3-2 Attributes of the User Reconciliation Scheduled Task

Attribute Description

Organization

Oracle Identity Manager users

Enter the name of the Oracle Identity Manager organization in which reconciled users must be created.

Default value: Xellerate Users

Configuration Lookup

This attribute contains the name of the lookup definition that stores configuration information used during connector operations.

Default value: Lookup.Configuration.Siebel

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

MultiValueAttributes

If you perform the procedure described in Section 4.4, "Adding New Multivalued Attributes for Provisioning," then append the multivalued attribute to the default value of the MultiValueAttributes attribute. Step 4 of that section describes the procedure.

Default value: Position,MPosition,Position Id&Responsibility,Primary Responsibility,Responsibility

Note: You must not delete this default value. You can only append to it.

TransformLookupName

This attribute holds the name of the lookup definition that is used to configure transformation of attribute values fetched from the target system during reconciliation.

Default value: Lookup.Transform.Siebel

Use Transform Mapping

Enter yes if you want to configure transformation of attribute values fetched from the target system during reconciliation. Otherwise, enter no. See Section 4.5, "Configuring Transformation of Data During Reconciliation" for more information about this feature.

Default value: no

Xellerate Type

Enter the role that must be set for OIM Users created through reconciliation. You can enter one of the following values:

  • End-User

  • End-User Administrator

Default value: End-User Administrator

Note: If you are configuring the connector for trusted source reconciliation, then you need not set a value for this attribute.

Role

Enter the employee type that must be set for OIM Users created through reconciliation. You can enter one of the following values:

  • Full-Time Employee

  • Part-Time Employee

  • Temp

  • Intern

  • Consultant

Default value: Consultant

ITResource

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

Default value: SIEBEL IT Resource

ResourceObject

Enter the name of the resource object that is used in reconciliation.

Default value: SIEBEL Resource Object

IsTrusted

Enter True if you want to configure the connector for trusted source reconciliation.

Enter False if you want to configure the connector for target resource reconciliation.

Default value: False

isDeleteRecon

Enter True if you want to perform reconciliation of deleted user records. During reconciliation of deleted users:

  • In target resource mode, if a record is deleted on the target system, then the corresponding Siebel resource is revoked from the OIM User.

  • In trusted source mode, if a record is deleted on the target system, then the corresponding OIM User is deleted.

Enter False if you want to run user reconciliation.

Default value: False

UserType

Specify the type of user that must be reconciled from the target system.

You can specify one of the following Siebel user types:

  • Employee: This user is an internal employee and user who is associated with a position in a division within your company.

  • Partner User: This user is an employee at a partner company (external organization) and is associated with a position in a division within that company. Therefore, a Partner User is also an Employee, but not an internal one.

  • Customer: This user is a self-registered partner having no position in your company. However, this user has a responsibility that specifies the application views the user can access.

Default value: Employee

Note: To run a target system reconciliation of a user of type User, customize the Siebel process form and make the Position field optional.

SiebelServerTimeZone

Specifies the time zone of the target system database

The connector uses this information to identify records that must be reconciled during incremental reconciliation.

Default value: GMT+10:00

DayLightSaving

Enter the time (in minutes) that must be added to the time stamp

Sample value: 60

With this sample value, 60 minutes are added to the time stamp stored in the TimeStamp parameter, and the new time stamp is used to identify records that have been created or modified after the last reconciliation run.

Defaul value: 0


3.5 Configuring Scheduled Tasks

This section describes the procedure to configure scheduled tasks. You can apply this procedure to configure the scheduled tasks for lookup field synchronization and reconciliation.

Table 3-3 lists the scheduled tasks that you must configure.

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

Scheduled Task Description

Siebel LookupRecon

This scheduled task is used for lookup field synchronization. See Section 3.2, "Scheduled Task for Lookup Field Synchronization" for information about this scheduled task.

Siebel Recon

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


Depending on the Oracle Identity Manager release that you are using, perform the procedure described in one of the following sections:

3.5.1 Configuring Scheduled Tasks on Oracle Identity Manager Release 9.1.0.x or Release 11.1.1

To configure a scheduled task:

  1. Log in to the Administrative and User Console.

  2. Perform one of the following:

    1. If you are using Oracle Identity Manager release 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.4.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:

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

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

The following are types of provisioning operations:

  • Direct provisioning

  • Request-based provisioning

  • Provisioning triggered by policy changes

See Also:

Oracle Identity Manager Connector Concepts for information about the types of provisioning

This section discusses the following topics:

3.6.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 release 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 release 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 release 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 Siebel Resource Object 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 Siebel 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 Siebel Responsibility Form page, search for and select a group for the user on the target system and then click Continue.

  9. On the Step 5: Provide Process Data for Siebel Position Form page, search for and select a group for the user on the target system and then 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.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.6.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.6.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 Siebel Resource Object, 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.6.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.7 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.1.8, "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 Siebel Process 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 Siebel Resource Object 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 Siebel Process 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 Siebel Resource Object resource object.

    3. Select the Self Request Allowed check box.

    4. Click the Save icon.