Skip Headers
Oracle® Identity Manager Connector Guide for RSA ClearTrust
Release 9.0.4

E10440-07
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

The procedure to deploy the connector can be divided into the following stages:

2.1 Preinstallation

Preinstallation information is divided across the following sections:

2.1.1 Files and Directories That Comprise the Connector

The files and directories on the installation media are listed and described in Table 2-1.

Table 2-1 Files and Directories on the Installation Media

File in the Installation Media Directory Description

configuration/

RSACT_CI.xml

DataSets/ModifyResourceClearTrust.xml

DataSets/ProvisionResourceClearTrust.xml

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

lib/xliClearTrust.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 releases 9.0.1 through 9.0.3.2 and 9.1.0.x: OIM_HOME/xellerate/JavaTasks

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

lib/xliClearTrustRecon.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 releases 9.0.1 through 9.0.3.2 and 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 releases 9.0.1 through 9.0.3.2 and 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.

tests/config/config.properties

This file contains the properties that are used to connect to the target system for testing purposes.

tests/lib/xliClearTrustTest.jar

This JAR file contains test classes that are used for testing purposes.

xml/RSAClearTrustResourceObject.xml

This XML file contains the definitions of the objects that constitute the connector.

xml/RSAClearTrustXLResourceObject.xml

This 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. Section 2.3.1, "Configuring Trusted Source Reconciliation" provides instructions.


2.1.2 Determining the Release Number of the Connector

Note:

If you are using Oracle Identity Manager releases 9.0.1 through 9.0.3.2 or 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 can use the following method to determine the release number of the connector:

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

    OIM_HOME/xellerate/JavaTasks/xliClearTrust.jar

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

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

2.1.3 Using External Code Files

Copy the ct_admin_api.jar and ct_runtime_api.jar files from the CLEARTRUST_INSTALLATION_DIR/lib directory to the following directories:

  • On Oracle Identity Manager releases 9.0.1 through 9.0.3.2 and 9.1.0.x, copy the files to the OIM_HOME/xellerate/ThirdParty and OIM_HOME/xellerate/ext directories.

  • On Oracle Identity Manager release 11.1.1, copy the files to the OIM_HOME/server/ThirdParty and OIM_HOME/server/ext directories.

2.2 Installation

Depending on the release of Oracle Identity Manager that you use, perform the procedures described in one of the following sections:

2.2.1 Installing the Connector on Oracle Identity Manager Releases 9.0.1 Through 9.0.3.2

Installing the connector on Oracle Identity Manager releases 9.0.1 through 9.0.3.2 involves performing the following procedures:

2.2.1.1 Copying the Connector Files

Table 2-2 lists the files to be copied and the directories to which you must copy them.

Note:

The directory paths given in the first column of this table correspond to the location of the connector files on the installation media. See Section 2.1.1, "Files and Directories That Comprise the Connector" for more information about these files.

While installing Oracle Identity Manager in a cluster, 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.

Table 2-2 Connector Files to Be Copied

File in the Installation Media Directory Destination Directory

lib/xliClearTrust.jar

OIM_HOME/xellerate/JavaTasks

lib/xliClearTrustRecon.jar

OIM_HOME/xellerate/ScheduleTask

Files in the resources directory

OIM_HOME/xellerate/connectorResources

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.

Files and directories in the tests directory on the installation media

OIM_HOME/xellerate/tests

Files in the xml directory on the installation media

OIM_HOME/xellerate/XLIntegrations/ClearTrust/xml


2.2.1.2 Compiling Adapters

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.8.2, "User Provisioning Functions" for a listing of the provisioning functions that are available with this connector
  • CTUpdateUserProperty

  • CTUpdateGroup

  • CTStringTask

  • CTModifyUser

  • CTDeleteUser

  • CTDeleteGroup

  • CTCreateUser

  • CTAssign Default Group

  • CTAddGroup

  • CTPrepopStartDate

  • CTPrepopString

  • CTPrepopDateAddOneYear

  • CTEmailValidation

  • CTAdd Default Group to User

  • CTEndOrPwdExpDateValidatio

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. In an Oracle Identity Manager cluster, 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.2.2 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 involves performing the following procedures:

2.2.2.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, perform this step on 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 RSA ClearTrust 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 RSA ClearTrust 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). If you want to import the target system as a trusted source for reconciliation, then see Section 2.3.1, "Configuring Trusted Source Reconciliation."

    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 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.3.3, "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

      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.

      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 Section 2.1.1, "Files and Directories That Comprise the Connector."

Installing the Connector in an Oracle Identity Manager Cluster

While installing Oracle Identity Manager in a cluster, 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.1.1, "Files and Directories That Comprise the Connector" for information about the files that you must copy and their destination locations on the Oracle Identity Manager server.

2.2.2.2 Configuring the IT Resource

