Skip Headers
Oracle® Identity Manager Connector Guide for Oracle E-Business Employee Reconciliation
Release 9.0.4

E10434-05
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

2 Deploying the Connector

Deploying the connector involves the following steps:

2.1 Verifying Deployment Requirements

The following table lists the deployment requirements for the connector:

Item Requirement
Oracle Identity Manager Oracle Identity Manager release 9.1.0.1 or later
Target system Oracle E-Business Suite 11.5.10, 12.0.x
External code JDBC class library (classes12.jar/ojdbc14.jar)
Target system user account APPS system user with the required privileges

You provide the credentials of this user account while configuring the IT resource. The procedure to configure the IT resource is described later in this guide.

See "Configuring the Target System" for information about the procedure to create the APPS system user account. In this guide, this user account is also referred to as the target system account for connector operations.

JDK JDK 1.4.2

2.2 Using External Code Files

If the connector is used with Oracle8i Database, then the required external code file is classes12.jar.

If the connector is used with Oracle9i Database or Oracle Database 10g, then you can use either ojdbc14.jar or classes12.jar.

These JAR files are available in the Oracle Database installation at, for example, the following path:

ORACLE_HOME/jdbc/lib

In this directory path, ORACLE_HOME is the location where Oracle Database is installed. For example, C:\Oracle\ora92.

You must copy the required JAR file (classes12.jar or ojdbc14.jar) into the ORACLE_HOME/xellerate/ThirdParty directory.

2.3 Configuring the Target System

The connector uses a target system account to connect to the target system during reconciliation. You can use the script provided in the scripts directory on the installation media to create this account.

To create the target system user account for connector operations:

  1. Copy the scripts directory from the installation media to a temporary directory on either the target system server or to a computer on which the Oracle Database client has been installed.

  2. On the computer where you copy the scripts directory, verify that there is a TNS Entry in the tnsnames.ora file for the target system database.

  3. Depending on the host platform, run either the OIM.sh or OIM.bat file.

  4. When you run the script, you are prompted for the following information:

    • ORACLE_HOME path

      This prompt is displayed only if the ORACLE_HOME environment variable has not been set on the computer on which you are running the script.

    • Enter the system user name

      Enter the login (user name) of a DBA account with the privileges to create and configure a new target system user.

    • Enter the name of the database

      Enter the connection string or service name given in the tnsnames.ora file to connect to the target system database.

    • Enter password

      Enter the password of the DBA account whose login you enter earlier.

    • Details of the target system account that you want to create

      Enter a user name and password for the target system account that you want to create.

    • Connecting with APPS User

      Enter the password of the APPS User that can grant the required privileges to the target system account that you want to create.

    • Connecting with newly created database user

      Enter the connection string or service name that you provided earlier.

During the account creation process, the following privileges are granted to the account:

Note:

The OimUserGrants.sql file contains commands to grant these permissions.

At the end of the operation, a log file (OIM_APPS_USER.log) is created in the scripts directory. If no error messages are recorded in the log file, then the account has been created successfully.

2.4 Installing the Connector on Oracle Identity Manager Release 9.1.0 or Later

Note:

In this guide, the term Connector Installer has been used to refer to the Connector Installer feature of the Oracle Identity Manager Administrative and User Console.

Installing the connector on Oracle Identity Manager release 9.1.0 or later involves the following procedures:

2.4.1 Running the Connector Installer

