| Oracle® Identity Manager Connector Guide for Database Application Tables Release 9.0.3 Part Number B32352-01 |
|
|
View PDF |
| Oracle® Identity Manager Connector Guide for Database Application Tables Release 9.0.3 Part Number B32352-01 |
|
|
View PDF |
Deploying the connector involves the following steps:
If you want to configure the connector for multiple sets of database application tables, 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 systems | The target system can be any one of the following:
|
| External code |
|
| Target system user account | If target database tables are to be created, then the user account must have the CONNECT privilege.
If existing target database tables are to be used, then the user account must have the following privileges on the tables:
You provide the credentials of this user account while performing the procedure in the "Defining IT Resources" section. |
In addition to the requirements mentioned in the preceding table, you must ensure that the following requirements are addressed:
JDBC connectivity is available to the target database.
The target database application schema is analyzed and the corresponding XML file is available according to the IT resource definition.
The JDBC driver and Xerces classes are available in the CLASSPATH environment variable on the Oracle Identity Manager server.
For secure connectivity to the target database, the required configuration has been performed on the database server.
You do not need to perform any configuration steps on the target system. However, to enable provisioning, reconciliation, or a combination of provisioning and reconciliation, you must modify and use one of the configuration XML files shipped on the installation media. Chapter 3 provides instructions to perform this procedure.
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:Database Servers\Database Application Table
Refer to the "Files and Directories That Comprise the Connector" section for more information about these files.
After you copy the connector files listed in the preceding table, copy the following files to the OIM_home\xellerate\ext directory:
If the target database is Oracle Database, then the ojdbc14.jar file is used. This file is already present in the OIM_home\xellerate\ext directory.
If the target database is Sysbase, then copy the sybase_installation\jConnect-5_2\classes\jconn2.jar file.
xerces.jar
This file is already present in the OIM_home\xellerate\ext directory.
Note:
While installing Oracle Identity Manager in a clustered environment, you copy the contents of the installation directory to each node of the cluster. Similarly, you must copy the
connectorResources directory and the JAR files to the corresponding directories on each node of the cluster.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.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 informational messages that highlight the progress of the application at 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 still 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:
For JBoss Application Server
In the JBoss_home\server\default\conf\log4j.xml file, locate the following lines of XML code:
<category name = "Adapter.DBAdapterLogger">
<priority value = "log_level"/>
</category>
In the second XML code line, replace log_level with the log level that you want to set. For example:
<category name = "Adapter.DBAdapterLogger"> <priority value = "WARN"/> </category>
After you enable logging, log information is written to the following file:
JBoss_home\server\default\log\server.log
For IBM WebSphere
Add the following line in the OIM_home\xellerate\config\log.properties file:
log4j.logger.Adapter.DBAdapterLogger=log_level
In this line, replace log_level with the log level that you want to set. For example:
log4j.logger.Adapter.DBAdapterLogger=INFO
After you enable logging, log information is written to the following file:
WebSphere_home\AppServer\logs\server_name\startServer.log
For BEA WebLogic
Add the following line in the OIM_home\xellerate\config\log.properties file:
log4j.logger.Adapter.DBAdapterLogger=log_level
In this line, replace log_level with the log level that you want to set. For example:
log4j.logger.Adapter.DBAdapterLogger=INFO
After you enable logging, log information is written to the following file:
WebLogic_home\user_projects\domains\domain_name\server_name\server_name.log
For OC4J
Add the following line in the OIM_home\xellerate\config\log.properties file:
log4j.logger.Adapter.DBAdapterLogger=log_level
In this line, replace log_level with the log level that you want to set. For example:
log4j.logger.Adapter.DBAdapterLogger=INFO
After you enable logging, log information is written to the following file:
OC4J_home\opmn\logs\default_group~home~default_group~1.log
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 DBTablesresadp.xml file, which is in the OIM_home\xellerate\XLIntegrations\xml\Xellerate Config 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 IT resource is displayed.
Specify values for the parameters of the IT resource. Refer to the table given 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 Database 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 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 IT resource parameters listed in the following table.
| Parameter | Description |
|---|---|
Database User ID |
Database user ID on the target database
Sample value: |
Database Password |
Database user password on the target database |
Database URL |
JDBC URL for the target database
Format and sample values for Oracle Database: jdbc:oracle:thin:@host:port:sid jdbc:oracle:thin@145.125.23.26:1521:cust_db jdbc:oracle:oci:userid/password@host:port:sid jdbc:oracle:oci:scott/tiger@145.125.23.26:1521:cust_db Format and sample values for Sybase: jdbc:sybase:Tds:host:port/database jdbc:sybase:Tds:123.432.154.12:2639/sales |
Database Driver |
JDBC driver class
Value for Oracle Database: oracle.jdbc.driver.OracleDriver Value for Sybase: com.sybase.jdbc3.jdbc.SybDriver |
Application Name |
Target application name
Sample value: |
Configuration XML Path |
Directory path and name of the configuration XML file
Sample value: OIM_home\xellerate\XLIntegrations\xml\DB_Schema\OraApp2.xml
Note: You must ensure that the path that you specify does not contain spaces. See Also: The "Files and Directories That Comprise the Connector" section for information about the various configuration XML files that are available in the connector installation media directory. Based on the description of each configuration XML file, select an XML file that meets your requirements. |
Reconciliation Timestamp |
Stores the last create/update reconciliation time
This value is updated by the reconciliation adapter. You need not manually provide any data. |
After you specify values for these IT resource parameters, proceed to Step 9 of the procedure to import connector XML files.
Note:
This section only provides information about setting up the reconciliation module. Refer to Chapter 3 for information about customizing reconciliation.Configuring reconciliation involves creating the reconciliation scheduled tasks:
Expand the Xellerate Administration folder.
Select Task Scheduler.
Click Find. The details of the predefined scheduled task are displayed.
Enter a number in the Max Retries field. This number represents the number of times Oracle Identity Manager must attempt to complete the task before assigning the ERROR status to the task.
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.
Note:
After you perform the instructions given in this chapter, refer to Chapter 3 for information about configuring the reconciliation module to reconcile new, modified, and deleted users.After you define the scheduled task, proceed to the "Step 7: Compiling Adapters" section.
You must specify values for the following attributes of the reconciliation scheduled task.
Note:
Attribute values are predefined in the connector XML file that you import. Specify values only for those attributes that you want to change.| Attribute | Description |
|---|---|
resource |
Name of the IT resource for which the reconciliation process is to be run
Sample value: |
application |
Name of the target database application that should be reconciled
Sample value: |
objectName |
Resource object name of the connector
Sample value: |
After you specify values for these scheduled 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 XML connector file:
DBRES Create User
DBRES Update First Name
DBRES Update Last Name
DBRES Update Password
DBRES Update Status
DBRES Update Title
DBRES Update Department
DBRES Update Email
DBRES Update Communication Language
DBRES Update Logon Language
DBRES Update Time Zone
DBRES Update Date Format
DBRES Update Telephone Number
DBRES Update Decimal Notation
DBRES Delete User
DBRES Update Role
DBRES Update Group
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 sets of database application tables. Refer to Oracle Identity Manager Design Console Guide for detailed instructions on performing each step of this procedure.To configure the connector for multiple sets of database application tables:
Create and configure one IT resource for each set of database application tables.
The IT Resources form is in the Resource Management folder. The Oracle Application2 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.
Configure reconciliation for each set of database application tables. Refer to the "Step 6: Configuring Reconciliation" section for instructions. Note that only the value of the resource attribute needs to be changed for each reconciliation scheduled task.
When you use the Administrative and User Console to perform provisioning, you can specify the IT resource corresponding to the set of database application tables to which you want to provision the user.