You must specify values for the parameters of the ClearTrust 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 section, click Manage IT Resource.

  4. In the IT Resource Name field on the Manage IT Resource page, enter ClearTrust 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 IT resource. Table 2-3 describes each parameter.

    Table 2-3 IT Resource Parameters

    Parameter Description

    CTAdminUserId

    Enter the name of the RSA ClearTrust administrator.

    This is a required parameter.

    CTAdminPassword

    Enter the password of the RSA ClearTrust administrator.

    This is a required parameter.

    MachineName or IPAddress

    Enter the host name or IP address of the computer on which the RSA ClearTrust Entitlements Server is running.

    This is a required parameter.

    Port

    Enter the port number at which the RSA ClearTrust Entitlements Server is listening.

    This is a required parameter. The default value is 5601.

    SSLMode

    Specify whether SSL mode is used to connect to the RSA ClearTrust server.

    This is a required parameter.

    You can specify yes, no, or SSL_ANON as the value of this parameter. SSL_ANON stands for anonymous SSL, which means that neither the client nor the server needs to present a certificate when establishing a connection.

    Note: It is recommended that you enable SSL to secure communication with the target system.

    TimeOut

    Specify a timeout value for the connection that is established between Oracle Identity Manager and RSA ClearTrust.

    This is a required parameter.

    Default User Group

    Enter the name of the default user group in RSA ClearTrust.

    This is a required parameter.

    CaFileLocation

    Enter the location of the CA certificate.

    This parameter is used only with mutual authentication.

    CaPassword

    Enter the password for the CA certificate.

    This parameter is used only with mutual authentication.

    KsFileLocation

    Enter the location of the keystore file.

    This parameter is used only with mutual authentication.

    KsPassword

    Enter the password of the keystore file.

    This parameter is used only with mutual authentication.

    KeyAlias

    Enter the key name that is to be used with the keystore file.

    This parameter is used only with mutual authentication.

    PrivatePassword

    Enter the password for the private key in the keystore file.

    This parameter is used only with mutual authentication.

    TimeStamp

    For the first target resource reconciliation run, this parameter does not hold any value. For subsequent rounds of reconciliation, the time at which the previous reconciliation run was completed is stored in this parameter.See Section 3.3.1, "Full Reconciliation vs. Incremental Reconciliation" for information about using this parameter to switch from incremental to full reconciliation.

    CTAdmin Group

    Enter the name of the group to which the RSA ClearTrust administrative user belongs.

    CTAdmin Role

    Enter the role of the RSA ClearTrust administrative user.

    Target Locale: Country

    Enter the country code.

    Default value: US

    Note: You must specify the value in uppercase.

    Target Locale: Language

    Enter the language code.

    Default value: en

    Note: You must specify the value in lowercase.


  8. To save the values, click Update.

2.3 Postinstallation

This section discusses the following topics:

2.3.1 Configuring Trusted Source Reconciliation

Note:

This section describes an optional procedure. Perform the procedure only if you want to configure the connector for 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.

Configuring trusted source reconciliation involves the following steps:

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

    Note:

    Only one target system can be designated as a trusted source. If you import the RSAClearTrustXLResourceObject.xml file while you have another trusted source configured, then both connector reconciliations would stop working.
  2. Ensure that the value of the Trusted Source Recon - Resource Object name attribute of the ClearTrust Reconciliation Task scheduled task is Xellerate User. See Section 3.3.4, "User Reconciliation Scheduled Task" for information about this scheduled task.

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 releases 9.0.1 through 9.0.3.2 or 9.1.0.x, then:

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

    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 RSAClearTrustXLResourceObject.xml file, which is in the xml directory on the installation media.

  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 specify values for the attributes of the ClearTrust Reconciliation Task scheduled task. This procedure is described in Section 3.4, "Configuring Scheduled Tasks."

2.3.2 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.3.3 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 releases 9.0.1 through 9.0.3.2 and 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 releases 9.0.1 through 9.0.3.2 and 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 releases 9.0.1 through 9.0.3.2 and 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 releases 9.0.1 through 9.0.3.2 and 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.3.4 Enabling Logging

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

2.3.4.1 Enabling Logging on Oracle Identity Manager Releases 9.0.1 through 9.0.3.2 and 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.ADAPTERS.CTINTEGRATION=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.ADAPTERS.CTINTEGRATION=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="XELLERATE">
         <priority value="log_level"/>
      </category>
      
      <category name="ADAPTERS.CTINTEGRATION">
         <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="ADAPTERS.CTINTEGRATION">
         <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.ADAPTERS.CTINTEGRATION=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.ADAPTERS.CTINTEGRATION=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.ADAPTERS.CTINTEGRATION=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.ADAPTERS.CTINTEGRATION=INFO
      

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

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

Table 2-4 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='rsa-ct-handler' 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="ADAPTERS.CTINTEGRATION" level="[LOG_LEVEL]" useParentHandlers="false">
           <handler name="rsa-ct-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-4 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='rsa-ct-handler' 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="ADAPTERS.CTINTEGRATION" level="NOTIFICATION:1" useParentHandlers="false">
           <handler name="rsa-ct-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.3.5 Configuring the Oracle Identity Manager System Property for the Date Format

To configure the Oracle Identity Manager system property for the date format:

  1. Open the Oracle Identity Manager Design Console.

  2. Navigate to the System Configuration page.

  3. Check if there is an entry for "Default date format." If this entry is not present, then perform the remaining steps of this procedure.

  4. Add a new entry in the Server category:

    • Name: Default date format

    • Keyword: XL.DefaultDateFormat

    • Value: yyyy/MM/dd hh:mm:ss z

  5. Click Save.

2.3.6 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 RSA ClearTrust 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.3.6.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 are the predefined request datasets available in the DataSets directory on the installation media:

  • ModifyResourceClearTrust.xml

  • ProvisionResourceClearTrust.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\ClearTrust

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.3.6.2 Importing Request Datasets into MDS

All request datasets must be imported into MDS, which can be done by using the 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.3.6.1, "Copying Predefined Request Datasets," if you copy the files to the E:\MyDatasets\custom\connector\ClearTrust 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 at the following location:

    /custom/connector/RESOURCE_NAME

2.3.6.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 CT Users process definition.

  4. Select the Auto Save Form check box.

  5. Click the Save icon.

2.3.6.4 Running the PurgeCache Utility

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

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