2 Deploying the Connector

This chapter is divided into the following sections:

2.1 Files and Directories on the Installation Media

Table 2-1 describes the files and directories on the installation media.

Table 2-1 Files and Directories On the Connector Installation Media

File in the Installation Media Directory Description

configuration/JDEdwards-CI.xml

This XML file contains configuration information that is used during connector installation.

Files in the DataSets directory

These XML files specify the information to be submitted by the requester during a request-based provisioning operation.

lib/JDEConnectorProv.jar

This JAR file contains the class files required for provisioning. During connector installation, this file is copied to the following location:

  • For Oracle Identity Manager release 9.1.0.x: OIM_HOME/xellerate/JavaTasks

  • For Oracle Identity Manager release 11.1.1: Oracle Identity Manager database

lib/JDEConnectorRecon.jar

This JAR file contains the class files required for reconciliation. During connector installation, this file is copied to the following location:

  • For Oracle Identity Manager release 9.1.0.x: OIM_HOME/xellerate/ScheduleTask

  • For Oracle Identity Manager release 11.1.1: Oracle Identity Manager database

Files in the resources directory

Each of these resource bundles contains language-specific information that is used by the connector. During connector installation, these resource bundles are copied to the following location:

  • For Oracle Identity Manager release 9.1.0.x: OIM_HOME/xellerate/connectorResources

  • For Oracle Identity Manager release 11.1.1: Oracle Identity Manager database

Note: A resource bundle is a file containing localized versions of the text strings that are displayed on the Administrative and User Console. These text strings include GUI element labels and messages.

test/TroubleShootUtility.class

This utility is used to test connector functionality.

test/global.properties

This file is used to specify the parameters and settings required to connect to the target system by using the Troubleshoot utility.

test/log.properties

This file is used to specify the log level and the directory in which the log file is to be created when you run the Troubleshoot utility.

xml/JDEConnectorResourceObject.xml

This XML file contains definitions for the following components of the connector:

  • IT resource definition

  • JD Edwards User form

  • Lookup definitions

  • Adapters

  • Resource object

  • Process definition

  • Reconciliation scheduled tasks

    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.

xml/JDEConnectorXLResourceObject.xml

This XML file contains the configuration for the Xellerate User (OIM User). You must import this file only if you plan to use the connector in trusted source reconciliation mode.


Note:

The files in the test directory are used only to run tests on the connector.

2.2 Determining the Release Number of the Connector

Note:

If you are using Oracle Identity Manager release 9.0.1 through 9.0.3.2 or release 9.1.0.x, then the procedure described in this section is optional.

If you are using Oracle Identity Manager release 11.1.1, then skip this section.

You might have a deployment of an earlier release of the connector. While deploying the latest release, you might want to know the release number of the earlier release. To determine the release number of the connector that has already been deployed:

  1. In a temporary directory, extract the contents of the following JAR file:

    OIM_HOME/xellerate/JavaTasks/JDEConnectorProv.jar

  2. Open the manifest.mf file in a text editor. The manifest.mf file is one of the files bundled inside the JDEConnectorProv.jar file.

    In the manifest.mf file, the release number of the connector is displayed as the value of the Version property.

2.3 Using External Code Files

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 contents of the connectorResources directory and the JAR files to the corresponding directories on each node of the cluster.

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

File on the Target System Server Destination Directory

The following JAR files from the JDE_INSTALLATION_DIR/E812/DDP/system/classes directory on the JD Edwards EnterpriseOne server:

  • ApplicationAPIs_JAR.jar

  • Base_JAR.jar

  • BizLogicContainer_JAR.jar

  • BizLogicContainerClient_JAR.jar

  • BusinessLogicServices_JAR.jar

  • castor.jar

  • Connector.jar

  • Generator_JAR.jar

  • JdbjBase_JAR.jar

  • JdbjInterfaces_JAR.jar

  • JdeNet_JAR.jar

  • log4j.jar

  • Metadata.jar

  • MetadataInterface.jar

  • PMApi_JAR.jar

  • Spec_JAR.jar

  • System_JAR.jar

  • xalan.jar

  • xerces.jar

  • xml-apis.jar

  • jmxremote_optional.jar

  • ManagementAgent_JAR.jar

  • SystemInterfaces_JAR.jar

  • jmxri.jar

For Oracle Identity Manager release 9.0.1 through 9.0.3.2 or release 9.1.0.x: OIM_HOME/xellerate/ThirdParty

For Oracle Identity Manager release 11.1.1: The JAR files on the JD Edwards Target System Server must be copied to the Oracle Identity Manager database.

To copy these JAR files, run the Upload JARs utility from the temporary location to the Oracle Identity Manager database. This utility is copied into the following location when you install Oracle Identity Manager:

Note: Before you run this utility, verify that the WL_HOME environment variable is set to the directory in which Oracle WebLogic Server is installed.

For Microsoft Windows:

OIM_HOME/server/bin/UploadJars.bat

For UNIX:

OIM_HOME/server/bin/UploadJars.sh

When you run the utility, you are prompted to enter the login credentials of the Oracle Identity Manager administrator, URL of the Oracle Identity Manager host computer, context factory value, type of JAR file being uploaded, and the location from which the JAR file is to be uploaded. To upload these JARs, specify 3 as the value of the JAR type.

