2 Deploying the Connector

Deploying the connector involves the following steps:

Step 1: Verifying Deployment Requirements
Step 2: Copying the Connector Files
Step 3: Configuring the Oracle Identity Manager Server
Step 4: Configuring the Target System
Step 5: Copying External Code Files
Step 6: Importing the Connector XML Files
Step 7: Configuring SSL

Step 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 or later
Target systems	IBM RACF on z/OS 1.4
Target system host platforms	z/OS 1.4
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 "Step 4: Configuring the Target System" section. You provide the credentials of this user account while performing the procedure in the "Defining IT Resources" section. 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.

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

Note:

The directory paths given in the first column of this table correspond to the location of the connector files in the following ZIP file on the installation media:

Security Applications/IBM RACF/IBM RACF Standard

Refer to the "Files and Directories That Comprise the Connector" section for more information about these files.

File in the Installation Media Directory	Destination Directory
lib/JavaTask/xlUtilHostAccess.jar	OIM_home/xellerate/JavaTasks
lib/ScheduleTask/xlReconRACF.jar	OIM_home/xellerate/ScheduleTask
Files in the `lib/ext` directory	OIM_home/xellerate/ext
Files in the `Scripts` directory	OIM_home/xellerate/Scripts
Files in the `resources` directory	OIM_home/xellerate/connectorResources
Files in the `xml` directory	OIM_home/xlclient/xml

Note:

While installing Oracle Identity Manager in a clustered environment, you copy the contents of the installation directory to each node of the cluster. Similarly, you must copy the connectorResources directory and the JAR files to the corresponding directories on each node of the cluster.

Step 3: 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.

Changing to the Required Input Locale
Clearing Content Related to Connector Resource Bundles from the Server Cache
Enabling Logging

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.

Clearing Content Related to Connector Resource Bundles from the Server Cache

While performing the instructions described in the "Step 2: 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:

In a command window, change to the OIM_home/xellerate/bin directory.
Note:
You must perform Step 1 before you perform Step 2. If you run the command described in Step 2 as follows, then an exception is thrown:
```
OIM_home\xellerate\bin\batch_file_name
```
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
```

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 informational messages that highlight the progress of the application at coarse-grained level.
WARN

This level enables logging of information about potentially harmful situations.
ERROR

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

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

This level disables logging for all events.

The file in which you set the log level depends on the application server that you use:

BEA WebLogic

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:
```
WebLogic_home/user_projects/domains/domain_name/server_name/server_name.log
```
IBM WebSphere

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/startServer.log
```
JBoss Application Server

To enable logging:
1. In the JBoss_home/server/default/conf/log4j.xml file, locate the following lines:
```
<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
```
OC4J

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:
```
OC4J_home/opmn/logs/default_group~home~default_group~1.log
```

Step 4: Configuring the Target System

To configure the target system:

Note down the Telnet and SSL port numbers specified in the TCP/IP profile file. When you perform the "Defining IT Resources" procedure, you must provide these port numbers as part of the IT resource definition.
Using FTP, upload the members (scripts) from the OIM_home/xellerate/Scripts directory to a partitioned dataset with record length 80 and record format Fixed Block.
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/Scripts/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
Create a user on the IBM Mainframe server with TSO access using an existing user account to which the Special attribute has been assigned.
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
```
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
```
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
```

Step 5: Copying External Code Files

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

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>
```
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/ext
```
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/ext
```

Step 6: Importing the Connector XML Files

To import the connector XML file into Oracle Identity Manager:

Open the Oracle Identity Manager Administrative and User Console .
Click the Deployment Management link on the left navigation bar.
Click the Import link under Deployment Management. A dialog box for locating files is displayed.
Locate and open the RACFnonTrusted.xml file, which is in the OIM_home/xlclient directory. Details of this XML file are shown on the File Preview page.
Click Add File. The Substitutions page is displayed.
Click Next. The Confirmation page is displayed.
Click Next. The Provide IT Resource Instance Data page for the RACF Server IT resource is displayed.
Specify values for the parameters of the RACF Server IT resource. Refer to the "Defining IT Resources" section for information about the values to be specified.
Click Next. The Provide IT Resource Instance Data page for a new instance of the RACF Server IT resource type is displayed.
Click Skip to specify that you do not want to define another IT resource. The Confirmation page is displayed.

See Also:
If you want to define another IT resource, then refer to Oracle Identity Manager Tools Reference Guide for instructions.
Click View Selections.

The contents of the XML file are displayed on the Import page. You may see a cross-shaped icon along with some nodes. 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.
Click Import. The connector XML file is imported into Oracle Identity Manager.

After you import the connector XML file, proceed to the "Step 7: Configuring SSL" section.

Defining IT Resources

You must specify values for the RACF Server IT resource parameters listed in the following table.

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/ext/loginsequence.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` or `5`
`WaitTime`	Wait time between consecutive retries Sample value: `20` or `30`
`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/ext/logoutsequence.txt
`IsDebug`	Specifies whether or not debugging must be performed The value can be `YES` or `NO`. The default value is `NO`.

After you specify values for these IT resource parameters, proceed to Step 9 of the procedure to import connector XML files.

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

Set the IsSecure parameter of the IT resource to YES.
Configure the target system to enable the required port for SSL connection.
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/ext
```
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/ext
```
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/ext
```