To run the Connector Installer:

  1. Copy the contents of the connector installation media into the following directory:

    OIM_HOME/xellerate/ConnectorDefaultDirectory
    
  2. Log in to the Administrative and User Console by using the user account described in the "Creating the User Account for Installing Connectors" section of Oracle Identity Manager Administrative and User Console.

  3. Click Deployment Management, and then click Install Connector.

  4. From the Connector List list, select Oracle EBS Employee Reconciliation 9.0.4.3. This list displays the names and release numbers of connectors whose installation files you copy into the default connector installation directory:

    OIM_HOME/xellerate/ConnectorDefaultDirectory 
    

    If you have copied the installation files into a different directory, then:

    1. In the Alternative Directory field, enter the full path and name of that directory.

    2. To repopulate the list of connectors in the Connector List list, click Refresh.

    3. From the Connector List list, select Oracle EBS Employee Reconciliation 9.0.4.3.

  5. Click Load.

  6. To start the installation process, click Continue.

    The following tasks are performed in sequence:

    1. Configuration of connector libraries

    2. Import of the connector Target Resource user configuration XML file (by using the Deployment Manager). If you want to import the target system as a trusted source for reconciliation, then see "Configuring the Target System As a Trusted Source".

    3. Compilation of adapters

    On successful completion of a task, a check mark is displayed for the task. If a task fails, then an X mark and a message stating the reason for failure are displayed. Depending on the reason for the failure, make the required correction and then perform one of the following steps:

    • Retry the installation by clicking Retry.

    • Cancel the installation and begin again from Step 0.

  7. If all three tasks of the connector installation process are successful, then a message indicating successful installation is displayed. In addition, a list of the steps that you must perform after the installation is displayed. These steps are as follows:

    1. Ensuring that the prerequisites for using the connector are addressed

      Note:

      At this stage, run the PurgeCache utility to load the server cache with content from the connector resource bundle in order to view the list of prerequisites. Refer to "Clearing Content Related to Connector Resource Bundles from the Server Cache" for information about running the PurgeCache utility.

      There are no prerequisites for some predefined connectors.

    2. Configuring the IT resource for the connector

      Record the name of the IT resource displayed on this page. The procedure to configure the IT resource is described later in this guide.

    3. Configuring the scheduled tasks that are created when you installed the connector

      Record the names of the scheduled tasks displayed on this page. The procedure to configure these scheduled tasks is described later in this guide.

  8. Copy the files in the config directory on the installation media to the OIM_HOME/xellerate/XLIntegrations/OracleEmpRecon/config directory.

Note:

When you run the Connector Installer, it copies the connector files and external code files to destination directories on the Oracle Identity Manager host computer. These files are listed in Table 1-1.

Installing the Connector in an Oracle Identity Manager Cluster

While installing Oracle Identity Manager in a clustered environment, you must copy all the JAR files and the contents of the connectorResources directory into the corresponding directories on each node of the cluster. See "Files and Directories on the Installation Media" for information about the files that you must copy and their destination locations on the Oracle Identity Manager server.

2.4.2 Configuring the IT Resource

Note:

Perform this procedure if you are installing the connector on Oracle Identity Manager release 9.1.0 or later.

You must specify values for the parameters of the Oracle HR IT resource as follows:

  1. Log in to the Administrative and User Console.

  2. Expand Resource Management.

  3. Click Manage IT Resource.

  4. In the IT Resource Name field on the Manage IT Resource page, enter Oracle HR and then click Search.

  5. Click the edit icon for the IT resource.

  6. From the list at the top of the page, select Parameters.

  7. Specify values for the parameters of the IT resource. The following table describes each parameter:

    Parameter Description
    Admin User ID to connect to the target system database

    See "Configuring the Target System" for information about creating this user account.

    The default value is apps.

    See Also: "Configuring the Target System" for information about creating this account and assigning the required privileges to it

    AdminCredentials Password of the administrator
    Host Host name or IP address of the target system database
    Port TCP/IP port at which the Oracle E-Business Employee Reconciliation server is listening

    The default value is 1521.

    isSecure This parameter is meant for use in a future release of the connector. The default value is no. Do not change the default value.
    SID SID for the target system database
    TrustedTimeStamp This parameter is used for trusted source reconciliation.

    Starting with the first reconciliation run, this parameter stores the time-stamp value at which the reconciliation run ends.

    The default value is 0.

    The time-stamp value that this parameter accepts is of the LONG data type, which stores the date and time value in milliseconds. You can determine the LONG data type equivalent of the required time-stamp value by using a SQL query. For example, to determine the TimeStamp parameter value for the date 31-Jan-2006, run the following SQL query:

    SELECT ROUND((TO_DATE('31012006','ddmmyyyy') - TO_DATE('01011970', 'ddmmyyyy')) * 1440 * 60 * 1000) FROM dual;
    

    When you specify the output of this query as the value of the TimeStamp parameter, all records that are created or updated after 31-Jan-2006 are reconciled during the next reconciliation run.

    NonTrustedTimeStamp This parameter is used for target resource reconciliation.

    Starting with the first reconciliation run, this parameter stores the time-stamp value at which the reconciliation run ends.

    The default value is 0.

    The time-stamp value that this parameter accepts is of the LONG data type, which stores the date and time value in milliseconds. You can determine the LONG data type equivalent of the required time-stamp value by using a SQL query. For example, to determine the TimeStamp parameter value for the date 31-Jan-2006, run the following SQL query:

    SELECT ROUND((TO_DATE('31012006','ddmmyyyy') - TO_DATE('01011970', 'ddmmyyyy')) * 1440 * 60 * 1000) FROM dual;
    

    When you specify the output of this query as the value of the TimeStamp parameter, all records that are created or updated after 31-Jan-2006 are reconciled during the next reconciliation run.


  8. To save the values, click Save.