Extract the following template files from the JDE_INSTALLATION_DIR/E812/DDP/system/classes/samples/ConnectorSamples.zip file:

  • jdbj.ini.templ

  • jdeinterop.ini.templ

  • jdelog.properties

Rename the jdbj.ini.templ file to jdbj.ini, and rename the jdeinterop.ini.templ file to jdeinterop.ini.

Then, copy all three files to the specified destination directory.

For Oracle Identity Manager release 9.0.1 through 9.0.3.2 or release 9.1.0.x: OIM_HOME/xellerate/JDE/Properties

For Oracle Identity Manager release 11.1.1: OIM_HOME/server/JDE/Properties

If the EnterpriseOne server is running on Oracle Database, then copy the tnsnames.ora file to the specified destination directory.

For Oracle Identity Manager release 9.0.1 through 9.0.3.2 or release 9.1.0.x: OIM_HOME/xellerate/JDE/Properties

For Oracle Identity Manager release 11.1.1: OIM_HOME/server/JDE/Properties


2.3.1 Changes to Be Made in the Property Files

You must modify the following property files to suit your deployment requirements:

Note:

The lists of configuration properties included in the following subsections are not comprehensive and include only those properties that are essential for the functioning of the connector. The files allow further customization of the connector functionality with other optional properties. Explicit descriptions and instructions to use the other configuration properties are included in the configuration files.

2.3.1.1 jdbj.ini

You must modify the jdbj.ini file based on your requirements. This file contains configuration information for JDBj, which provides general database access capabilities for JD Edwards EnterpriseOne.

Note:

All property values in this file are case-sensitive.

In the [JDBj-BOOTSTRAP SESSION] section of this file, specify values for the parameters described in the following table:

Property Sample Value Description

user

user=JDE

User ID to connect to the target system

This is an optional parameter.

password

password=Password

Password of the user

This is an optional parameter.

environment

environment=PY812

Environment in which the user connects to the target system

The is a required parameter and must be specified in the jdbj.ini file.

The target system provides the following environments in which a user can access the system:

  • Development Environment (DV812)

  • Production Environment (PD812)

  • Prototype Environment (PY812)

  • Pristine Environment (PS812)

To access the system in a particular environment, the user needs privileges for that environment.

role

role=*ALL

Role of the connecting user

This is an optional parameter.


In the [JDBj-BOOTSTRAP DATA SOURCE] section of this file, specify values for the properties specified in the following table.

Property Description

name

Name of the data source

This property is not important for bootstrap connections. However, it shows up in error messages and logs.

Sample value: name=System - 812

databaseType

Type of database used by the target system

This value depends on the database used by the system. It can be any of the following:

  • I = AS/400

  • O = Oracle

  • S = SQL Server

  • W = UDB

  • M = MSDE

Sample value: databaseType=O

server

Name of the EnterpriseOne host server.

Applicable for IBM AS/400 and SQL Server.

Sample value: server=ibm1

serverPort

EnterpriseOne host server port number.

Applicable only for Microsoft SQL Server

database

Database instance name

Applicable only for Oracle Database and IBM DB2 UDB

Sample value: database=ora10g

physicalDatabase

The physical database (used as library qualifier for IBM AS/400).

This is applicable for Microsoft SQL Server and IBM AS/400

owner

Owner of the data source

This is applicable for Oracle Database, Microsoft SQL Server, and IBM DB2 UDB.

Sample value: owner=SY812

lob

Boolean value that indicates support for LOBs.

This is applicable for Oracle Database and IBM AS/400.

Sample value: lob=Y

unicode

Boolean value that indicates support for Unicode conversion is supported.

This is applicable for Microsoft SQL Server.

Sample value: unicode=N


Note:

A client of the EnterpriseOne server, also known as the Fat Client, has settings that correspond with the settings in the [JDBj-BOOTSTRAP DATA SOURCE] section in the jdbj.ini file. The values in this file must match those specified on the Fat Client. On the Fat Client, these settings are in the [DB SYSTEM SETTINGS] section of the jde.ini file.

In the [JDBj-JDBC DRIVERS] section of this file, specify the JDBC driver to connect to EnterpriseOne server. To do this, uncomment the line that specifies the driver for the database you are using. For example, if you are using Oracle Database, uncomment the line that specifies the driver for Oracle Database.

ORACLE=oracle.jdbc.driver.OracleDriver

In the [JDBj-ORACLE] section of this file, specify the location of the tnsnames.ora that you copy from the EnterpriseOne server. The following setting is required only when you use Oracle Database:

tns=OIM_HOME/Xellerate/JDE/Properties/tnsnames.ora

2.3.1.2 jdeinterop.ini

The jdeinterop.ini file is a configuration file that is used by the connector to enable interoperability between the Oracle Identity Manager and JD Edwards system.

Modify the jdeinterop.ini file and specify values for the properties described in the following table:

Section in the File Property/Sample Value Description

[OCM]

OCMEnabled=false

Boolean value that specifies whether the connector uses Object Configuration Mapping (OCM) to find the EnterpriseOne server

[JDENET]

serviceNameConnect=6014

Port number to connect to EnterpriseOne server from Oracle Identity Manager

[SERVER]

glossaryTextServer=ibm1:6014

Name and port number to connect to glossary Text server

 

codePage=1252

Code page number for a particular language

[SECURITY]

SecurityServer=ibm1

Name of the security server

Note: The security server is the same as the EnterpriseOne server.

[INTEROP]

