2 Deploying the Connector

Deploying the connector involves the following steps:

2.1 Files and Directories on the Installation Media

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/UNIX Telnet-CI.xml

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

ext/sshfactory.jar

This file contains the JSCAPE libraries. These libraries are used to open an Telnet session with the target server. During connector deployment, this file is copied to the following location:

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

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

lib/xliTelnet.jar

This JAR file contains the Java classes that are required for provisioning and reconciliation in Telnet. During connector deployment, this file is copied to the following location:

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

    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/config/config.properties

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

test/config/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 testing utility.

config/userAttribute_NonAIX_prov.properties

This file contains the parameters required for dynamic provisioning on non-AIX platforms.

config/userAttribute_AIX_prov.properties

This file contains the parameters required for dynamic provisioning on AIX platform.

config/userAttribute_NonAIX_recon.properties

This file contains the parameters required for dynamic reconciliation on non-AIX platforms.

config/userAttribute_AIX_recon.properties

This file contains the parameters required for dynamic reconciliation on AIX platform.

test/scripts/Telnet.bat

test/scripts/telnet.sh

This file contains the script required to run the client for running test calls from the Oracle Identity Manager server.

xml/TelnetNonTrustedUser.xml

This file contains definitions for the following Telnet User components of the connector:

  • IT resource type

  • IT resource

  • Resource object

  • Process definition

  • Process tasks

  • Adapters

  • Process form

  • Reconciliation scheduled task

xml/XellTelnetUser.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.

xml/TelnetConnectorRequestDatasets.xml

This file contains the request datasets for the connector. You import this file by using the Deployment Manager.


2.2 Determining the Release Number of the Connector

Note:

If you are using Oracle Identity Manager release 9.1.0.1, 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/xliTelnet.jar

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

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

2.3 Configuring the Target System

This section provides instructions to configure the target system on the following platforms:

2.3.1 Configuration Steps for Solaris and Linux

Perform the following steps for Solaris and Linux environments:

  1. Ensure that the /etc/passwd and /etc/shadow files are available on the UNIX server.

  2. Create a passwd mirror file on the target server by using a command similar to the following:

    cp /etc/passwd /etc/passwd1
    

    You can specify any destination directory and file name when you run the command. While configuring the IT resource, you specify the name and path of this file as the value of the Passwd Mirror File/User Mirror File parameter of the IT resource for Solaris and Linux.

    Note:

    The administrator account whose credentials you provide as part of the IT resource definition must have read and write permissions on this file.

  3. Create a shadow mirror file on the target server by using a command similar to the following:

    cp /etc/shadow /etc/shadow1 
    

    You can specify any destination directory and file name when you run the command. While configuring the IT resource, you specify the name and path of this file as the value of the Shadow Mirror File parameter of the IT resource.

    Note:

    The administrator account whose credentials you provide as part of the IT resource definition must have read and write permissions on this file.

2.3.2 Configuration Steps for AIX

Perform the following steps for AIX environments:

  1. Ensure that the /etc/passwd and /etc/security/user files are available on the server.

  2. Create a user mirror file on the server by using a command similar to the following:

    > /etc/mainUserFile1
    

    You can specify any directory and file name when you run the command. While configuring the IT resource, you specify the name and path of this file as the value of the Passwd Mirror File/User Mirror File (AIX) parameter of the IT resource for AIX.

    Note:

    The administrator account whose credentials you provide as part of the IT resource definition must have read and write permissions on this file.

2.3.3 Configuration Steps for HP-UX

Perform the following steps for HP-UX environments:

  1. If you want to switch to HP-UX Trusted mode, then:

    1. Log in as root and then run one of the following commands:

      /usr/bin/sam
      
      /usr/sbin/sam
      
    2. Select Auditing and Security and then select System Security Policies. A message is displayed asking if you want to switch to the trusted mode.

    3. Click Yes. The following message is displayed:

      System changed successfully to trusted system
      
  2. Ensure that the /etc/passwd and /etc/shadow directories are available on the target server.

  3. Create a passwd mirror file on the target server by using a command similar to the following:

    cp /etc/passwd /etc/passwd1
    

    You can specify any destination directory and file name when you run the command. While configuring the IT resource, you specify the name and path of this file as the value of the Passwd Mirror File/User Mirror File parameters of the IT resource for HP-UX.

    Note:

    The administrator account whose credentials you provide as part of the IT resource definition must have read and write permissions on this file.

  4. Create a shadow mirror file on the target server by using a command similar to the following:

    cp /etc/shadow /etc/shadow1
    

    You can specify any destination directory and file name when you run the command. While configuring the IT resource, you specify the name and path of this file as the value of the Shadow Mirror File parameter of the IT resource.

    Note:

    The administrator account whose credentials you provide as part of the IT resource definition must have read and write permissions on this file.

