2 Deploying the Connector

To deploy the connector, perform the procedures described in the following sections:

2.1 Preinstallation

This section is divided into the following topics:

2.1.1 Preinstallation on Oracle Identity Manager

This section contains the following topics:

2.1.1.1 Files and Directories on the Installation Media

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

Table 2-1 Files and Directories on the Installation Media

File in the Installation Media Directory Description

configuration/IBM RACF Standard-CI.xml

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

Files in the dataset directory

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

lib/xlUtilHostAccess.jar

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

  • For Oracle Identity Manager release 9.0.1 through 9.0.3.x and release 9.1.0.x: OIM_HOME/xellerate/JavaTasks

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

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

lib/xlReconRACF.jar

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

  • For Oracle Identity Manager release 9.0.1 through 9.0.3.x and release 9.1.0.x: OIM_HOME/xellerate/ScheduleTask

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

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

ext/CustomizedCAs.jar

This file is used to set up an SSL connection between Oracle Identity Manager and the IBM Mainframe server.

config/InitialLoginSequence.txt

This file contains the login sequence that the connector uses to connect to the IBM Mainframe server. The login sequence contains the sequence of values to be provided to the Telnet session between the connector and the IBM Mainframe server. These values are required to navigate through the various screens that are part of the TSO login process before reaching the READY prompt on the mainframe target server.

The values in this file are supplied in the form of variables that hold IT resource values and literals. This machine-dependent file must be altered after deployment.

config/InputFields.txt

This file contains values for the connection parameters that are required to connect to the IBM Mainframe server. This file is used with the testing utility.

config/LogOutSequence.txt

This file contains the logoff sequence that the connector uses to log off from the IBM Mainframe server. The logoff sequence contains the sequence of values to be provided to the Telnet session between the connector and the IBM Mainframe server. These values are required to navigate through the various screens that are part of the TSO logoff process from the READY prompt on the mainframe target server.

The values in this file are supplied in the form of variables that hold IT resource values and literals. This machine-dependent file must be altered after deployment.

scripts/DATAEXTT

This file uses the decrypted copy of the IBM RACF database to extract user-related records required for reconciliation to temporary files. It is a member of a procedure library on the IBM Mainframe server.

scripts/DATAUNLD

This file merges the data from the SYSTMDAT and JCLSRC files to a temporary file to submit a background job. This background job prepares a decrypted copy of the IBM RACF database and then calls the individual REXX code scripts to format the data.

scripts/JCLSRC

This file is used to submit the background job for use in reconciliation. It is a member of a procedure library on the IBM Mainframe server. A procedure library is a partitioned dataset containing member files.

scripts/JOBSTAT

This file determines the status of a background job used for reconciliation. It is a member of a procedure library on the IBM Mainframe server.

scripts/RECNLKUP

This file provides lookup fields data. It is a member of a procedure library on the IBM Mainframe server.

scripts/RXDIFFER

This file provides differences between the old and new database images. It is a member of a procedure library on the IBM Mainframe server.

scripts/RXDPTADD

This file copies the user's department data from a temporary file and adds this information to the user's basic data. It is a member of a procedure library on the IBM Mainframe server.

scripts/RXGRPADD

This file copies the user's group privilege data from a temporary file and adds this information to the user's basic data. It is a member of a procedure library on the IBM Mainframe server.

scripts/RXPRNTDT

This file carries user reconciliation data from the IBM Mainframe to Oracle Identity Manager. It is a member of a procedure library on the IBM Mainframe server.

scripts/RXPRVADD

This file copies the user's connect privilege data from a temporary file and adds this information to the user's basic data. It is a member of a procedure library on the IBM Mainframe server.

scripts/RXTSOADD

This file copies the user's TSO data from a temporary file and adds this information to the user's basic data. It is a member of a procedure library on the IBM Mainframe server.

scripts/SYSTMDAT

This file is used to provide job configuration parameters to the mainframe system.

Files in the resources directory

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

  • For Oracle Identity Manager release 9.0.1 through 9.0.3.x and release 9.1.0.x: OIM_HOME/xellerate/connectorResources

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

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

Note: A resource bundle is a file containing localized versions of the text strings that include GUI element labels and messages.

test/config/config.properties

This testing utility file holds the input data that you provide for each test.

test/config/log.properties

