2 Deploying the Connector

Deploying the connector involves the following steps:

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

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	The target system can be any one of the following: Solaris 8 - 10 HP-UX 11.11 (trusted/nontrusted) Linux (Red Hat Advanced Server 2.1, Red Hat Enterprise Linux 3.x, or Red Hat Linux 4.x) AIX 4.3, AIX 5.1 - 5.3
External code	JSCAPE Telnet/SSH Libraries (SSH factory)
Other systems	Operating system patches (HP-UX)
Target system user account	root You provide the credentials of this user account while performing the procedure in the "Defining IT Resources" section. If you do not provide the credentials of this user account, then the "Insufficient rights or privileges" message is displayed when Oracle Identity Manager tries to communicate with the target system.
Character encoding (`en_US`) supported by the target system	The target system must support `en_US` character encoding standards such as `UTF-8` and `iso8859`. Use the following command to check the `en_US` character encoding standards that the target system supports: locale -a Note: If the target system does not support any of the `en_US` character encoding standards, then you must install the `en_US` language pack.

The supported shell types for various operating systems are given in the following table.

Solaris	HP-UX	Linux	AIX
`sh`	`csh`	`ksh`	`csh`
`csh`	`ksh`	`bash`	`ksh`
-	`sh`	`sh`	`sh`
-	-	`csh`	-

Step 2: Configuring the Target System

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

Configuration Steps for Solaris and Linux
Configuration Steps for AIX
Configuration Steps for HP-UX

Configuration Steps for Solaris and Linux

Perform the following steps for Solaris and Linux environments:

Ensure that the /etc/passwd and /etc/shadow files are available on the UNIX server.
Ensure that a passwd mirror file is created on the target server by using a command similar to the following:
```
cp /etc/passwd /etc/passwd1
```
The same file name with the path must be inserted in the Passwd Mirror File/User Mirror File (AIX) attribute of the reconciliation scheduled task.
Ensure that a shadow mirror file is created on the target server by using a command similar to the following:
```
cp /etc/shadow /etc/shadow1 
```
The name and path of this file must be specified for the Shadow Mirror File attribute of the reconciliation scheduled task.

Configuration Steps for AIX

Perform the following steps for AIX environments:

Ensure that the /etc/passwd and /etc/security/user files are available on the server.
Ensure that a user mirror file is created on the server by using a command similar to the following:
```
lsuser -c -a id pgrp gecos home shell expires maxage ALL |
tr '#' ' ' > /mainUserFile1
```
The name and path of this file must be specified for the Passwd Mirror File/User Mirror File (AIX) attribute of the scheduled task for reconciliation.

Configuration Steps for HP-UX

Perform the following steps for HP-UX environments:

Log in as root and then run the following command:
```
/usr/bin/sam
```
Select Auditing and Security and System Security Policies. A message is displayed asking if you want to switch to the trusted mode.
Click OK.

If the following message is displayed, then skip the next step:
```
System changed successfully to trusted system
```
Ensure that the /etc/passwd and /etc/shadow directories are available on the target server.

If the shadow file does not exist, then follow the installation instructions at

http://docs.hp.com/en/5991-0909/index.html

All the patches are available in the HP patch database, which you can download from

http://www5.itrc.hp.com/

Step 3: 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 directory on the installation media:

Operating Systems/UNIX/UNIX Telnet

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
ext/sshfactory.jar	OIM_home/xellerate/ThirdParty
lib/xliTelnet.jar	OIM_home/xellerate/JavaTasks
lib/xliTelnet.jar	OIM_home/xellerate/ScheduleTask
Files in the `resources` directory	OIM_home/xellerate/connectorResources
Files in the `test` directory	OIM_home/xellerate/XLIntegrations/Telnet
Files in the `xml` directory	OIM_home/xellerate/XLIntegrations/Telnet/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 4: 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 3: 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.TELNETSSH=log_level
```
2. In this line, replace log_level with the log level that you want to set.
  
  For example:
```
log4j.logger.Adapter.TELNETSSH=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.TELNETSSH=log_level
```
2. In this line, replace log_level with the log level that you want to set.
  
  For example:
```
log4j.logger.Adapter.TELNETSSH=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.TELNETSSH">
   <priority value="log_level"/>
</category>
```
2. In the second XML code line, replace log_level with the log level that you want to set. For example:
```
<category name="Adapter.TELNETSSH">
   <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.TELNETSSH=log_level
```
2. In this line, replace log_level with the log level that you want to set.
  
  For example:
```
log4j.logger.Adapter.TELNETSSH=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 5: Importing the Connector XML Files

To import the connector XML files into Oracle Identity Manager:

Note:

If you do not import the connector files in the specified order, then the connector may not work.

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 TelnetNonTrustedUser.xml file, which is in the OIM_home/xellerate/XLIntegrations/Telnet/xml 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 Telnet server- Solaris IT resource is displayed.
Specify values for the parameters of the Telnet server- Solaris IT resource. Refer to the table in 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 TELNET 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 file is imported into Oracle Identity Manager.
Perform the same procedure to import the XLITelnetSchedulerTask_DM.xml file, which is in the OIM_home/xellerate/XLIntegrations/Telnet/xml directory.

After you import the connector XML files, proceed to the next chapter.

Defining IT Resources

You must specify values for the Telnet server- Solaris IT resource parameters listed in the following table.

Parameter	Description
`Admin UserId`	User ID of the administrator `root`
`Admin Password`	Password of the administrator `dead_line`
`Server IP Address`	Server IP address
`Port`	The port at which the Telnet service is running on the server Default value: `22`
`Server OS`	Specify one of the following: `AIX` `HP-UX` `SOLARIS` `LINUX`
`Shell Prompt`	# or $
`Login Prompt`	Login prompt that is displayed when you log in to the server `login`:
`Password Prompt`	Password prompt that is displayed when you log in to the server `Password:`
`Whether Trusted System (HP-UX)`	`YES` (for trusted HP-UX System) or `NO` (for nontrusted HP-UX system)
`Target Locale`	Target locale The following are sample values: `en_US` for English `ja_JP` for Japanese `fr_FR` for French Note: You must not make any change (uppercase or lowercase) in the value that you specify.
`Supported Character Encoding (en_US) - Target`	Encoding format for the `en_US` target locale The default value is UTF-8. Note: You can check which `en_US` encoding formats the target system supports by using the following command: locale -a
`Max Retries`	Number of times that the UNIX Telnet connector should retry connecting to the target server if the connection fails Default value: `2`
`Delay`	Delay (in milliseconds) before the connector attempts to retry connecting to the target system, in case the connection fails Default value: `10000`
`Timeout`	Value of the timeout (in milliseconds) for the connection to the target server Default value: `20000`

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