enterpriseServer=ibm1

Name of the EnterpriseOne server

 

port=6014

Port number to connect to EnterpriseOne server


2.3.1.3 jdelog.properties

You can customize this file to enable logging at different levels. To enable logging, you must specify the properties described in the following table:

Property Description Sample Value

FILE

Location of the log file

FILE=//jderoot.log

LEVEL

Logging level

You can specify any of the following values:

  • SEVERE

  • WARN

  • APPS

  • DEBUG

These values are in decreasing order of priority.

LEVEL=WARN

FORMAT

Logging format

This property can be set to:

  • APPS

  • TOOLS

  • TOOLS_THREAD

In a production environment, this must be set to APPS.

FORMAT=APPS

MAXFILESIZE

Maximum size of the log file in MB

MAXFILESIZE=10MB

MAXBACKUPINDEX

Maximum number of log file backups to be maintained

MAXBACKUPINDEX=20

COMPONENTS

Components for which events are logged in the log file

You can specify other components as well. A list of all the components is specified in the template for this file.

COMPONENT=RUNTIME|JAS|JDBJ

APPEND

Boolean value that specifies that log entries must be appended at the end of the file

The value can be TRUE or FALSE.

APPEND=TRUE


After configuring the property files, you must add the directory in which the property files are present to the classpath environment variable. This variable is on the application server where Oracle Identity Manager is installed. The procedure to set the classpath depends on the application server on which Oracle Identity Manager is installed:

2.3.1.3.1 Setting the Classpath on Oracle WebLogic Server Running on Microsoft Windows

To add the directory into the classpath in the WebLogic Application Server on Windows:

  1. In the WebLogic server installation directory, navigate to the domain name directory.

  2. Open the startWebLogic.cmd file in a text editor.

  3. Edit the following command:

    set CLASSPATH=%WEBLOGIC_CLASSPATH%;%POINTBASE_CLASSPATH%;%JAVA_HOME%\jre\lib\rt.jar;%WL_HOME%\server\lib\webservices.jar;%CLASSPATH%
    

    Add the JDE_CONFIG directory into the classpath that contains the property files as shown below:

    set CLASSPATH= JDE_CONFIG;JDBC_DRIVER_JAR_PATH;%WEBLOGIC_CLASSPATH%;%POINTBASE_CLASSPATH%;%JAVA_HOME%\jre\lib\rt.jar;%WL_HOME%\server\lib\webservices.jar;%CLASSPATH%
    

    In this command:

    • Replace JDE_CONFIG with full path and name of the JDE_CONFIG directory. This directory contains the property files jdbj.ini, jdeinterop.ini, and jdelog.properties.

    • Replace JDBC_DRIVER_JAR_PATH with the full path and name of the JDBC driver JAR.

2.3.1.3.2 Setting the Classpath on Oracle WebLogic Server Running on Linux

To add the directory into the classpath in the WebLogic Application Server on Linux:

  1. In the WebLogic server installation directory, navigate to the domain name directory.

  2. Open the startWebLogic.sh file in a text editor.

  3. Edit the following command:

    CLASSPATH="${WEBLOGIC_CLASSPATH}:${POINTBASE_CLASSPATH}:${JAVA_HOME}/jre/lib/rt.jar:${WL_HOME}/server/lib/webservices.jar:${CLASSPATH}"
    

    Add the JDE_CONFIG directory into the classpath that contains the property files as shown below:

    CLASSPATH=JDE_CONFIG:${WEBLOGIC_CLASSPATH}:${POINTBASE_CLASSPATH}:${JAVA_HOME}/jre/lib/rt.jar:${WL_HOME}/server/lib/webservices.jar:${CLASSPATH}"
    )
    

    In this command, replace JDE_CONFIG with full path and name of the JDE_CONFIG directory. This directory contains the property files jdbj.ini, jdeinterop.ini, and jdelog.properties.

2.3.1.3.3 Setting the Classpath on IBM WebSphere Application Server on Microsoft Windows

To add the directory into the classpath in the WebSphere Application Server on Windows:

  1. In the WebSphere server installation directory, navigate to the bin directory.

  2. Open startServer.bat in a text editor.

  3. Edit the following command:

    set CLASSPATH=%WAS_CLASSPATH%
    

    Add the JDE_CONFIG directory into the classpath that contains the property files as shown below:

    set CLASSPATH=JDE_CONFIG;%WAS_CLASSPATH%
    

    In this command, replace JDE_CONFIG with full path and name of the JDE_CONFIG directory. This directory contains the property files jdbj.ini, jdeinterop.ini, and jdelog.properties.

2.3.1.3.4 Setting the Classpath on JBoss Application Server Running on Microsoft Windows

To add the directory into the classpath in the JBoss Application Server on Windows:

  1. In the JBoss installation directory, navigate to the bin directory.

  2. Open the run.bat file in a text editor.

  3. Edit the following command:

    if "%JBOSS_CLASSPATH%" == "" (
    set JBOSS_CLASSPATH=%JAVAC_JAR%;%RUNJAR%
    ) ELSE (
    set JBOSS_CLASSPATH=%JBOSS_CLASSPATH%;%JAVAC_JAR%;%RUNJAR%
    )
    

    Add the JDE_CONFIG directory into the classpath that contains the property files as shown below:

    if "%JBOSS_CLASSPATH%" == "" (
    set JBOSS_CLASSPATH=JDE_CONFIG;%JAVAC_JAR%;%RUNJAR%
    ) ELSE (
    set
    JBOSS_CLASSPATH=JDE_CONFIG;%JBOSS_CLASSPATH%;%JAVAC_JAR%;%RUNJAR%
    ) 
    

    In this command, replace JDE_CONFIG with full path and name of the JDE_CONFIG directory. This directory contains the property files jdbj.ini, jdeinterop.ini, and jdelog.properties.