This testing utility file holds log data that is generated after each test.

test/scripts/RACF.sh

test/scripts/RACF.bat

This file is used to run the testing utility.

xml/RACFnonTrusted.xml

These XML files contain definitions for the following components of the connector:

  • IT resource type

  • IT resource

  • Resource object form

  • Process definition

  • Process tasks

  • Connector tasks

xml/RACFTrusted.xml

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


Note:

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

2.1.1.2 Determining the Release Number of the Connector

Note:

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

If you are using Oracle Identity Manager release 11.1.1 or Oracle Identity Manager release 11.1.2, 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/xlUtilHostAccess.jar

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

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

2.1.1.3 Using External Code Files

The procedure to copy the external code files involves the following steps:

  1. Create a JAR file containing the WellKnownTrustedCAs.class and WellKnownTrusted.p12 files. These files are available as part of the HOD installation in the following directory (assuming HOD is installed in the <../IBM> directory):

    <IBM/HostOnDemand/HOD>

    You can use the following command to create the JAR file:

    jar –cvf  WellKnownTrustedCertificatesCAs.jar  WellKnownTrustedCAs.class WellKnownTrusted.p12
    
  2. Copy the JAR file created in Step 1 along with the external JAR files (hoddbg2.jar, hacp.jar, habasen2.jar, and hasslite2.jar) available in the HOD installation directory (<.IBM/HostOnDemand/HOD>) to the following directory of the Oracle Identity Manager installation:

    Note:

    In an Oracle Identity Manager cluster, copy this JAR file into the ThirdParty directory on each node of the cluster.
    • For Oracle Identity Manager release 9.0.1 through 9.0.3.x and release 9.1.0.x:

      OIM_HOME/xellerate/ThirdParty

    • For Oracle Identity Manager release 11.1.1:

      OIM_HOME/server/ThirdParty

    • For Oracle Identity Manager release 11.1.2:

      OIM_HOME/server/ThirdParty

  3. Copy the InitialLoginSequence.txt, LogOutSequence.txt, and InputFields.txt files to the following directory after making changes (if required) according to the target configuration:

    • For Oracle Identity Manager release 9.0.1 through 9.0.3.x and release 9.1.0.x:

      OIM_HOME/xellerate/ThirdParty

    • For Oracle Identity Manager release 11.1.1:

      OIM_HOME/server/ThirdParty

    • For Oracle Identity Manager release 11.1.2:

      OIM_HOME/server/ThirdParty

2.1.2 Preinstallation on the Target System

To create a target system user account for connector operations:

  1. Create a user on the IBM Mainframe server with TSO access using an existing user account to which the Special attribute has been assigned. To do so, run the following REX program:

    PROC 0 
       ADDUSER (User Id) OWNER(Group Name) + 
          NAME(' (User Id) - User Name') + 
          TSO(PROC(TSO procedure Name) + 
             ACCTNUM(Account Name) + 
             SIZE(2096) + 
             UNIT(2096) + 
          ) 
          RDEFINE ACCTNUM Account Name UACC(NONE) 
          PERMIT Account Name CLASS(ACCTNUM) ID((User Id)) ACCESS(READ)
          PERMIT TSO procedure Name CLASS(TSOPROC) ID((User Id)) ACCESS(READ) 
          ADDSD '(User Id).*' UACC(NONE) 
          PE '(User Id).*' ACCESS(ALTER) ID((User Id)) 
          CO (User Id) GROUP(Group Name) 
          ALU (User Id) DFLTGRP(Group Name) 
          ALU (User Id) PASS(Password) 
          SETR RACLIST(ACCTNUM) REFRESH 
          SETR RACLIST(TSOPROC) REFRESH 
    
  2. Provide the user with the Special attributes.

    1. Log on to TSO on the IBM Mainframe server using the user account that you use to create the mainframe user.

    2. At the READY prompt, enter the following command:

      Altuser NewUserIDCreated Special
      
  3. Enter the following RACF commands at the READY prompt to provide the mainframe user with the ALTER permission on the directory that is to store the RACF scripts:

    ADDSD  RACF_Source UACC(NONE)
    PERMIT RACF_Source ACCESS(ALTER) ID(new_mainframe_userid)
    SETROPTS GENERIC(DATASET) REFRESH
    
  4. Set Msgid to ON for the mainframe user as follows:

    1. Log on to TSO on the IBM Mainframe server using the mainframe user account that you create.

    2. At the READY prompt, enter the following command:

      profile msgid
      

