Skip Headers
Oracle® Identity Manager Connector Guide for Oracle e-Business Employee Reconciliation
Release 9.0.2

Part Number B32163-01
Go to Documentation Home
Home
Go to Table of Contents
Contents
Go to Index
Index

Go to previous page
Previous
Go to next page
Next
View PDF

2 Deploying the Connector

Deploying the connector involves the following steps:

If you want to configure the connector for multiple installations of Oracle e-Business Employee Reconciliation, then perform the following procedure:

Step 1: Verifying Deployment Requirements

The following table lists the deployment requirements for the connector.

Item Requirement
Oracle Identity Manager Oracle Identity Manager release 8.5.3 or later
Target system Oracle e-Business Suite 11.5.10
External code JDBC class library (classes12.jar)
Target system user account APPS user with full privileges

You provide the credentials of this user account while performing the procedure in the "Defining IT Resources" section.


Step 2: Configuring the Target System

For this connector, you do not need to perform any configuration steps on the target system.

Step 3: Copying the Connector Files and External Code

The connector files to be copied and the directories to which you must copy them are given in the following table.


Note:

The directory paths given in the first column of this table correspond to the location of the connector files in the following ZIP file on the installation media:
Enterprise Applications\Oracle e-Business\Oracle e-Business Employee Reconciliation Rev 2.2.0.zip

Refer to the "Files and Directories That Comprise the Connector" section for more information about these files.


File in the Installation Media Directory Destination Directory
xml\oracleHRResAdp.xml
OIM_home\xlclient
lib\ScheduleTask\xlReconOraHREmp.jar
OIM_home\xellerate\ScheduleTask
Files in the resources directory
OIM_home\xellerate\connectorResources
docs\B32163_01.pdf
OIM_home\xellerate\docs\OracleeBizEmp

Copy the JDBC class library (classes12.jar) from the oracle_home\ora92\jdbc\lib\classes12.jar directory to the OIM_home\xellerate\ThirdParty directory. Here, oracle_home is the directory in which Oracle9i Database is installed. For example, C:\Oracle.


Note:

While installing Oracle Identity Manager in a clustered environment, you copy the contents of the installation directory to each node of the cluster. Similarly, you must copy the connectorResources directory and the JAR files to the corresponding directories on each node of the cluster.

Step 4: Configuring the Oracle Identity Manager Server

Configuring the Oracle Identity Manager server involves the following procedures:


Note:

In a clustered environment, you must perform this step on each node of the cluster. Then, restart each node.

Changing to the Required Input Locale

Changing to the required input locale involves installing the required fonts and setting the required input locale.

To set the required input locale:


Note:

Depending on the operating system used, you may need to perform this procedure differently.

  1. Open Control Panel.

  2. Double-click Regional Options.

  3. On the Input Locales tab of the Regional Options dialog box, add the input locale that you want to use and then switch to the input locale.

Clearing Content Related to Connector Resource Bundles from the Server Cache

Whenever you add a new resource bundle file in the OIM_home\xellerate\connectorResources directory or make a change in an existing resource bundle file, you must clear content related to connector resource bundles from the server cache.

To clear content related to connector resource bundles from the server cache:

  1. In a command window, change to the OIM_home\xellerate\bin directory.

  2. Enter one of the following commands:


    Note:

    You must perform Step 1 before you perform this step. If you run the command as follows, then an exception is thrown:
    OIM_home\xellerate\bin\batch_file_name
    

    • On Microsoft Windows:

      PurgeCache.bat ConnectorResourceBundle
      
      
    • On UNIX:

      PurgeCache.sh ConnectorResourceBundle
      
      

    In this command, ConnectorResourceBundle is one of the content categories that you can remove from the server cache. Refer to the following file for information about the other content categories:

    OIM_home\xellerate\config\xlConfig.xml
    
    

Note:

You can ignore the exception that is thrown when you perform Step 2.

Step 5: Importing the Connector XML File

To import the connector XML file:

  1. Open the Oracle Identity Manager Administrative and User Console.

  2. Click the Deployment Management link on the left navigation bar.

  3. Click the Import link under Deployment Management. A dialog box for locating files is displayed.

  4. Locate and open the oracleHRResAdp.xml file, which is in the OIM_home\xlclient directory. Details of this XML file are shown on the File Preview page.

  5. Click Add File. The Substitution page is displayed.

  6. Click Next. The Confirmation page is displayed.

  7. Click Next. The Provide IT Resource Instance Data page for the Oracle HR IT resource is displayed.

  8. Specify values for the parameters of the Oracle HR IT resource. Refer to the table given in the "Defining IT Resources" section for information about the values to be specified.

  9. Click Next. The Provide IT Resource Instance Data page for a new instance of the Oracle HR IT resource type is displayed.

  10. Click Skip to specify that you do not want to define another IT resource. The Confirmation page is displayed.


    See Also:

    If you want to define another IT resource, then refer to Oracle Identity Manager Tools Reference Guide for instructions.

  11. Click View Selections.

    The contents of the XML file are displayed on the Import page. You may see a cross-shaped icon along with some nodes. Remove these nodes by right-clicking each node and then selecting Remove.

  12. Click Import. The connector file is imported into Oracle Identity Manager.