2.3.1.3.5 Setting the Classpath on JBoss Application Server Running on Linux

To add the directory into the classpath in the JBoss Application Server on Linux:

  1. In the JBoss installation directory, navigate to the bin directory.

  2. Open the run.sh file in a text editor.

  3. Edit the following command:

    if [ "x$JBOSS_CLASSPATH" = "x" ]; then JBOSS_CLASSPATH="$JBOSS_BOOT_CLASSPATH:$JAVAC_JAR"ELSE JBOSS_CLASSPATH="$JBOSS_CLASSPATH:$JBOSS_BOOT_CLASSPATH:$JAVAC_JAR"fi
    

    Add the JDE_CONFIG directory into the classpath that contains the property files as shown below:

    if [ "x$JBOSS_CLASSPATH" = "x" ]; then JBOSS_CLASSPATH="$JBOSS_BOOT_CLASSPATH:$JAVAC_JAR"ELSE
    JBOSS_CLASSPATH="$JBOSS_CLASSPATH:$JBOSS_BOOT_CLASSPATH:$JAVAC_JAR"fi
    JBOSS_CLASSPATH=JDE_CONFIG:$JBOSS_CLASSPATH
    

    In this command, replace JDE_CONFIG with the full path and name of the JD Edwards configuration directory. This directory contains the jdbj.ini, jdeinterop.ini, and jdelog.properties files.

2.3.1.3.6 Setting the Classpath on Oracle Application Server

To set the classpath on Oracle Application Server, you must perform the following steps:

  1. Add the directory into the classpath in the Oracle application server as follows:

    1. In the Oracle application server installation directory, navigate to the opmn directory.

    2. Open the opmn.xml file in a text editor.

    3. Edit the following command:

      -Xbootclasspath^/p:D:\product\10.1.3.1\OracleAS_3\bpel\lib\orabpel-boot.jar
      

      Add the JDE_CONFIG directory into the classpath that contains the property files as shown below:

      -Xbootclasspath^/p:D:\product\10.1.3.1\OracleAS_3\bpel\lib\orabpel-boot.jar; JDE_CONFIG
      

      In this command, replace JDE_CONFIG with full path and name of the JDE_CONFIG directory. This directory contains the property files jdbj.ini, jdeinterop.ini, and jdelog.properties.

  2. Create a shared library in Oracle Application Server as follows:

    1. Login to the Oracle Application Server Enterprise Management Console, and select the application server.

    2. From the Server Components list, select home of OIM Instance.

    3. Click the Administration tab, select Shared Libraries, and then click Go To Task.

    4. Click Create, and provide the name and version of the Shared Library, for example:

      • Shared Library Name: SHARED_LIBRARY_NAME

      • Shared Library Version: SHARED_LIBRARY_VERSION_NUMBER

    5. Click Next, and then click ADD to display the list of third-party JAR files. Add these JAR files to the Shared Library created in Step d.

    6. Click Finish.

    7. Navigate and open the application.xml file from the Oracle Application Server installation directory, for example:

      /product/10.1.3.1/OAS_DIRECTORY/j2ee/home/config

    8. Add the imported-shared-libraries element for the Shared Library in the application.xml file as follows:

      <imported-shared-libraries>
      <import-shared-library name="SHARED_LIBRARY_NAME"/>
      </imported-shared-libraries>
      
    9. Save the application.xml file.

    10. Restart Oracle Identity Manager.

      You can, for example, run the following command to restart Oracle Identity Manager:

      pomnctl stopproc/startpoc process-type=OIM_INSTANCE_NAME 
      

2.4 Installing the Connector on Oracle Identity Manager Release 9.1.0.x or Release 11.1.1

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.x or release 11.1.1 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 directory into the following directory:

    Note:

    In an Oracle Identity Manager cluster, copy this JAR file to each node of the cluster.

    • For Oracle Identity Manager release 9.1.0.x: OIM_HOME/xellerate/ConnectorDefaultDirectory

    • For Oracle Identity Manager release 11.1.1: OIM_HOME/server/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 the following guide:

    • For Oracle Identity Manager release 9.1.0.x:

      Oracle Identity Manager Administrative and User Console Guide

    • For Oracle Identity Manager release 11.1.1:

      Oracle Fusion Middleware System Administrator's Guide for Oracle Identity Manager

  3. Depending on the Oracle Identity Manager release you are using, perform one of the following steps:

    • For Oracle Identity Manager release 9.1.0.x:

      Click Deployment Management, and then click Install Connector.

    • For Oracle Identity Manager release 11.1.1:

      On the Welcome to Identity Manager Advanced Administration page, in the System Management region, click Install Connector.

  4. From the Connector List list, select JDEdwards RELEASE_NUMBER. This list displays the names and release numbers of connectors whose installation files you copy into the default connector installation directory in Step 1.

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

  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 XML files (by using the Deployment Manager)

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

  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 Oracle Identity Manager PurgeCache utility to load the server cache with content from the connector resource bundle in order to view the list of prerequisites. See Section 2.6.2, "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.

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 2-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 Section 2.6.2, "Clearing Content Related to Connector Resource Bundles from the Server Cache" 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