2.5 Installing the Connector on Oracle Identity Manager Release 8.5.3.1 Through 9.0.3.x

Installing the connector on any Oracle Identity Manager release between releases 8.5.3.1 and 9.0.3.x involves the following procedures:

2.5.1 Copying the Connector Files

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

See Also:

"Files and Directories on the Installation Media" section for more information about these files
File in the Installation Media Directory Destination Directory
Files in the config directory
OIM_HOME/xellerate/XLIntegrations/OracleEmpRecon/config
lib/xlReconOraHREmp.jar
OIM_HOME/xellerate/ScheduleTask
Files in the resources directory
OIM_HOME/xellerate/connectorResources
Files in the xml directory
OIM_HOME/xellerate/XLIntegrations/OracleEmpRecon/xml

Note:

In a clustered environment, copy the JAR files and the contents of the connectorResources directory to the corresponding directories on each node of the cluster.

2.5.2 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 opening files is displayed.

  4. Locate and open the oracleHRResAdp.xml file, which is in the OIM_HOME/xellerate/XLIntegrations/OracleEmpRecon/xml 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 following table for information about the values to be specified:

    Parameter Description
    Admin User ID to connect to the target system database

    The default value is apps.

    See Also: "Configuring the Target System" for information about creating this account and assigning the required privileges to it

    AdminCredentials Password of the administrator
    Host Host name or IP address of the target system database
    Port TCP/IP port at which the Oracle E-Business Employee Reconciliation server is listening

    The default value is 1521.

    isSecure This parameter is meant for use in a future release of the connector. The default value is no. Do not change the default value.
    SID SID for the target system database
    TrustedTimeStamp This parameter is used for trusted source reconciliation.

    Starting with the first reconciliation run, this parameter stores the time-stamp value at which the reconciliation run ends.

    The default value is 0.

    The time-stamp value that this parameter accepts is of the LONG data type, which stores the date and time value in milliseconds. You can determine the LONG data type equivalent of the required time-stamp value by using a SQL query. For example, to determine the TimeStamp parameter value for the date 31-Jan-2006, run the following SQL query:

    SELECT ROUND((TO_DATE('31012006','ddmmyyyy') - TO_DATE('01011970', 'ddmmyyyy')) * 1440 * 60 * 1000) FROM dual;
    

    When you specify the output of this query as the value of the TimeStamp parameter, all records that are created or updated after 31-Jan-2006 are reconciled during the next reconciliation run.

    NonTrustedTimeStamp This parameter is used for target resource reconciliation.

    Starting with the first reconciliation run, this parameter stores the time-stamp value at which the reconciliation run ends.

    The default value is 0.

    The time-stamp value that this parameter accepts is of the LONG data type, which stores the date and time value in milliseconds. You can determine the LONG data type equivalent of the required time-stamp value by using a SQL query. For example, to determine the TimeStamp parameter value for the date 31-Jan-2006, run the following SQL query:

    SELECT ROUND((TO_DATE('31012006','ddmmyyyy') - TO_DATE('01011970', 'ddmmyyyy')) * 1440 * 60 * 1000) FROM dual;
    

    When you specify the output of this query as the value of the TimeStamp parameter, all records that are created or updated after 31-Jan-2006 are reconciled during the next reconciliation run.


  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 Administrative and User Console 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. These nodes represent Oracle Identity Manager entities that are redundant. Before you import the connector XML file, you must remove these entities by right-clicking each node and then selecting Remove.

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

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