2.2 Installation

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

2.2.1 Installing the Connector on Oracle Identity Manager Release 9.1.0.x, Release 11.1.1, or Release 11.1.2

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, release 11.1.1, or release 11.1.2 involves the following procedures:

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

    • For Oracle Identity Manager release 11.1.2: 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

    • For Oracle Identity Manager release 11.1.2:

      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.

    • For Oracle Identity Manager release 11.1.2:

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

  4. From the Connector List list, select IBM RACF Standard Connector 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 IBM RACF Standard Connector 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.3.1.4, "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.1.2, "Clearing Content Related to Connector Resource Bundles from the Server Cache" for information about running the PurgeCache utility.

      There are no prerequisites for some predefined connectors.

    2. Configuring the IT resource for the connector

      Record the name of the IT resource displayed on this page. The procedure to configure the IT resource is described later in this guide.

    3. Configuring the scheduled tasks that are created when you installed the connector

      Note:

      In Oracle Identity Manager release 11.1.1 or Oracle Identity Manager release 11.1.2, 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 or Oracle Identity Manager release 11.1.2.

      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.

  8. Copy files from the scripts directory on the connector installation media to the following location:

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

    • For Oracle Identity Manager release 11.1.1: OIM_HOME/server/RACFScripts

    • For Oracle Identity Manager release 11.1.2: OIM_HOME/server/RACFScripts

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 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.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.2.1.2 Configuring the IT Resource

Note:

Perform this procedure if you are installing the connector on Oracle Identity Manager release 9.1.0.x or later.

You must specify values for the parameters of the RACF Server IT resource as follows:

  1. Log in to the Administrative and User Console.

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

      1. Expand Resource Management, and then click Manage IT Resource.

    • For Oracle Identity Manager release 11.1.1:

      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 Configuration region, click Manage IT Resource.

    • For Oracle Identity Manager release 11.1.2:

      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 Configuration region, click Manage IT Resource.

  3. In the IT Resource Name field on the Manage IT Resource page, enter RACF Server and then click Search.

  4. Click the edit icon for the IT resource.

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

  6. Specify values for the parameters of the IT resource. Table 2-2 describes each parameter.

    Table 2-2 IT Resource Parameters

    Parameter Description

    Admin

    Administrator ID on the IBM RACF server

    AdminCredential

    Password of the admin ID account

    Application

    TSO value to which the admin user logs in.

    Sample value: B

    Host

    IP address or computer name of the mainframe system

    Port

    Port number at which the server is listening

    LoginMacro

    Name and directory path of the file that is used to reach the READY prompt on the IBM Mainframe server.

    The default value is as follows:

    • For Oracle Identity Manager release 9.0.1 through 9.0.3.x and release 9.1.0.x:

      OIM_HOME/xellerate/ThirdParty/InitialLoginSequence.txt

    • For Oracle Identity Manager release 11.1.1:

      OIM_HOME/server/ThirdParty/InitialLoginSequence.txt

    • For Oracle Identity Manager release 11.1.2:

      OIM_HOME/server/ThirdParty/InitialLoginSequence.txt

    AutoRetry

    AutoRetry feature

    The value can be YES or NO.

    Default value: NO

    AmountRetry

    Number of retries for the AutoRetry feature

    Sample value: 2

    WaitTime

    Wait time between consecutive retries

    Sample value: 20

    IsSecure

    Specifies whether or not the connection between Oracle Identity Manager and IBM RACF must be secured by using SSL

    The value can be YES or NO.

    Default value: NO

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

    LogoutMacro

    Name and directory path of the file that is used to exit from the READY prompt on the IBM Mainframe server.

    The default value is as follows:

    • For Oracle Identity Manager release 9.0.1 through 9.0.3.x and release 9.1.0.x:

      OIM_HOME/xellerate/ThirdParty/LogOutSequence.txt

    • For Oracle Identity Manager release 11.1.1:

      OIM_HOME/server/ThirdParty/LogOutSequence.txt

    • For Oracle Identity Manager release 11.1.2:

      OIM_HOME/server/ThirdParty/InitialLoginSequence.txt


  7. To save the values, click Update.