You must specify values for the parameters of the JDE IT Resource IT resource as follows:

  1. Log in to the Administrative and User Console.

  2. If you are using Oracle Identity Manager release 9.1.0.x, expand Resource Management, and then click Manage IT Resource.

  3. If you are using Oracle Identity Manager release 11.1.1, then:

    • On the Welcome page, click Advanced in the upper-right corner of the page.

    • On the Welcome to Oracle Identity Manager Advanced Administration page, in the Configuration region, click Manage IT Resource.

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

  5. Click the edit icon for the IT resource.

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

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

    Parameter Description

    User

    User ID of the user account for connecting to the target system

    Note: The value for this parameter must be entered in uppercase.

    Password

    Password of the user account for connecting to the target system

    Note: The value for this parameter must be entered in uppercase.

    Environment

    Environment of the user account for connecting to the target system

    Sample value: DV812

    Role

    Role of the user account for connecting to the target system

    Sample value: *ALL

    ProxyUser

    User ID of the system user in the target system

    Note: The value for this parameter must be entered in uppercase.

    ProxyUserPassword

    Password of the system user in the target system

    Note: The value for this parameter must be entered in uppercase.

    TimeStamp

    Timestamp for the first reconciliation run, the timestamp value is not set. For subsequent rounds of reconciliation, the time at which the previous round of reconciliation was completed is stored in this parameter.

    The following is sample timestamp value:

    Jun 01, 2006 at 10:00:00 GMT+05:30

    Configuration Lookup

    Name of the lookup definition that contains the configuration information used during connector operations.

    Default value: Lookup.JDE.Configuration


  8. To save the values, click Update.

2.5 Installing the Connector on Oracle Identity Manager Release 9.0.1 Through 9.0.3.2

Installing the connector on any Oracle Identity Manager release between releases 9.0.1 and 9.0.3.2 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:

Section 2.1, "Files and Directories on the Installation Media" for more information about these files

File in the Installation Media Directory Destination Directory

Files in the xml directory

OIM_HOME/xellerate/JDE/xml

Files in the resources directory

OIM_HOME/xellerate/connectorResources

lib/JDEConnectorProv.jar

OIM_HOME/xellerate/JDE/lib

OIM_HOME/xellerate/JavaTasks

lib/JDEConnectorRecon.jar

OIM_HOME/xellerate/JDE/lib

OIM_HOME/xellerate/ScheduleTask

Files in the test directory

OIM_HOME/xellerate/JDE/test


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

As mentioned in Section 2.1, "Files and Directories on the Installation Media," the connector XML file contains definitions of the components of the connector. By importing the connector XML file, you create these components in Oracle Identity Manager.

To import the connector XML file into Oracle Identity Manager:

  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 JDEConnectorResourceObject.xml file, which is in the OIM_HOME/xellerate/JDE/xml directory. Details of this XML file are shown on the File Preview page.

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

  6. Click Next. The Confirmation page is displayed.

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

  8. Specify values for the parameters of the JDE IT Resource IT resource. See the following table for information about the values to be specified:

    Parameter Description

    User

    User ID of the user account for connecting to the target system

    Note: The User ID value must be entered in uppercase.

    Password

    Password of the user account for connecting to the target system

    Note: The Password value must be entered in uppercase.

    Environment

    Environment of the user account for connecting to the target system

    Sample value: DV812

    Role

    Role of the user account for connecting to the target system

    Sample value: *ALL

    ProxyUser

    User ID of the system user in the target system

    Note: The ProxyUser ID value must be entered in uppercase.

    ProxyUserPassword

    Password of the system user in the target system

    Note: The ProxyUserPassword value must be entered in uppercase.

    TimeStamp

    Timestamp for the first reconciliation run, the timestamp value is not set. For subsequent rounds of reconciliation, the time at which the previous round of reconciliation was completed is stored in this parameter.

    The following is sample timestamp value:

    Jun 01, 2006 at 10:00:00 GMT+05:30

    Configuration Lookup

    Name of the lookup definition that contains the configuration information used during connector operations.

    Default value: Lookup.JDE.Configuration


  9. Click Next. The Provide IT Resource Instance Data page for a new instance of the JDE 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 XML file is imported into Oracle Identity Manager.

2.5.3 Compiling Adapters

Note:

Skip this section if you do not want to use the provisioning features of Oracle Identity Manager for this target system.

Adapters are used to implement provisioning functions. The following adapters are imported into Oracle Identity Manager when you import the connector XML file:

See Also:

Section 1.6.5, "Provisioning Functions" for a listing of the provisioning functions that are available with this connector

  • Enable and Disable User

  • JDE Delete User

  • Modify Password

  • PrePopulate JDE Form

  • JDE Remove Role

  • JDE Modify User

  • JDE Create User

  • JDE Add Role

You must compile these adapters before they can be used in provisioning operations.