After you import the connector XML file, proceed to the "Step 6: Configuring Reconciliation" section.

Defining IT Resources

You must specify values for the following Oracle HR IT resource parameter.

Parameter Description
Admin User ID to connect to the Oracle e-Business Employee Reconciliation database

The default value is Apps.

AdminCredentials Password of the administrator
Host Host name or IP address of the Oracle e-Business Employee Reconciliation database
IsDebug Debug feature

The value can be YES or NO. The default value is NO.

OracleHREmp.Organization Name Default value for the Oracle Identity Manager Organization name

This value is used to create the Xellerate User in trusted mode. The default value is Xellerate Users.

Port TCP/IP port at which the Oracle e-Business Employee Reconciliation server is listening

The default value is 1521.

SID SID for the Oracle e-Business Employee Reconciliation database
TimeStamp Timestamp for the last reconciliation

After you specify values for the IT resource parameter, proceed to Step 9 of the procedure to import connector XML files.


Note:

You must use the existing standard APPS User for connecting to the Oracle e-Business Employee Reconciliation database because only this user has the rights required to update the database.

Step 6: Configuring Reconciliation

Configuring reconciliation involves the following steps:

Configuring Trusted Source Reconciliation


See Also:

Oracle Identity Manager Connector Framework Guide for conceptual information about reconciliation configurations

You do not need to perform any procedure to configure trusted source reconciliation. This target system is configured as a trusted source when you import the connector XML file.

Creating the Reconciliation Scheduled Tasks

To create the scheduled tasks for lookup fields and user reconciliations:

  1. Open the Oracle Identity Manager Design Console.

  2. Expand the Xellerate Administration folder.

  3. Select Task Scheduler.

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

  5. 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 ERROR status to the task.

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

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

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

  9. Provide values for the attributes of the scheduled task. Refer to the "Specifying Values for the Scheduled Task Attributes" section for information about the values to be specified.


    See Also:

    Oracle Identity Manager Design Console Guide for information about adding and removing task attributes

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

  11. Repeat Steps 5 through 10 to create the second scheduled task.

After you create the scheduled tasks, proceed to the "Configuring the Connector for Multiple Installations of the Target System" section.

Specifying Values for the Scheduled Task Attributes

This section provides information about the values to be specified for the following scheduled tasks:

Lookup Fields Reconciliation Scheduled Task

You must specify values for the following attributes of the lookup fields 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.

Attribute Description Default/Sample Value
Server Name of the IT resource instance that the connector uses to reconcile data Oracle HR
LookupField Name Name of the lookup field to be reconciled OracleHR.Employees

After you specify values for these task attributes, proceed to Step 10 of the procedure to create scheduled tasks.

Employee Reconciliation Scheduled Task

You must specify values for the following attributes of the employee 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.

Attribute Description Default/Sample Value
Target System Recon - Resource Object name Name of the resource object Oracle HR Employee
Server IT resource instance that the connector uses to reconcile data Oracle HR
IsTrusted Specifies whether or not reconciliation must be performed in trusted mode YES or NO

After you specify values for these task attributes, proceed to Step 10 of the procedure to create scheduled tasks.

Configuring the Connector for Multiple Installations of the Target System


Note:

Perform this procedure only if you want to configure the connector for multiple installations of Oracle e-Business Employee Reconciliation. Refer to Oracle Identity Manager Design Console Guide for detailed instructions on performing each step of this procedure.

To configure the connector for multiple installations of the target system:

  1. Create and configure one resource object for each target system installation.

    The Resource Objects form is in the Resource Management folder. The Oracle HR Employee resource object is created when you import the connector XML file. You can use this resource object as the template for creating the remaining resource objects.

  2. Create and configure one IT resource for each resource object.

    The IT Resources form is in the Resource Management folder. The Oracle HR IT resource is created when you import the connector XML file. You can use this IT resource as the template for creating the remaining IT resources, of the same resource type.

  3. Design one process form for each resource object.

    The Form Designer form is in the Development Tools folder. The UD_ORAHR_EM process form is created when you import the connector XML file.

    You can use this process form as a template for creating the remaining process forms.

  4. Create and configure one process definition for each resource object.

    The Process Definition form is in the Process Management folder. The Oracle HR Employee process definition is created when you import the connector XML file. You can use this process definition as the template for creating the remaining process definitions.

    While creating process definitions for each target system installation, the following steps that you must perform are specific to the creation of each process definition:

    • From the Object Name lookup field, select the resource object that you create in Step 1.

    • From the Table Name lookup field, select the process form that you create in Step 3.

  5. Configure reconciliation for each target system installation. Refer to the "Step 6: Configuring Reconciliation" section for instructions. Note that only the values of the following attributes are to be changed for each reconciliation scheduled task:

    • Target System Recon - Resource Object name

    • Server

    • IsTrusted

    Set the IsTrusted attribute to YES for the Oracle e-Business Employee Reconciliation installation that you want to designate as a trusted source. You can designate either a single or multiple installations of Oracle e-Business Employee Reconciliation as the trusted source. For the remaining Oracle e-Business Employee Reconciliation installations, set this attribute to NO.

  6. If required, modify the fields to be reconciled for the Xellerate User resource object.