This chapter is divided into the following sections:
Section 3.2, "Scheduled Task for Lookup Field Synchronization"
Section 3.5, "Guidelines on Performing Provisioning Operations"
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.
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.
See Section 3.4, "Configuring Scheduled Tasks" for information about the procedure to configure scheduled tasks.
If you are using the target system as a target resource, then:
Configure and run the SAPEP LookupRecon scheduled task to synchronize the lookup definitions. See Section 3.2, "Scheduled Task for Lookup Field Synchronization" information about the attributes of this scheduled task.
Configure and run the SAPEP UserRecon scheduled task to reconcile user records from the target system. See Section 3.3.4, "User Reconciliation Scheduled Task" for information about the attributes of this scheduled task.
Reconciled user records are converted into SAP Enterprise Portal resources assigned to OIM Users.
If you are using the target system as a trusted source, then configure and run the SAPEP UserRecon scheduled task to reconcile user records from the target system. See Section 3.3.4, "User Reconciliation Scheduled Task" for information about the attributes of this scheduled task.
Reconciled user records are converted into OIM Users.
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. Table 2-3 describes this parameter.
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.
The SAPEP LookupRecon 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.
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:
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 perform a full reconciliation run to fetch all existing target system records into Oracle Identity Manager. To perform a full reconciliation run:
Delete the value of the TimeStamp IT resource parameter. See Section 2.2.2.2, "Configuring the IT Resource" for information about setting values for parameters of the IT resource.
Set the BatchSize attribute of the SAPEP UserRecon scheduled task to a non-zero value. See Section 3.4.1, "Configuring Scheduled Tasks on Oracle Identity Manager Release 9.0.1 Through 9.0.3.2" for information about configuring scheduled tasks.
After a full reconciliation run, the time stamp at which the reconciliation run ends is stored in the time stamp parameter of the IT resource. From the next reconciliation run onward, only target system records added or modified after the last reconciliation run are fetched to Oracle Identity Manager. In other words, incremental reconciliation is automatically activated from the next run onward.
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 attribute of the scheduled task. Section 3.3.4, "User Reconciliation Scheduled Task" describes the attributes of the scheduled task.
The following table lists the SAP Enterprise Portal attributes that you can use to build the query condition. You specify this query condition as the value of the CustomizedReconQuery attribute.
| SAP Enterprise Portal Attribute | Oracle Identity Manager Attribute |
|---|---|
|
firstname |
FirstName |
|
lastname |
LastName |
|
department |
Department |
|
|
EmailID |
|
telephone |
Telephone |
|
mobile |
Mobile |
|
fax |
Fax |
|
streetaddress |
Street |
|
city |
City |
|
zip |
Zip |
|
country |
Country |
|
state |
State |
|
locale |
Language |
|
timezone |
TimeZone |
|
Group |
Group |
|
Role |
Role |
The following are sample query conditions:
firstname=John&lastname=Doe
With this query condition, records of users whose first name is John and last name is Doe are reconciled.
firstname=John&lastname=Doe|email=test@example.com
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's e-mail address is test@example.com.
If you do not specify values for the CustomizedReconQuery attribute, then all the records in the target system are compared with existing Oracle Identity Manager records during reconciliation.
You must apply the following guidelines while specifying a value for the CustomizedReconQuery attribute:
For the SAP Enterprise Portal 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:
firstname=John&lastname=Doe
firstname= John&lastname= 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 (|).
To specify multiple roles and groups in the query, roles and groups must be provided with the comma separator.
You specify a value for the CustomizedReconQuery attribute while performing the procedure described in Section 3.4, "Configuring Scheduled Tasks."
During a reconciliation run, all changes in the target system records are reconciled into Oracle Identity Manager. Depending on the number of records to be reconciled, this process may require a large amount of time. In addition, if the connection breaks during reconciliation, then the process would take longer to complete.
You can configure batched reconciliation to avoid these problems.
To configure batched reconciliation, you must specify an integer value for the BatchSize attribute of the user reconciliation scheduled task (SAPEP UserRecon).
Suppose you specify the 20 as the value of the BatchSize attribute. Suppose that 314 user records were created or modified after the last reconciliation run. These 314 records would be reconciled in batches of 20 records each.
You specify values for the BatchSize attribute by following the instructions described in Section 3.4, "Configuring Scheduled Tasks."
You must specify values for the following attributes of the SAPEP UserRecon user reconciliation 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 were left empty, then reconciliation would not be performed.
Table 3-2 Attributes of the SAPEP UserRecon Scheduled Task
| Attribute | Description | Sample Value |
|---|---|---|
|
Organization |
Default organization assigned to a new user |
|
|
Xellerate Type |
Default type assigned to a new user |
|
|
Role |
Default employee type assigned to a new user |
|
|
ITResource |
Name of the IT resource for setting up a connection with SAP |
|
|
ResourceObject |
Name of the resource object that is used for user reconciliation |
|
|
IsTrustedSource |
Configuration for trusted source / target resource If it is set to |
|
|
BatchSize |
Specifies the number of records that must be included in each batch fetched from the target system You use this attribute to implement the batched reconciliation feature. |
|
|
XLDeleteUsersAllowed |
Flag that specifies whether or not users are to be deleted in Oracle Identity Manager during user reconciliation |
|
|
CustomizedReconQuery |
Query condition on which reconciliation must be based If you specify a query condition for this attribute, then the search for target system records is based on the query condition. If you want to reconcile all the target system records, then do not specify a value for this parameter. The query can include the AND (&) and OR (|) logical operators. |
|
|
TrustedResourceObject |
Name of the trusted resource object |
|
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 |
|---|---|
|
SAPEP LookupRecon |
This scheduled task is used for lookup field synchronization. |
|
SAPEP UserRecon |
This scheduled task is used for user reconciliation. |
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:
To configure a scheduled task on Oracle Identity Manager release 9.0.1 through 9.0.3.2:
Expand the Xellerate Administration folder.
Select Task Scheduler.
Click Find. The details of the predefined scheduled tasks are displayed on two different tabs.
For the first scheduled task, enter a number in the Max Retries field. Oracle Identity Manager must attempt to complete the task before assigning the ERROR status to the task.
Ensure that the Disabled and Stop Execution check boxes are not selected.
In the Start region, double-click the Start Time field. From the date-time editor that is displayed, select the date and time at which you want the task to run.
In the Interval region, set the following schedule parameters:
To set the task to run on a recurring basis, select the Daily, Weekly, Recurring Intervals, Monthly, or Yearly option.
If you select the Recurring Intervals option, then you must also specify the time interval at which you want the task to run on a recurring basis.
To set the task to run only once, select the Once option.
Provide values for the attributes of the scheduled task. See Section 3.3.4, "User Reconciliation Scheduled Task" for information about the values to be specified.
See Also:
Oracle Identity Manager Design Console Guide for information about adding and removing task attributes
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.
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.
To configure a scheduled task on Oracle Identity Manager release 9.1.0.x and 11.1.1:
Log in to the Administrative and User Console.
Perform one of the following steps:
If you are using Oracle Identity Manager release 9.1.0.x, expand Resource Management, and then click Manage Scheduled Task.
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.
Search for and open the scheduled task as follows:
If you are using Oracle Identity Manager release 9.1.0.x, then:
On the Scheduled Task Management page, enter the name of the scheduled task as the search criteria and then click Search.
In the search results table, click the edit icon in the Edit column for the scheduled task.
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:
On the Welcome to Oracle Identity Manager Advanced Administration page, in the System Management region, click Search Scheduled Jobs.
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.
In the search results table on the left pane, click the scheduled job in the Job Name column.
Modify the details of the scheduled task. To do so:
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.
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.
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.
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.
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.
Apply the following guidelines while performing provisioning operations:
While performing the Create User provisioning operation, you must also assign a role to the user. If you do not assign a role to the user, then the user would not be able to view any Portal content after logging in to SAP Enterprise Portal.
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:
See Also:
Oracle Identity Manager Connector Concepts for information about the types of provisioning
This section discusses the following topics:
To provision a resource by using the direct provisioning approach:
Log in to the Administrative and User Console.
If you want to first create an OIM User and then provision a target system account, then:
If you are using an Oracle Identity Manager release from 9.0.1 through 9.0.3.2 or release 9.1.0.x, then:
From the Users menu, select Create.
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:
On the Welcome to Identity Administration page, in the Users region, click Create User.
On the Create User page, enter values for the OIM User fields, and then click Save.
If you want to provision a target system account to an existing OIM User, then:
If you are using an Oracle Identity Manager release from 9.0.1 through 9.0.3.2 or release 9.1.0.x, then:
From the Users menu, select Manage.
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:
On the Welcome to Identity Administration page, search for the OIM User by selecting Users from the list on the left pane.
From the list of users displayed in the search results, select the OIM User. The user details page is displayed on the right pane.
Depending on the Oracle Identity Manager release you are using, perform one of the following steps:
If you are using an Oracle Identity Manager release from 9.0.1 through 9.0.3.2 or release 9.1.0.x, then:
On the User Detail page, select Resource Profile from the list at the top of the page.
On the Resource Profile page, click Provision New Resource.
If you are using Oracle Identity Manager release 11.1.1, then:
On the user details page, click the Resources tab.
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.
On the Step 1: Select a Resource page, select Auth Manager User from the list and then click Continue.
On the Step 2: Verify Resource Selection page, click Continue.
On the Step 5: Provide Process Data for Auth Manager User Details page, enter the details of the account that you want to create on the target system and then click Continue.
On the Step 5: Provide Process Data for Auth Manager User page, search for and select a group for the user on the target system and then click Continue.
On the Step 6: Verify Process Data page, verify the data that you have provided and then click Continue.
The "Provisioning has been initiated" message is displayed. Perform one of the following steps:
If you are using an Oracle Identity Manager release from 9.0.1 through 9.0.3.2 or release 9.1.0.x, then 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:
Close the window displaying the "Provisioning has been initiated" message.
On the Resources tab, click Refresh to view the newly provisioned resource.
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.
Section 3.6.2.1, "End User's Role in Request-Based Provisioning"
Section 3.6.2.2, "Approver'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
Log in to the Administrative and User Console.
On the Welcome page, click Advanced in the upper-right corner of the page.
On the Welcome to Identity Administration page, click the Administration tab, and then click the Requests tab.
From the Actions menu on the left pane, select Create Request.
The Select Request Template page is displayed.
From the Request Template list, select Provision Resource and click Next.
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.
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.
Click Move or Move All to include your selection in the Selected Users list, and then click Next.
On the Select Resources page, click the arrow button next to the Resource Name field to display the list of all available resources.
From the Available Resources list, select Auth Manager User, move it to the Selected Resources list, and then click Next.
On the Resource Details page, enter details of the account that must be created on the target system, and then click Next.
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.
If you click the request ID, then the Request Details page is displayed.
To view details of the approval, on the Request Details page, click the Request History tab.
The following are steps performed by the approver in a request-based provisioning operation:
The following are steps that the approver can perform:
Log in to the Administrative and User Console.
On the Welcome page, click Self-Service in the upper-right corner of the page.
On the Welcome to Identity Manager Self Service page, click the Tasks tab.
On the Approvals tab, in the first section, you can specify a search criterion for request task that is assigned to you.
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.
Note:
It is assumed that you have performed the procedure described in Section 2.3.1.6, "Enabling Request-Based Provisioning.".
On Oracle Identity Manager release 11.1.1, if you want to switch from request-based provisioning to direct provisioning, then:
Log in to the Design Console.
Disable the Auto Save Form feature as follows:
Expand Process Management, and then double-click Process Definition.
Search for and open the Auth Manager User process definition.
Deselect the Auto Save Form check box.
Click the Save icon.
Repeat this procedure to deselect the Auto Save Form check box for the Auth Manager Token process definition.
If the Self Request Allowed feature is enabled, then:
Expand Resource Management, and then double-click Resource Objects.
Search for and open the Auth Manager User resource object.
Deselect the Self Request Allowed check box.
Click the Save icon.
Repeat this procedure to deselect the Self Request Allowed check box for the Auth Manager Token process definition.
On Oracle Identity Manager release 11.1.1, if you want to switch from direct provisioning back to request-based provisioning, then:
Log in to the Design Console.
Enable the Auto Save Form feature as follows:
Expand Process Management, and then double-click Process Definition.
Search for and open the Auth Manager User process definition.
Select the Auto Save Form check box.
Click the Save icon.
Repeat this procedure to select the Auto Save Form check box for the Auth Manager Token process definition.
If you want to enable end users to raise requests for themselves, then:
Expand Resource Management, and then double-click Resource Objects.
Search for and open the Auth Manager User resource object.
Select the Self Request Allowed check box.
Click the Save icon.
Repeat this procedure to select the Self Request Allowed check box for the Auth Manager Token process definition.