To compile adapters by using the Adapter Manager form:

  1. Open the Adapter Manager form.

  2. To compile all the adapters that you import into the current database, select Compile All.

    To compile multiple (but not all) adapters, select the adapters you want to compile. Then, select Compile Selected.

    Note:

    Click Compile Previously Failed to recompile only those adapters that were not compiled successfully. Such adapters do not have an OK compilation status.

  3. Click Start. Oracle Identity Manager compiles the selected adapters.

  4. If Oracle Identity Manager is installed in a clustered environment, then copy the compiled adapters from the OIM_HOME/xellerate/Adapter directory to the same directory on each of the other nodes of the cluster. If required, overwrite the adapter files on the other nodes.

If you want to compile one adapter at a time, then use the Adapter Factory form.

See Also:

Oracle Identity Manager Tools Reference Guide for information about using the Adapter Factory and Adapter Manager forms

To view detailed information about an adapter:

  1. Highlight the adapter in the Adapter Manager form.

  2. Double-click the row header of the adapter, or right-click the adapter.

  3. Select Launch Adapter from the shortcut menu that is displayed. Details of the adapter are displayed.

2.6 Configuring the Oracle Identity Manager Server

Configuring the Oracle Identity Manager server involves performing the following procedures:

2.6.1 Changing to the Required Input Locale

Note:

In an Oracle Identity Manager cluster, you must perform this step on each node of the cluster.

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

Note:

In an Oracle Identity Manager cluster, you must perform this step on each node of the cluster. Then, restart each node.

When you deploy the connector, the resource bundles are copied from the resources directory on the installation media into the OIM_HOME/xellerate/connectorResources directory for Oracle Identity Manager release 9.0.3.2 and release 9.1.0.x, and Oracle Identity Manager database for Oracle Identity Manager release 11.1.1. Whenever you add a new resource bundle to 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, perform one of the following steps:

    • If you are using Oracle Identity Manager release 9.0.3.x or release 9.1.0.x, then switch to the OIM_HOME/xellerate/bin directory.

    • If you are using Oracle Identity Manager release 11.1.1, then switch to the OIM_HOME/server/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:

    For Oracle Identity Manager release 9.0.3.2 or release 9.1.0.x:

    OIM_HOME/xellerate/bin/SCRIPT_FILE_NAME
    

    For Oracle Identity Manager release 11.1.1:

    OIM_HOME/server/bin/SCRIPT_FILE_NAME
    
  2. Enter one of the following commands:

    Note:

    You can use the PurgeCache utility to purge the cache for any content category. Run PurgeCache.bat CATEGORY_NAME on Microsoft Windows or PurgeCache.sh CATEGORY_NAME on UNIX. The CATEGORY_NAME argument represents the name of the content category that must be purged.

    For example, the following commands purge Metadata entries from the server cache:

    PurgeCache.bat MetaData

    PurgeCache.sh MetaData

    • For Oracle Identity Manager release 9.0.3.2 or release 9.1.0.x:

      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. This exception is different from the one mentioned in Step 1.

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

      OIM_HOME/xellerate/config/xlconfig.xml

    • For Oracle Identity Manager release 11.1.1:

      On Microsoft Windows: PurgeCache.bat All

      On UNIX: PurgeCache.sh All

      When prompted, enter the user name and password of an account belonging to the SYSTEM ADMINISTRATORS group. In addition, you are prompted to enter the service URL in the following format:

      t3://OIM_HOST_NAME:OIM_PORT_NUMBER
      

      In this format:

      • Replace OIM_HOST_NAME with the host name or IP address of the Oracle Identity Manager host computer.

      • Replace OIM_PORT_NUMBER with the port on which Oracle Identity Manager is listening.

    See Oracle Fusion Middleware System Administrator's Guide for Oracle Identity Manager for more information about the PurgeCache utility.

2.6.3 Enabling Logging

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

2.6.3.1 Enabling Logging on Oracle Identity Manager Release 9.0.1 through 9.0.3.2 or Release 9.1.0.x

Note:

In an Oracle Identity Manager cluster, perform this procedure on each node of the cluster. Then, restart each node.

When you enable logging, Oracle Identity Manager automatically stores in a log file information about events that occur during the course of provisioning and 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 might 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 and the log file path depend on the application server that you use:

  • IBM WebSphere Application Server

    To enable logging:

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

      log4j.logger.XELLERATE=log_level
      log4j.logger.XL_INTG.JDECONNECTOR=log_level
      
    2. In these lines, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.XELLERATE=INFO
      log4j.logger.XL_INTG.JDECONNECTOR=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, locate or add the following lines if they are not already present in the file:

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

      <category name="XELLERATE">
         <priority value="INFO"/>
      </category>
      
      <category name="XL_INTG.JDECONNECTOR">
         <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 lines in the OIM_HOME/xellerate/config/log.properties file:

      log4j.logger.XELLERATE=log_level
      log4j.logger.XL_INTG.JDECONNECTOR=log_level
      
    2. In these lines, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.XELLERATE=INFO
      log4j.logger.XL_INTG.JDECONNECTOR=INFO
      

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

    ORACLE_HOME/opmn/logs/default_group~home~default_group~1.log
    
  • Oracle WebLogic Server

    To enable logging:

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

      log4j.logger.XELLERATE=log_level
      log4j.logger.XL_INTG.JDECONNECTOR=log_level
      
    2. In these lines, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.XELLERATE=INFO
      log4j.logger.XL_INTG.JDECONNECTOR=INFO
      

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

2.6.3.2 Enabling Logging on Oracle Identity Manager Release 11.1.1

Note:

In an Oracle Identity Manager cluster, perform this procedure on each node of the cluster. Then, restart each node.