2.4 Installing the Connector on Oracle Identity Manager Release 9.1.0.1 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 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:

  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 UNIX Telnet RELEASE_NUMBER This list displays the names and release numbers of connectors whose installation files you copy into the default connector 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 UNIX Telnet 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 Target Resource user configuration XML file (by using the Deployment Manager). If you want to import the target system as a trusted source for reconciliation, then see Section 2.5.1, "Configuring the Target System As a Trusted Source."

    3. Compilation of adapters

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

    • Retry the installation by clicking Retry.

    • Cancel the installation and begin again from Step 0.

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

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

      Note:

      At this stage, run the 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.5.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 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 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.1, "Files and Directories on the Installation Media" for information about the files that you must copy and their destination locations on the Oracle Identity Manager server.

2.4.2 Copying the sshfactory.jar File

The sshfactory.jar file contains the JSCAPE libraries. These libraries are used to open a Telnet session with the target server. To copy the sshfactory.jar file, perform one of the following procedures depending on the version of Oracle Identity Manager:

  • If you are using Oracle Identity Manager release 9.1.0.x, then copy the ext/sshfactory.jar file from the installation media to the OIM_HOME/xellerate/ThirdParty directory.

    Note:

    In an Oracle Identity Manager cluster, copy this JAR file into the ThirdParty directory on each node of the cluster.

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

    Run the Upload JARs utility to post the ext/sshfactory.jar file from the installation media 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 the sshfactory.jar file, specify 3 as the value of the JAR type.

    See Also:

    Oracle Fusion Middleware Developer's Guide for Oracle Identity Manager for detailed information about the Upload JARs utility.

2.4.3 Configuring the IT Resource

You must specify values for the parameters of the Telnet Server 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 Telnet Server 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. The following table describes each parameter:

    Parameter Description and Sample Value

    Admin UserId

    User ID of the administrator

    root

    Admin Password/Private file Pwd

    Password of the administrator

    Server IP Address

    Server IP address

    Port

    The port at which the Telnet service is running on the server

    Default value: 23

    Server OS

    Specify one of the following:

    • AIX

    • HP-UX

    • SOLARIS

    • LINUX

    Shell Prompt

    # or $

    Whether Trusted System (HP-UX)

    YES (for trusted HP-UX System) or NO (for non-trusted HP-UX system)

    Sudo Or RBAC

    The connector does not support these modes.

    Default value: None (specifies the root user).

    Max Retries

    Number of times that the UNIX Telnet connector should retry connecting to the target server if the connection fails

    Default value: 2

    Delay

    Delay (in milliseconds) before the connector attempts to retry connecting to the target system, in case the connection fails

    Default value: 10000

    Timeout

    Value of the timeout (in milliseconds) for the connection to the target server

    Default value: 20000

    Passwd Mirror File/User Mirror File

    Name of the password mirror file/user mirror file. The user must have read and write permissions on this file.

    The sample value for this parameter is:

    /etc/passwd1

    This parameter is used for user reconciliation. The administrator account whose credentials you provide as part of the IT resource definition must have read and write permissions on this file.

    Shadow Mirror File

    Name of the shadow mirror file. The user must have read and write permissions on this file.

    This parameter is not required on AIX. The value of this attribute must not be null or blank, even for an HP-UX trusted system. However, the reconciliation process on an HP-UX trusted system ignores this attribute. The sample value for this parameter is:

    /etc/shadow1

    This parameter is used for user reconciliation.

    Target Date Format

    This parameter is used to specify the date format of the target UNIX computer. The default value for this parameter is:

    MMddhhmmyy

    This parameter is used for user reconciliation.

    Protocol

    Default value: Telnet

    Do not change this default value.


  8. To save the values, click Save.

