Skip Headers
Oracle® Identity Manager Connector Guide for IBM RACF Standard
Release 9.0.4

Part Number E10427-03
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
View PDF

2 Deploying the Connector

Deploying the connector involves the following steps:

2.1 Verifying Deployment Requirements

The following table lists the deployment requirements for the connector.

Item Requirement
Oracle Identity Manager Oracle Identity Manager release 8.5.3.1 or later
Target system IBM RACF on z/OS V1.9
External code The following Host Access Class Library (HACL) class files obtained from IBM Host On-Demand (HOD) version 9.0:
  • hoddbg2.jar

  • hacp.jar

  • hasslite2.jar

  • habasen2.jar

  • WellKnownTrustedCAs.class

  • WellKnownTrustedCAs.p12

Target system user account Instructions to create an IBM RACF user account with the required privileges are given in the "Configuring the Target System" section.

You provide the credentials of this user account while configuring the IT resource. The procedure is described later in this guide.

If the user account is not assigned the specified rights, then the "Authentication failure" message is displayed when Oracle Identity Manager tries to exchange data with the target system.


2.2 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:

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

    OIM_HOME/xellerate/ThirdParty
    

2.3 Installing the Connector on Oracle Identity Manager Release 9.1.0 or Later

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 or later involves the following procedures:

2.3.1 Running the Connector Installer

To run the Connector Installer:

  1. Copy the contents of the connector installation media into the following directory:

    OIM_HOME/xellerate/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 Oracle Identity Manager Administrative and User Console.

  3. Click Deployment Management, and then click Install Connector.

  4. From the Connector List list, select IBM RACF Standard Connector 9.0.4.2. This list displays the names and release numbers of connectors whose installation files you copy into the default connector installation directory:

    OIM_HOME/xellerate/ConnectorDefaultDirectory 
    

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

  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 "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 PurgeCache utility to load the server cache with content from the connector resource bundle in order to view the list of prerequisites. Refer to "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

      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 OIM_HOME/xellerate/RACFScripts directory.

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 1-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 "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.3.2 Configuring the IT Resource

Note:

Perform this procedure if you are installing the connector on Oracle Identity Manager release 9.1.0 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. Expand Resource Management.

  3. Click Manage IT Resource.

  4. In the IT Resource Name field on the Manage IT Resource page, enter RACF 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 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.

    Value:

    OIM_HOME/xellerate/ThirdParty/InitialLoginSequence.txt
    
    AutoRetry AutoRetry feature

    The value can be YES or NO. The default value is 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. The default value is 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.

    Value:

    OIM_HOME/xellerate/ThirdParty/LogOutSequence.txt
    

  8. To save the values, click Update.

2.4 Installing the Connector on Oracle Identity Manager Release 8.5.3.1 Through 9.0.3.1

Installing the connector on any Oracle Identity Manager release between releases 8.5.3.1 and 9.0.3.1 involves the following procedures:

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

"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 a clustered environment, copy the JAR files and the contents of the connectorResources directory to the corresponding directories on each node of the cluster.

2.4.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. Refer to the following table for information about the values to be specified:

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

    Value:

    OIM_HOME/xellerate/ThirdParty/InitialLoginSequence.txt
    
    AutoRetry AutoRetry feature

    The value can be YES or NO. The default value is 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. The default value is 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.

    Value:

    OIM_HOME/xellerate/ThirdParty/LogOutSequence.txt
    

  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.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 Changing to the Required Input Locale

Changing to the required input locale (language and country setting) involves installing the required fonts and setting the required input locale.

You may require the assistance of the system administrator to change to the required input locale.

2.5.2 Clearing Content Related to Connector Resource Bundles from the Server Cache

While performing the instructions described in the "Copying the Connector Files" section, you copy files from the resources directory on the installation media into the OIM_HOME/xellerate/connectorResources directory. Whenever you add a new resource bundle in 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, change to the OIM_HOME/xellerate/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:
    OIM_HOME/xellerate/bin/batch_file_name
    
  2. Enter one of the following commands:

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

    In this command, ConnectorResourceBundle is one of the content categories that you can remove from the server cache. Refer to the following file for information about the other content categories:

    OIM_HOME/xellerate/config/xlConfig.xml
    

2.5.3 Enabling Logging

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 may 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:

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

  • 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
    

2.6 Configuring the Target System

To configure the target system:

  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

  4. Create a user on the IBM Mainframe server with TSO access using an existing user account to which the Special attribute has been assigned.

  5. 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
      
  6. 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
    
  7. 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.7 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:

    OIM_HOME/xellerate/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 following directory:

      OIM_HOME/xellerate/lib/ThirdParty
      
    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 following directory:

      OIM_HOME/Xellerate/ThirdParty