Oracle Identity Manager release 11.1.1 uses Oracle Java Diagnostic Logging (OJDL) for logging. OJDL is based on java.util.logger. 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:

  • SEVERE.intValue()+100

    This level enables logging of information about fatal errors.

  • SEVERE

    This level enables logging of information about errors that might allow Oracle Identity Manager to continue running.

  • WARNING

    This level enables logging of information about potentially harmful situations.

  • INFO

    This level enables logging of messages that highlight the progress of the application.

  • CONFIG

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

  • FINE, FINER, FINEST

    These levels enable logging of information about fine-grained events, where FINEST logs information about all events.

These log levels are mapped to ODL message type and level combinations as shown in Table 2-2.

Table 2-2 Log Levels and ODL Message Type:Level Combinations

Log Level ODL Message Type:Level

SEVERE.intValue()+100

INCIDENT_ERROR:1

SEVERE

ERROR:1

WARNING

WARNING:1

INFO

NOTIFICATION:1

CONFIG

NOTIFICATION:16

FINE

TRACE:1

FINER

TRACE:16

FINEST

TRACE:32


The configuration file for OJDL is logging.xml, which is located at the following path:

DOMAIN_HOME/config/fmwconfig/servers/OIM_SERVER/logging.xml

Here, DOMAIN_HOME and OIM_SERVER are the domain name and server name specified during the installation of Oracle Identity Manager.

To enable logging in Oracle WebLogic Server:

  1. Edit the logging.xml file as follows:

    1. Add the following blocks in the file:

      <log_handler name='JDECONNECTOR' level='[LOG_LEVEL]' class='oracle.core.ojdl.logging.ODLHandlerFactory'>
      <property name='logreader:' value='off'/>
           <property name='path' value='[FILE_NAME]'/>
           <property name='format' value='ODL-Text'/>
           <property name='useThreadName' value='true'/>
           <property name='locale' value='en'/>
           <property name='maxFileSize' value='5242880'/>
           <property name='maxLogSize' value='52428800'/>
           <property name='encoding' value='UTF-8'/>
         </log_handler>
      
      <logger name="XL_INTG.JDECONNECTOR" level="[LOG_LEVEL]" useParentHandlers="false">
           <handler name="jdeconnector-handler"/>
           <handler name="console-handler"/>
         </logger>
      
    2. Replace both occurrences of [LOG_LEVEL] with the ODL message type and level combination that you require. Table 2-2 lists the supported message type and level combinations.

      Similarly, replace [FILE_NAME] with the full path and name of the log file in which you want log messages to be recorded.

      The following blocks show sample values for [LOG_LEVEL] and [FILE_NAME] :

      <log_handler name='JDECONNECTOR' level='NOTIFICATION:1' class='oracle.core.ojdl.logging.ODLHandlerFactory'>
      <property name='logreader:' value='off'/>
           <property name='path' value='F:\MyMachine\middleware\user_projects\domains\base_domain1\servers\oim_server1\logs\oim_server1-diagnostic-1.log'/>
           <property name='format' value='ODL-Text'/>
           <property name='useThreadName' value='true'/>
           <property name='locale' value='en'/>
           <property name='maxFileSize' value='5242880'/>
           <property name='maxLogSize' value='52428800'/>
           <property name='encoding' value='UTF-8'/>
         </log_handler>
       
      <logger name="OIMCP.JDECONNECTOR" level="NOTIFICATION:1" useParentHandlers="false">
           <handler name="jdeconnector-handler"/>
           <handler name="console-handler"/>
         </logger>
      

    With these sample values, when you use Oracle Identity Manager, all messages generated for this connector that are of a log level equal to or higher than the NOTIFICATION:1 level are recorded in the specified file.

  2. Save and close the file.

  3. Set the following environment variable to redirect the server logs to a file:

    For Microsoft Windows:

    set WLS_REDIRECT_LOG=FILENAME
    

    For UNIX:

    export WLS_REDIRECT_LOG=FILENAME
    

    Replace FILENAME with the location and name of the file to which you want to redirect the output.

  4. Restart the application server.

2.6.4 Configuring Trusted Source Reconciliation

While configuring the connector, the target system can be designated as a trusted source or target resource. If you designate the target system as a trusted source, then during a reconciliation run:

  • For each newly created user on the target system, an OIM User is created.

  • Updates made to each user on the target system are propagated to the corresponding OIM User.

If you designate the target system as a target resource, then during a reconciliation run:

  • For each account created on the target system, a resource is assigned to the corresponding OIM User.

  • Updates made to each account on the target system are propagated to the corresponding resource.

Note:

Skip this section if you do not want to designate the target system as a trusted source for reconciliation.

Enabling trusted source reconciliation involves the following steps:

  1. Import the XML file for trusted source reconciliation, JDEConnectorXLResourceObject.xml, by using the Deployment Manager. This section describes the procedure to import the XML file.

  2. Set the isTrustedSource scheduled task attribute to True. You specify a value for this attribute while configuring the user reconciliation scheduled task, which is described later in this guide.