2.2.2 Installing the Connector on Oracle Identity Manager Release 9.0.1 Through 9.0.3.x

Installing the connector on any Oracle Identity Manager release between releases 9.0.1 and 9.0.3.x involves the following procedures:

2.2.2.1 Copying the Connector Files

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

See Also:

Section 2.1.1.1, "Files and Directories on the Installation Media" for more information about these files
File in the Installation Media Directory Destination Directory
lib/xlUtilHostAccess.jar OIM_HOME/xellerate/JavaTasks
lib/xlReconRACF.jar OIM_HOME/xellerate/ScheduleTask
Files in the ext directory OIM_HOME/xellerate/ThirdParty
Files in the scripts directory OIM_HOME/xellerate/RACFScripts
Files in the resources directory OIM_HOME/xellerate/connectorResources
Contents of the test directory OIM_HOME/xellerate/XLIntegrations/racf
Files in the xml directory OIM_HOME/XLIntegrations/racf/xml

Note:

In an Oracle Identity Manager cluster, copy the JAR files and the contents of the connectorResources directory to the corresponding directories on each node of the cluster.

2.2.2.2 Importing the Connector XML Files

To import the connector XML file into Oracle Identity Manager:

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

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

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

  4. Locate and open the RACFnonTrusted.xml file, which is in the OIM_HOME/XLIntegrations/racf/xml directory. Details of this XML file are shown on the File Preview page.

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

  6. Click Next. The Confirmation page is displayed.

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

  8. Specify values for the parameters of the RACF Server IT resource. See the table in Section 2.2.1.2, "Configuring the IT Resource" for information about the values to be specified.

  9. Click Next. The Provide IT Resource Instance Data page for a new instance of the RACF Server IT resource type is displayed.

  10. Click Skip to specify that you do not want to define another IT resource. The Confirmation page is displayed.

    See Also:

    If you want to define another IT resource, then refer to Oracle Identity Manager Administrative and User Console Guide for instructions.
  11. Click View Selections.

    The contents of the XML file are displayed on the Import page. You may see a cross-shaped icon along with some nodes. These nodes represent Oracle Identity Manager entities that are redundant. Before you import the connector XML file, you must remove these entities by right-clicking each node and then selecting Remove.

  12. Click Import. The connector XML file is imported into Oracle Identity Manager.

2.2.2.3 Compiling Adapters

Note:

You must perform the procedure described in this section if you want to use the provisioning features of Oracle Identity Manager for this target system.

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

See Also:

Section 1.6.6, "Provisioning Functions" for a listing of the provisioning functions that are available with this connector
  • Create new RACF User

  • RACF User Delete

  • RACF User Enable

  • addTsoToRacfUser

  • setRacfUserPassword

  • UpdateRacfUserAttribute

  • connect to group

  • Connect To Group

  • removeTso

  • RACF User Disable

  • RACF Update Privilege

  • PrepopulateRacfUsrId

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

To compile adapters by using the Adapter Manager form:

  1. Open the Adapter Manager form.

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

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

    Note:

    Click Compile Previously Failed to recompile only those adapters that were not compiled successfully. Such adapters do not have an OK compilation status.
  3. Click Start. Oracle Identity Manager compiles the selected adapters.

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

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

See Also:

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

To view detailed information about an adapter:

  1. Highlight the adapter in the Adapter Manager form.

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

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

2.3 Postinstallation

Postinstallation steps are divided across the following sections:

2.3.1 Postinstallation on Oracle Identity Manager Server

Configuring the Oracle Identity Manager server involves the following procedures:

2.3.1.1 Changing to the Required Input Locale

Note:

In an Oracle Identity Manager cluster, perform this procedure 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.3.1.2 Clearing Content Related to Connector Resource Bundles from the Server Cache

Note:

In an Oracle Identity Manager cluster, perform this procedure 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.x, and Oracle Identity Manager database for Oracle Identity Manager release 11.1.1 and release 11.1.2. 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.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.

    • If you are using Oracle Identity Manager release 11.1.2, 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.x:

    OIM_HOME/xellerate/bin/SCRIPT_FILE_NAME
    

    For Oracle Identity Manager release 11.1.1:

    OIM_HOME/server/bin/SCRIPT_FILE_NAME
    

    For Oracle Identity Manager release 11.1.2:

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

    • For Oracle Identity Manager release 11.1.2:

      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.1.3 Enabling Logging

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

