Oracle® Identity Manager Connector Guide for Oracle e-Business User Management Release 9.0.3 Part Number B32362-01 |
|
|
View PDF |
Deploying the connector involves the following steps:
If you want to configure the connector for multiple installations of Oracle e-Business User Management, then perform the following procedure:
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 )
Refer to the "Step 3: Copying the Connector Files and External Code" section for information about the location of this file. |
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. |
For this connector, you do not need to perform any configuration steps on the target system.
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 directory on the installation media:Enterprise Applications\Oracle e-Business\Oracle e-Business User Management
Refer to the "Files and Directories That Comprise the Connector" section for more information about these files.
Copy the JDBC class library (classes12.jar
) from the oracle_home
\ora92\jdbc\lib\
directory to the OIM_home
\xellerate\ThirdParty
directory.
In this directory path, oracle_home
is the directory in which Oracle9i Database is installed. For example, C:\Oracle.
Add this file along with its path in the value of the CLASSPATH
environment variable.
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 theconnectorResources
directory and the JAR files to the corresponding directories on each node of the cluster.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.Changing to the required input locale (language and country setting) 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.Open Control Panel.
Double-click Regional Options.
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.
Whenever you add a new resource bundle in the OIM_home
\xellerate\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:
In a command window, change to the OIM_home
\xellerate\bin
directory.
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.To import the connector XML file into Oracle Identity Manager:
Open the Oracle Identity Manager Administrative and User Console.
Click the Deployment Management link on the left navigation bar.
Click the Import link under Deployment Management. A dialog box for locating files is displayed.
Locate and open the OracleAppsResAdp.xml
file, which is in the OIM_home
\xlclient
directory. Details of this XML file are shown on the File Preview page.
Click Add File. The Substitutions page is displayed.
Click Next. The Confirmation page is displayed.
Click Next. The Provide IT Resource Instance Data page for the Oracle Apps Server
IT resource is displayed.
Specify values for the parameters of the Oracle Apps Server
IT resource. Refer to the table in the "Defining IT Resources" section for information about the values to be specified.
Click Next. The Provide IT Resource Instance Data page for a new instance of the ORACLE
IT resource type is displayed.
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.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.
Click Import. The connector XML file is imported into Oracle Identity Manager.
After you import the connector XML file, proceed to the "Step 6: Configuring Reconciliation" section.
You must specify values for the Oracle Apps Server
IT resource parameters listed in the following table.
Parameter | Description |
---|---|
Admin |
User ID to connect to the Oracle e-Business User Management database
The default value is |
AdminCredentials |
Password of the administrator |
Host |
Host name or IP address of the Oracle e-Business User Management server |
IsDebug |
Debug feature
The value can be |
Port |
TCP/IP port at which the Oracle e-Business User Management server is listening.
The default value is |
SID |
SID for the Oracle e-Business User Management server |
TimeStamp |
Timestamp for the last reconciliation run
The default value is 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 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 |
ResetPswdOnFirstLogon |
Specifies whether or not users are to be prompted to change their passwords at first logon
The value can be |
After you specify values for these IT resource parameters, proceed to Step 9 of the procedure to import connector XML files.
Note:
You must use the existing standard APPS User to connect to the Oracle e-Business User Management database because only this user has the rights required to update the database.Configuring reconciliation involves the following steps:
Note:
Perform this step of the procedure only if you want to configure trusted source reconciliation. Only one connector can be configured for trusted source reconciliation. If you import theXellUserOraApps.xml
file while you have another trusted source configured, then both connector reconciliations would stop working.
Refer to Oracle Identity Manager Connector Framework Guide for conceptual information about reconciliation configurations.
To configure trusted source reconciliation, you must first import the XML file for trusted source reconciliation as follows:
Open the Oracle Identity Manager Administrative and User Console.
Click the Deployment Management link on the left navigation bar.
Click the Import link under Deployment Management. A dialog box for locating files is displayed.
Locate and open the XellUserOraApps.xml
file, which is in the OIM_home
\xlclient
directory. Details of this XML file are shown on the File Preview page.
Click Add File. The Substitutions page is displayed.
Click Next. The Confirmation page is displayed.
Click Import.
In the message that is displayed, click Import to confirm that you want to import the XML file and then click OK.
Then, set the value of the IsTrusted
reconciliation scheduled task attribute to YES
while performing the procedure described in the following section.
To create the scheduled tasks for lookup fields and user reconciliations:
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. This number represents the number of times Oracle Identity Manager should 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. 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 attributesClick 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.
Repeat Steps 5 through 10 to create the second scheduled task.
After you create both scheduled tasks, proceed to the "Step 7: Compiling Adapters" section.
This section provides information about the values to be specified for the following scheduled tasks:
You must specify values for the following attributes of the lookup fields reconciliation scheduled task.
After you specify values for these task attributes, proceed to Step 10 of the procedure to create scheduled tasks.
You must specify values for the following attributes of the user reconciliation scheduled task.
Attribute | Description | Default/Sample Value |
---|---|---|
Target System |
Name of the resource object | OracleAppsServer |
Server |
Name of the IT resource instance for Oracle e-Business User Management | Oracle Apps Server |
IsTrusted |
Specifies whether or not reconciliation is to be performed in trusted mode | Yes or No
The default is |
LinkKey |
Key to decide the linking condition to link an APPS user to an employee | EMAIL or USERNAME |
LinkField |
Name of the employee ID field used in the Oracle e-Business Employee Reconciliation connector | USR_UDF_EMPLOYEE_ID |
After you specify values for these task attributes, proceed to Step 10 of the procedure to create scheduled tasks.
The following adapters are imported into Oracle Identity Manager when you import the connector XML file:
adpORACLEAPPSCREATEUSER
adpORACLEAPPSRESETPASSWORD
adpORACLEAPPSUPDATEUSER
adpORACLEAPPSUPDATEUSERDATE
adpORACLEAPPSENABLEUSER
adpORACLEAPPSADDRESPONSIBILITY
adpORACLEAPPSREMOVERESPONSIBILITY
adpUPDATEORACLEAPPSLIFESPAN
adpORACLEAPPSDISABLEUSER
You must compile these adapters before you can use them to provision accounts on the target system.
To compile adapters by using the Adapter Manager form:
Open the Adapter Manager form.
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 anOK
compilation status.Click Start. Oracle Identity Manager compiles the selected adapters.
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.
To view detailed information about an adapter:
Highlight the adapter in the Adapter Manager form.
Double-click the row header of the adapter, or right-click the adapter.
Select Launch Adapter from the shortcut menu that is displayed. Details of the adapter are displayed.
Note:
Perform this procedure only if you want to configure the connector for multiple installations of Oracle e-Business User Management. 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:
Create and configure one resource object for each target system installation.
The Resource Objects form is in the Resource Management folder. The OracleAppsServer
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.
Create and configure one IT resource for each resource object.
The IT Resources form is in the Resource Management folder. The Oracle Apps Server
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.
Design one process form for each resource object.
The Form Designer form is in the Development Tools folder. The following process forms are created when you import the connector XML file:
UD_ORACLE_A
(main form)
UD_RESPONS
(child form)
You can use these process forms as templates for creating the remaining process forms.
Create and configure one process definition for each resource object.
The Process Definition form is in the Process Management folder. The OracleAppsUser
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.
While mapping the adapter variables for the IT Resource data type, ensure that you select the IT resource that you create in Step 2 from the Qualifier list.
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
Server
IsTrusted
Set the IsTrusted
attribute to Yes
for the Oracle e-Business User Management installation that you want to designate as a trusted source. You can designate either a single or multiple installations of Oracle e-Business User Management as the trusted source. For the remaining Oracle e-Business User Management installations, set this attribute to No
.
If required, modify the fields to be reconciled for the Xellerate User resource object.
When you use the Administrative and User Console to perform provisioning, you can specify the IT resource corresponding to the Oracle e-Business User Management installation to which you want to provision the user.