To import the XML file for trusted source reconciliation:

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

  2. If you are using Oracle Identity Manager release 9.0.1 through 9.0.3.2 or release 9.1.0.x, then:

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

    2. Click the Import link under Deployment Management. A dialog box for opening files is displayed.

  3. If you are using Oracle Identity Manager release 11.1.1, then:

    1. On the Welcome page, click Advanced in the upper-right corner of the page.

    2. On the Welcome to Oracle Identity Manager Advanced Administration page, in the System Management region, click Import Deployment Manager File. A dialog box for opening files is displayed.

  4. Locate and open the JDEConnectorXLResourceObject.xml file located in the following directory:

    • For Oracle Identity Manager release 9.0.1 through 9.0.3.2 or release 9.1.0.x:

      OIM_HOME/xellerate/ConnectorDefaultDirectory/JDE_RELEASE_NUMBER/xml

    • For Oracle Identity Manager release 11.1.1:

      OIM_HOME/server/ConnectorDefaultDirectory/JDE_RELEASE_NUMBER/xml

    Details of this XML file are shown on the File Preview page.

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

  6. Click Next. The Confirmation page is displayed.

  7. Click Import.

  8. In the message that is displayed, click Import to confirm that you want to import the XML file and then click OK.

After you import the XML file for trusted source reconciliation, you must set the value of the isTrustedSource reconciliation scheduled task attribute to True. This procedure is described in Section 3.4, "Configuring Scheduled Tasks."

2.6.5 Configuring Oracle Identity Manager for Request-Based Provisioning

Note:

Perform the procedure described in this section only if you are using Oracle Identity Manager release 11.1.1 and you want to configure request-based provisioning.

In request-based provisioning, an end user creates a request for a resource by using the Administrative and User Console. Administrators or other users can also create requests for a particular user. Requests for a particular resource on the resource can be viewed and approved by approvers designated in Oracle Identity Manager.

The following are features of request-based provisioning:

  • A user can be provisioned only one resource (account) on the target system.

    Note:

    Direct provisioning allows the provisioning of multiple target system accounts on the target system.

  • Direct provisioning cannot be used if you enable request-based provisioning.

To configure request-based provisioning, perform the following procedures:

2.6.5.1 Copying Predefined Request Datasets

A request dataset is an XML file that specifies the information to be submitted by the requester during a provisioning operation. Predefined request datasets are shipped with this connector. These request datasets specify information about the default set of attributes for which the requester must submit information during a request-based provisioning operation. The following predefined request datasets are available in the DataSets directory on the installation media:

  • ProvisionResourceJDE User.xml

  • ModifyResourceJDE User.xml

Copy these files from the installation media to any directory on the Oracle Identity Manager host computer. It is recommended that you create a directory structure as follows:

/custom/connector/RESOURCE_NAME

For example:

E:\MyDatasets\custom\connector\JDE

Note:

Until you complete the procedure to configure request-based provisioning, ensure that there are no other files or directories inside the parent directory in which you create the directory structure. In the preceding example, ensure that there are no other files or directories inside the E:\MyDatasets directory.

The directory structure to which you copy the dataset files is the MDS location into which these files are imported after you run the Oracle Identity Manager MDS Import utility. The procedure to import dataset files is described in the next section.

Depending on your requirement, you can modify the file names of the request datasets. In addition, you can modify the information in the request datasets. See Oracle Fusion Middleware Developer's Guide for Oracle Identity Manager for information on modifying request datasets.

2.6.5.2 Importing Request Datasets into MDS

All request datasets must be imported into the metadata store (MDS), which can be done by using the Oracle Identity Manager MDS Import utility.

To import a request dataset definition into MDS:

  1. Ensure that you have set the environment for running the MDS Import utility. See Oracle Fusion Middleware Developer's Guide for Oracle Identity Manager for detailed information about setting up the environment for MDS utilities.

    Note:

    While setting up the properties in the weblogic.properties file, ensure that the value of the metadata_from_loc property is the parent directory of the /custom/connector/RESOURCE_NAME directory. For example, while performing the procedure in Section 2.6.5.1, "Copying Predefined Request Datasets," if you copy the files to the E:\MyDatasets\custom\connector\JDE directory, then set the value of the metada_from_loc property to E:\MyDatasets.

  2. In a command window, change to the OIM_HOME\server\bin directory.

  3. Run one of the following commands:

    • On Microsoft Windows

      weblogicImportMetadata.bat
      
    • On UNIX

      weblogicImportMetadata.sh
      
  4. When prompted, enter the following values:

    • Please enter your username [weblogic]

      Enter the username used to log in to the WebLogic server

      Sample value: WL_User

    • Please enter your password [weblogic]

      Enter the password used to log in to the WebLogic server.

    • Please enter your server URL [t3://localhost:7001]

      Enter the URL of the application server in the following format:

      t3://HOST_NAME_IP_ADDRESS:PORT

      In this format, replace:

      • HOST_NAME_IP_ADDRESS with the host name or IP address of the computer on which Oracle Identity Manager is installed.

      • PORT with the port on which Oracle Identity Manager is listening.

    The request dataset is imported into MDS.

2.6.5.3 Enabling the Auto Save Form Feature

To enable the Auto Save Form feature:

  1. Log in to the Design Console.

  2. Expand Process Management, and then double-click Process Definition.

  3. Search for and open the JDE Process process definition.

  4. Select the Auto Save Form check box.

  5. Click the Save icon.

2.6.5.4 Running the PurgeCache Utility

Run the PurgeCache utility to clear content belonging to the Metadata category from the server cache. See Section 2.6.2, "Clearing Content Related to Connector Resource Bundles from the Server Cache" for instructions.

The procedure to configure request-based provisioning ends with this step.