2.3.1.3.1 Enabling Logging on Oracle Identity Manager Release 9.1.0.x

Note:

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

When you enable logging, Oracle Identity Manager automatically stores in a log file information about events that occur during the course of provisioning and reconciliation operations. To specify the type of event for which you want logging to take place, you can set the log level to one of the following:

  • ALL

    This level enables logging for all events.

  • DEBUG

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

  • INFO

    This level enables logging of messages that highlight the progress of the application at a coarse-grained level.

  • WARN

    This level enables logging of information about potentially harmful situations.

  • ERROR

    This level enables logging of information about error events that might allow the application to continue running.

  • FATAL

    This level enables logging of information about very severe error events that could cause the application to stop functioning.

  • OFF

    This level disables logging for all events.

The file in which you set the log level 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.ADAPTER.RACFADAPTERLOGGER=log_level
      
    2. In this line, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.ADAPTER.RACFADAPTERLOGGER=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="ADAPTER.RACFADAPTERLOGGER">
         <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="ADAPTER.RACFADAPTERLOGGER">
         <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.ADAPTER.RACFADAPTERLOGGER=log_level
      
    2. In this line, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.ADAPTER.RACFADAPTERLOGGER=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.ADAPTER.RACFADAPTERLOGGER=log_level
      
    2. In this line, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.ADAPTER.RACFADAPTERLOGGER=INFO
      

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

2.3.1.3.2 Enabling Logging on Oracle Identity Manager Release 11.1.1

Note:

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

Oracle Identity Manager release 11.1.1 uses Oracle Java Diagnostic Logging (OJDL) for logging. OJDL is based on java.util.logger. To specify the type of event for which you want logging to take place, you can set the log level to one of the following:

  • SEVERE.intValue()+100

    This level enables logging of information about fatal errors.

  • SEVERE

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

  • WARNING

    This level enables logging of information about potentially harmful situations.

  • INFO

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

  • CONFIG

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

  • FINE, FINER, FINEST

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

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

Table 2-3 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='racf-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="ADAPTER.RACFADAPTERLOGGER" level="[LOG_LEVEL]" useParentHandlers="false">
           <handler name="sjsds-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-3 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='racf-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="ADAPTER.RACFADAPTERLOGGER" level="NOTIFICATION:1" useParentHandlers="false">
           <handler name="racf-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.1.3.3 Enabling Logging on Oracle Identity Manager Release 11.1.2

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.2 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-3.

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='racf-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="ADAPTER.RACFADAPTERLOGGER" level="[LOG_LEVEL]" useParentHandlers="false">
           <handler name="sjsds-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-3 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='racf-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="ADAPTER.RACFADAPTERLOGGER" level="NOTIFICATION:1" useParentHandlers="false">
           <handler name="racf-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.1.4 Configuring Trusted Source Reconciliation

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

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

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

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

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

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

Note:

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

To configure trusted source reconciliation, you import the RACFTrusted.xml file while performing the procedure described in Section 2.2.2.2, "Importing the Connector XML Files."

Configuring trusted source reconciliation involves the following steps:

  1. Import the XML file for trusted source reconciliation, RACFTrusted.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 RACFTrusted.xml file while you have another trusted source configured, then both connector reconciliations would stop working.
  2. Set the value of the isTrusted scheduled task attribute to Yes while performing the procedure described in Section 3.3.4.1, "Submitjob User Reconciliation Scheduled Task."

To import the XML file for trusted source reconciliation:

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

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

    • For Oracle Identity Manager release 9.0.1 through 9.0.3.x and 9.1.0.x:

      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.

    • For Oracle Identity Manager release 11.1.1:

      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.

    • For Oracle Identity Manager release 11.1.2:

      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.

  3. Locate and open the RACFTrusted.xml file located in the following directory:

    • For Oracle Identity Manager release 9.0.1 through 9.0.3.x and release 9.1.0.x:

      OIM_HOME/xellerate/ConnectorDefaultDirectory/IBM_RACF_Std_90412/xml

    • For Oracle Identity Manager release 11.1.1:

      OIM_HOME/server/ConnectorDefaultDirectory/IBM_RACF_Std_90412/xml

    • For Oracle Identity Manager release 11.1.2:

      OIM_HOME/server/ConnectorDefaultDirectory/IBM_RACF_Std_90412/xml

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

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

  5. Click Next. The Confirmation page is displayed.

  6. Click Import.

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