2.6.1 Changing to the Required Input Locale

Changing to the required input locale (language and country setting) involves installing the required fonts and setting the required input locale.

You may require the assistance of the system administrator to change to the required input locale.

2.6.2 Clearing Content Related to Connector Resource Bundles from the Server Cache

While performing the instructions described in the "Copying the Connector Files" section, you copy files from the resources directory on the installation media into the OIM_HOME/xellerate/connectorResources directory. Whenever you add a new resource bundle in the connectorResources directory or make a change in an existing resource bundle, 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.

    Note:

    You must perform Step 1 before you perform Step 2. An exception is thrown if you run the command described in Step 2 as follows:
    OIM_HOME\xellerate\bin\batch_file_name
    
  2. Enter one of the following commands:

    • On Microsoft Windows:

      PurgeCache.bat ConnectorResourceBundle
      
    • On UNIX:

      PurgeCache.sh ConnectorResourceBundle
      

    Note:

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

    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
    

2.6.3 Enabling Logging

When you enable logging, Oracle Identity Manager automatically stores in a log file information about events that occur during the course of reconciliation operations. To specify the type of event for which you want logging to take place, you can set the log level to one of the following:

  • ALL

    This level enables logging for all events.

  • DEBUG

    This level enables logging of information about fine-grained events that are useful for debugging.

  • INFO

    This level enables logging of messages that highlight the progress of the application at a coarse-grained level.

  • WARN

    This level enables logging of information about potentially harmful situations.

  • ERROR

    This level enables logging of information about error events that may allow the application to continue running.

  • FATAL

    This level enables logging of information about very severe error events that could cause the application to stop functioning.

  • OFF

    This level disables logging for all events.

The file in which you set the log level depends on the application server that you use:

  • Oracle WebLogic Server

    To enable logging:

    1. Add the following line in the OIM_HOME/xellerate/config/log.properties file:

      log4j.logger.ADAPTER.ORACLEEMPRECON=log_level
      
    2. In this line, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.ADAPTER.ORACLEEMPRECON=INFO
      

    After you enable logging, log information is displayed on the server console.

  • IBM WebSphere Application Server

    To enable logging:

    1. Add the following line in the OIM_HOME/xellerate/config/log.properties file:

      log4j.logger.ADAPTER.ORACLEEMPRECON=log_level
      
    2. In this line, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.ADAPTER.ORACLEEMPRECON=INFO
      

    After you enable logging, log information is written to the following file:

    WEBSPHERE_HOME/AppServer/logs/SERVER_NAME/SystemOut.log
    
  • JBoss Application Server

    To enable logging:

    1. In the JBoss_home/server/default/conf/log4j.xml file, add the following lines if they are not already present in the file:

      <category name="ADAPTER.ORACLEEMPRECON">
         <priority value="log_level"/>
      </category>
      
    2. In the second XML code line, replace log_level with the log level that you want to set. For example:

      <category name="ADAPTER.ORACLEEMPRECON">
         <priority value="INFO"/>
      </category>
      

    After you enable logging, log information is written to the following file:

    JBoss_home/server/default/log/server.log
    
  • Oracle Application Server

    To enable logging:

    1. Add the following line in the OIM_HOME/xellerate/config/log.properties file:

      log4j.logger.ADAPTER.ORACLEEMPRECON=log_level
      
    2. In this line, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.ADAPTER.ORACLEEMPRECON=INFO
      

    After you enable logging, log information is written to the following file:

    OC4J_home/opmn/logs/default_group~home~default_group~1.log