2.4.4 Copying the Configuration Files

Copy the files in the config directory of the installation media to the following directory on the Oracle Identity Manager host computer:

  • OIM_HOME/xellerate/XLIntegrations/Telnet/config

2.5 Configuring the Oracle Identity Manager Server

Configuring the Oracle Identity Manager server involves the following procedures:

Note:

In a clustered environment, you must perform this step on each node of the cluster.

2.5.1 Configuring the Target System As a Trusted Source

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.

Configuring trusted source reconciliation involves the following steps:

  1. Import the XML file for trusted source reconciliation, XellTelnetUser.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 XellTelnetUser.xml file while you have another trusted source configured, then both connector reconciliations would stop working.

  2. Specify values for the attributes of the Telnet User Trusted Reconciliation task scheduled task. This procedure 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.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.

    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 XellTelnetUser.xml file, which is in the following directory:

    • For Oracle Identity Manager release 9.1.0.x:

      OIM_HOME/xellerate/ConnectorDefaultDirectory/UNIX_Telnet_RELEASE_NUMBER/xml

    • For Oracle Identity Manager 11.1.1:

      OIM_HOME/server/ConnectorDefaultDirectory/UNIX_Telnet_RELEASE_NUMBER/xml

  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.

2.5.2 Changing to the Required Input Locale

Note:

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

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.5.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 release 9.1.0.1, 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.1.0.1, 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.1.0.1:

    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.1.0.1:

      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 Administrator's Guide for Oracle Identity Manager for more information about the PurgeCache utility.

2.5.4 Enabling Logging

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

2.5.4.1 Enabling Logging on Oracle Identity Manager Release 9.1.0.1

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 depends on the application server that you use:

  • IBM WebSphere Application Server

    To enable logging:

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

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

      For example:

      log4j.logger.OIMCP.TELNETSSH=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="OIMCP.TELNETSSH">
         <priority value="log_level"/>
      </category>
      
    2. In the second XML code line, replace log_level with the log level that you want to set. For example:

      <category name="OIMCP.TELNETSSH">
         <priority value="INFO"/>
      </category>
      

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

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

    To enable logging:

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

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

      For example:

      log4j.logger.OIMCP.TELNETSSH=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 line in the OIM_HOME/xellerate/config/log.properties file:

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

      For example:

      log4j.logger.OIMCP.TELNETSSH=INFO
      

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

2.5.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-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='telnetssh-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="OIMCP.TELNETSSH" level="[LOG_LEVEL]" useParentHandlers="false">
           <handler name="telnetssh-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='telnetssh-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="OIMCP.TELNETSSH" level="NOTIFICATION:1" useParentHandlers="false">
           <handler name="telnetssh-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.5.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.5.5.1 Importing Request Datasets Using Deployment Manager

Note:

A request dataset is an XML file that specifies the information to be submitted by the requester during a provisioning operation. These request datasets specify information about the default set of attributes for which the requester must submit information during a request-based provisioning operation.

To import a request dataset XML file by using the Deployment Manager:

  1. Log in to 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 request dataset XML file, TelnetConnectorRequestDatasets.xml, which is in the xml directory of the installation media.

    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. Close the Deployment Manager dialog box.

    The request dataset is imported into Oracle Identity Manager.

2.5.5.2 Copying Predefined Request Datasets

Predefined request datasets are shipped with this connector. The following are the predefined request dataset available in the DataSets directory on the installation media:

  • ProvisionResourceTELNET User.xml

  • ModifyResourceTELNET 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\TelnetStd

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

You can configure request-based provisioning by importing the request datasets into into the metadata store (MDS) 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.5.5.2, "Copying Predefined Request Datasets," if you copy the files to the E:\MyDatasets\custom\connector\TelnetStd 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.5.5.4 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 Telnet User process definition.

  4. Select the Auto Save Form check box.

  5. Click Save.

2.5.5.5 Running the PurgeCache Utility

Run the PurgeCache utility to clear content belonging to the Metadata category from the server cache. See Section 2.5.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.