2.3.1.5 Confuguring Request-Based Provisioning

Note:

Perform the procedure described in this section only if you are using Oracle Identity Manager release 11.1.1 or Oracle Identity Manager release 11.1.2 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.3.1.5.1 Copying Predefined Request Datasets

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

  • ProvisionResource_RACF Server.xml

  • ModifyProvisionedResource_RACF Server.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\RACFStd

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

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

To import a request dataset definition into MDS:

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

    Note:

    While setting up the properties in the weblogic.properties file, ensure that the value of the metadata_from_loc property is the parent directory of the /custom/connector/RESOURCE_NAME directory. For example, while performing the procedure in Section 2.3.1.5.1, "Copying Predefined Request Datasets," if you copy the files to the E:\MyDatasets\custom\connector\RACFStd 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.1.5.3 Enabling the Auto Save Form Feature

To enable the Auto Save Form feature:

  1. Log in to the Design Console.

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

  3. Search for and open the RACF User process definition.

  4. Select the Auto Save Form check box.

  5. Click the Save icon.

2.3.1.5.4 Running the PurgeCache Utility

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

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

2.3.2 Configuring SSL

Note:

This is an optional step of the deployment procedure.

The CustomizedCAs.p12 file is the container for server certificates used for establishing an SSL connection. This file is compressed in the CustomizedCAs.jar file. The password for the CustomizedCAs.p12 file is hod. If the IBM Mainframe server has a certificate signed by a CA other than Verisign or Thawte, the root certificate of the CA must be added to the CustomizedCAs.p12 file for establishing the SSL connection.

The certificate can be added to the CustomizedCAs.p12 file by using a key management utility that supports PKCS12 format files. One of the tools that can be used to add the certificate is GSKkit7.0. This tool is part of IBM Host On-demand Server version 9.0.

To set up SSL connectivity between Oracle Identity Manager and the IBM Mainframe server:

  1. Set the IsSecure parameter of the IT resource to YES.

  2. Configure the target system to enable the required port for SSL connection.

  3. If the certificate is issued by Thawte or any other well-known CA, then copy the WellKnownTrustedCertificatesCAs.jar file into the following directory:

    • For Oracle Identity Manager release 9.0.1 through 9.0.3.x and 9.1.0.x:

      OIM_HOME/xellerate/lib/ThirdParty

    • For Oracle Identity Manager release 11.1.1:

      OIM_HOME/server/lib/ThirdParty

    • For Oracle Identity Manager release 11.1.2:

      OIM_HOME/server/lib/ThirdParty

  4. Import the certificate in the CustomizedCAs.p12 file as follows:

    1. Extract the contents of the CustomizedCAs.jar file. This file is in the directory specified in Step 3.

    2. Add the SSL certificate in the CustomizedCAs.p12 file.

    3. Create the CustomizedCAs.jar file with the updated CustomizedCAs.p12 and CustomizedCAs.class files.

    4. Copy the updated JAR file into the directory specified in Step 3, depending on the Oracle Identity Manager release that you are using.

2.3.3 Postinstallation on the Target System

Postinstallation on the target system consists of the following steps:

  1. Note down the Telnet and SSL port numbers specified in the TCP/IP profile file. When you configure the IT resource, you must provide these port numbers as part of the IT resource definition.

  2. Using FTP, upload the members (scripts) from the OIM_HOME/xellerate/RACFScripts directory to a partitioned dataset with record length 80 and record format Fixed Block.

  3. Upload the following file as a flat file or Physical Sequential (PS) file with record length 80 and record format Fixed Block.

    OIM_HOME/xellerate/RACFScripts/SYSTMDAT

    You must provide the following information in the SYSTMDAT file:

    • Name of the IBM RACF database dataset

    • Job header, which forms a part of the background job

      You must ensure that the job header contains the NOTIFY parameter in the following format:

      NOTIFY=&SYSUID
      
    • Name of the RACF source dataset containing the RACF scripts that you upload to a partitioned dataset on the IBM RACF server (in Step 2 of this procedure).

    • Region size and dynamic resource allocation values

    • Names of 10 temporary PS files that can be created and deleted by the connector