2 Deploying the Connector

The procedure to deploy the connector can be divided into the following stages:

2.1 Preinstallation

This section is divided into the following topics:

2.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 Connector Installation Media

File in the Installation Media Directory Description

configuration/SAPEP-CI.xml

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

DataSet/ModifyResourceSAP EP Resource Object.xml

DataSet/ProvisionResourceSAP EP Resource Object.xml

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

lib/SAPEPConnector.jar

This JAR file contains the class files that are used to implement provisioning. During connector deployment, this file is copied to the following location:

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

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

lib/SAPEPRecon.jar

This JAR file contains the class files that are used to implement reconciliation. During connector deployment, this file is copied to the following location:

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

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

par/ConnectorService.par

This file is used to call Web services on the SAP Enterprise Portal system.

Files in the resources directory

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

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

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

Note: A resource bundle is a file containing localized versions of the text strings that are displayed on the Administrative and User Console. These text strings include GUI element labels and messages.

test/Troubleshoot/TroubleShootUtility.class

This utility is used to test connector functionality.

test/Troubleshoot/global.properties

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

test/Troubleshoot/log.properties

This file is used to specify the log level and the directory in which the log file is to be created when you run the testing utility.

xml/SAPEPResourceObject.xml

This XML file contains definitions for the following components of the connector:

  • IT resource type

  • IT resource

  • Process form

  • Lookup definitions

  • Adapters

  • Resource object

  • Process definition

  • Scheduled tasks

xml/SAPEPXLResourceObject.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.2 Determining the Release Number of the Connector

Note:

If you are using Oracle Identity Manager releases 9.0.1 through 9.0.3.2 and 9.1.0.x, then the procedure described in this section is optional.

If you are using Oracle Identity Manager release 11.1.1, then skip this section.

You might have a deployment of an earlier release of the connector. While deploying the latest release, you might want to know the release number of the earlier release. To determine the release number of the connector that has already been deployed:

  1. In a temporary directory, extract the contents of the following JAR file:

    OIM_HOME/xellerate/JavaTasks/SAPEPRecon.jar

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

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

2.1.3 Using the Apache Axis JAR Files

Note:

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

The Apache Axis JAR files are required for SOAP communication with the Web service running on the SAP Enterprise Portal server. The version of Axis used is axis-1_3. You can download the JAR files from the Apache Web site and copy in into the ThirdParty directory or the Oracle Identity Manager database as follows:

  1. Log on to the Apache Web site at

    http://ws.apache.org/axis/

  2. Download the zip file corresponding to the Axis 1.3 version, and then extract its contents to obtain the following JAR files:

    For JBoss Application Server

    axis-1.3.jar

    commons-discovery-0.2.jar

    For Oracle WebLogic Server

    axis-1.3.jar

    commons-discovery-0.2.jar

    commons-logging.jar

    wsdl4j-1.5.1.jar

    For IBM WebSphere Application Server

    axis-1.3.jar

  3. Copy the JAR files into one of the following directories:

    • For Oracle Identity Manager release 9.0.1 through 9.0.3.2 or release 9.1.0.x:

      OIM_HOME/xellerate/ThirdParty

    • For Oracle Identity Manager release 11.1.1:

      OIM_HOME/server/ThirdParty

If Oracle Identity Manager is running on Oracle WebLogic Server, then add the directory in which the JAR files are present to the classpath environment variable. Perform the procedures described in one of the following sections:

2.1.3.1 Setting the Classpath on Oracle WebLogic Server Running on Microsoft Windows

To add the directory containing the JAR files to the classpath in the WebLogic Application Server on Windows:

  1. In the WebLogic server installation directory, navigate to the domain name directory.

  2. Open the startWebLogic.cmd file in a text editor.

  3. Edit the following command:

    CLASSPATH=%JAVA_HOME%\jre\lib\rt.jar;
    

    Add the Apache Axis JAR files corresponding to the Oracle WebLogic Server in the ThirdParty directory to the classpath as shown below:

    set CLASSPATH=%JAVA_HOME%\jre\lib\rt.jar;JAR_FILES;
    

    In this command, replace JAR_FILES with a semicolon-separated list of the full path and name of the Apache Axis JAR files present in the ThirdParty directory.

    The following is a sample command:

    set CLASSPATH=%JAVA_HOME%\jre\lib\rt.jar;%XLHOME%\ThirdParty\axis.3.jar;%XLHOME%\ThirdParty\commons-logging.jar;%XLHOME%\ThirdParty\commons-discovery-0.2.jar;%XLHOME%\ThirdParty\wsdl4j-1.5.1.jar;
    

    Here, replace %XLHOME% with the path to the directory in which Oracle Identity Manager is installed. In other words, the complete path to the OIM_HOME directory.

  4. Save and close the file.

2.1.3.2 Setting the Classpath on Oracle WebLogic Server Running on Linux

To add the directory containing the JAR files to the classpath in the WebLogic Application Server on Linux:

  1. In the WebLogic server installation directory, navigate to the domain name directory.

  2. Open the startWebLogic.sh file in a text editor.

  3. Edit the following command:

    CLASSPATH=%JAVA_HOME%\jre\lib\rt.jar;
    

    Add the Apache Axis JAR files corresponding to the Oracle WebLogic Server in the ThirdParty directory to the classpath as shown below:

    set CLASSPATH=%JAVA_HOME%\jre\lib\rt.jar :JAR_FILES;
    

    In this command, replace JAR_FILES with a colon-separated list of the full path and name of the Apache Axis JAR files present in the ThirdParty directory.

    The following is a sample command:

    set CLASSPATH=%JAVA_HOME%/jre/lib/rt.jar :${ XLHOME }/ThirdParty/axis.3.jar;%XLHOME%/ThirdParty/commons-logging.jar: ${ XLHOME}/ThirdParty/commons-discovery-0.2.jar; ${ XLHOME}/ThirdParty/wsdl4j-1.5.1.jar;
    

    Here, replace %XLHOME% with the path to the directory in which Oracle Identity Manager is installed. In other words, the complete path to the OIM_HOME directory.

  4. Save and close the file.

2.1.4 Determining the URL of the Web Service Running on the Target System

The WSDLLocation parameter of the IT resource holds the URL of the Web service that is running on SAP Enterprise Portal. While configuring the IT resource, you provide this URL as the value of the WSDLLocation parameter.

To determine the URL of the Web service:

  1. Log in to SAP EP as an administrator.

  2. Click the System Administration tab.

  3. Click the Support tab.

  4. Select Portal Runtime in the Top Level Areas region.

    The Portal Support Desk: Portal Runtime page is displayed.

  5. On this page, click SOAP Admin in the Test and Configuration Tools region.

    The SOAP Administration page is displayed.

  6. On this page, select Web Services.

    All the Web Services are displayed.

  7. Click com.sap.portal.prt.soap.ConnectorService.

    All the WSDL files are displayed.

  8. Click the Present link next to RPC Literal.

    An XML file is opened.

  9. In the XML file, search for the tag that starts with the following text:

    <soap:address location=
    

    This tag holds the WSDL URL of the Web service. For example:

    <soap:address location="http://mlbpsap02:50000/irj/servlet/prt/soap/com.sap.portal.prt.soap.ConnectorService?style=rpc_lit" />
    

2.2 Installation

The procedure to install the connector depends on the release of Oracle Identity Manager that you are using:

2.2.1 Installing the Connector on Oracle Identity Manager Release 9.0.1 Through 9.0.3.2

Installing the connector on Oracle Identity Manager release 9.0.1 through 9.0.3.2 involves performing the following procedures:

2.2.1.1 Copying the Connector Files and External Code Files

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

Note:

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

See the Section 2.1.1, "Files and Directories on the Installation Media" for more information about these files.

Table 2-2 Connector Files to Be Copied

Connector File Destination Directory

Files in the lib directory

OIM_HOME/Xellerate/SAP_EP/lib

OIM_HOME/Xellerate/SAP_EP/JavaTasks

lib/SAPEPRecon.jar

OIM_HOME/Xellerate/ScheduleTask

par/ConnectorService.par

See Section 2.3.2, "Deploying Web Services on the Target System" for more information.

Files in the resources directory

OIM_HOME/xellerate/connectorResources

Files in the test directory

OIM_HOME/Xellerate/SAP_EP/test

Files in the xml directory

OIM_HOME/Xellerate/SAP_EP/xml


2.2.1.2 Importing the Connector XML File

As mentioned in Section 2.1.1, "Files and Directories on the Installation Media," the connector XML file contains definitions of the components of the connector. By importing the connector XML file, you create these components in Oracle Identity Manager.

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 SAPEPResourceObject.xml file, which is in the OIM_HOME/Xellerate/xml directory. Details of this XML file are shown on the File Preview page.

    Note:

    The connector version is also displayed on this 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 SAP EP IT Resource IT resource is displayed.

  8. Specify values for the parameters of the SAP EP IT Resource IT resource. See Section 2.2.2.2, "Configuring the IT Resource" for information about the values to be specified.

  9. If you want to configure the connector for another instance of the target system, then:

    1. Click Next. The Provide IT Resource Instance Data page for a new instance of the SAP EP IT Resource IT resource type is displayed.

    2. To define an IT resource for the next instance of the target system, first assign a name to the new IT resource on this page. Then, see Section 2.2.2.2, "Configuring the IT Resource" for information about the values to be specified for the parameters of the new IT resource.

    Repeat Steps a and b for the remaining instances of the target system.

    See Also:

    Oracle Identity Manager Tools Reference Guide

  10. Click Skip after you define IT resources for all the instances of the target system. The Confirmation page is displayed.

    See Also:

    If you want to define another IT resource, then see 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.1.3 Compiling Adapters

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

  • SAP EP Remove Role

  • SAP EP Remove Group

  • SAP EP Password Change

  • SAP EP Modify User Date

  • SAP EP Modify User

  • SAP EP Delete User

  • SAP EP Create User

  • SAP EP Add Role

  • SAP EP Add Group

  • SAP EP Lock UnLock User

  • PrePopulate SAP EP Form

  • SAP EP Email Modify

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. In an Oracle Identity Manager cluster, 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.2.2 Installing the Connector on Oracle Identity Manager Release 9.1.0.x or Release 11.1.1

Note:

In this guide, the term Connector Installer has been used to refer to the Connector Installer feature of the Oracle Identity Manager Administrative and User Console.

Installing the connector on Oracle Identity Manager release 9.1.0.x or release 11.1.1 involves performing the following procedures:

2.2.2.1 Running the Connector Installer

To run the Connector Installer:

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

    Note:

    In an Oracle Identity Manager cluster, copy this JAR file to each node of the cluster.

    • For Oracle Identity Manager release 9.1.0.x:

      OIM_HOME/xellerate/ConnectorDefaultDirectory

    • For Oracle Identity Manager release 11.1.1:

      OIM_HOME/server/ConnectorDefaultDirectory

  2. Log in to the Administrative and User Console by using the user account described in the "Creating the User Account for Installing Connectors" section of the following guide:

    • 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

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

    • For Oracle Identity Manager release 9.1.0.x:

      Click Deployment Management, and then click Install Connector.

    • For Oracle Identity Manager release 11.1.1:

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

  4. From the Connector List list, select SAP Enterprise Portal RELEASE_NUMBER. 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 SAP Enterprise Portal 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).

    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. See Section 2.3.1.3, "Clearing Content Related to Connector Resource Bundles from the Server Cache" for information about running the PurgeCache utility.

      There are no prerequisites for some predefined connectors.

    2. Configuring the IT resource for the connector

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

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

      Note:

      In Oracle Identity Manager release 11.1.1, a scheduled job is an instance of a scheduled task. In this guide, the term scheduled task used in the context of Oracle Identity Manager release 9.1.0.x is the same as the term scheduled job in the context of Oracle Identity Manager release 11.1.1.

      See Oracle Fusion Middleware 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 the files in the config directory on the installation media to the OIM_HOME/xellerate/XLIntegrations/LotusNotes/config 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 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 Table 2-1 for information about the files that you must copy and their destination locations on the Oracle Identity Manager server.

2.2.2.2 Configuring the IT Resource

You must specify values for the parameters of the SAP EP IT Resource IT resource as follows:

  1. Log in to the Administrative and User Console.

  2. If you are using Oracle Identity Manager release 9.1.0.x, expand Resource Management, and then click Manage IT Resource.

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

    • On the Welcome page, click Advanced in the upper-right corner of the page.

    • On the Welcome to Oracle Identity Manager Advanced Administration page, in the Configuration region, click Manage IT Resource.

  4. In the IT Resource Name field on the Manage IT Resource page, enter SAP EP IT Resource 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. Table 2-3 describes each parameter.

    Table 2-3 IT Resource Parameters

    Parameter Description

    TimeStamp

    For the first reconciliation run, the time stamp value is not set. For subsequent rounds of reconciliation, the time at which the previous round of reconciliation was completed is stored in this parameter.

    The following are sample time stamp values:

    • English: Jun 01, 2006 at 10:00:00 GMT+05:30

    • French: juil. 01, 2006 at 10:00:00 GMT+05:30

    • Japanese: 6 01, 2006 at 10:00:00 GMT+05:30

    See Section 3.3.1, "Full Reconciliation vs. Incremental Reconciliation" for information about using this parameter to switch from incremental to full reconciliation.

    WSDLLocation

    This parameter holds the location of the WSDL URL, where the Web service is running on SAP Enterprise Portal.

    See Section 2.1.4, "Determining the URL of the Web Service Running on the Target System" for more information.

    SOAPAdminUserID

    Enter the user ID of the user account that the connector will use to login to the target system for reconciliation and provisioning operations.

    See Section 2.3.3, "Creating a Target System User Account for Connector Operations" for more information.

    Sample value: admin

    SOAPAdminPassword

    Enter the password of the user account that the connector will use to login to the target system for reconciliation and provisioning operations.


  8. To save the values, click Update.

2.3 Postinstallation

The following sections discuss postinstallation procedures:

2.3.1 Configuring the Oracle Identity Manager Server

Configuring the Oracle Identity Manager server involves performing the following procedures:

2.3.1.1 Configuring Trusted Source Reconciliation

Note:

This section describes an optional procedure. Perform the procedure only if you want to configure the connector for 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.

Configuring trusted source reconciliation involves the following steps:

  1. Import the XML file for trusted source reconciliation, SAPEPXLResourceObject.xml, by using the Deployment Manager. This section describes the procedure to import the XML file.

  2. Set the IsTrustedSource scheduled task attribute to True. You specify a value for this attribute while configuring the user reconciliation scheduled task, which is described later in this guide.

To import the XML file for trusted source reconciliation:

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

  2. If you are using Oracle Identity Manager release 9.0.1 through 9.0.3.2 or release 9.1.0.x, then:

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

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

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

    1. On the Welcome page, click Advanced in the upper-right corner 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.

  4. Locate and open the SAPEPXLResourceObject.xml file, which is in the xml directory on the installation media.

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

  6. Click Next. The Confirmation page is displayed.

  7. Click Import.

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

After you import the XML file for trusted source reconciliation, you must set the value of the IsTrustedSource reconciliation scheduled task attribute to True. This procedure is described in Section 3.4, "Configuring Scheduled Tasks."

2.3.1.2 Changing to the Required Input Locale

Note:

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

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.3 Clearing Content Related to Connector Resource Bundles from the Server Cache

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 releases 9.0.1 through 9.0.3.2 and 9.1.0.x, and the Oracle Identity Manager database for Oracle Identity Manager release 11.1.1. Whenever you add a new resource bundle to the connectorResources directory or make a change in an existing resource bundle, you must clear content related to connector resource bundles from the server cache.

To clear content related to connector resource bundles from the server cache:

  1. In a command window, perform one of the following steps:

    • If you are using Oracle Identity Manager release 9.1.0.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.

    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 releases 9.0.1 through 9.0.3.2 and 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
    
  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 releases 9.0.1 through 9.0.3.2 and 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.

    See Oracle Fusion Middleware System Administrator's Guide for Oracle Identity Manager for more information about the PurgeCache utility.

2.3.1.4 Enabling Logging

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

2.3.1.4.1 Enabling Logging on Oracle Identity Manager Releases 9.0.1 through 9.0.3.2 and 9.1.0.x

Note:

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

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 and the log file path depend on the application server that you use:

  • IBM WebSphere Application Server

    To enable logging:

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

      log4j.logger.XELLERATE=log_level
      log4j.logger.XL_INTG.SAPEPCONNECTOR=log_level
      
    2. In these lines, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.XELLERATE=INFO
      log4j.logger.XL_INTG.SAPEPCONNECTOR=INFO
      

    After you enable logging, the 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 or add the following lines:

      <category name="XELLERATE">
         <priority value="log_level"/>
      </category>
      
      <category name="XL_INTG.SAPEPCONNECTOR">
         <priority value="log_level"/>
      </category>
      
    2. In the second XML code line of each set, replace log_level with the log level that you want to set. For example:

      <category name="XELLERATE">
         <priority value="INFO"/>
      </category>
      
      <category name="XL_INTG.SAPEPCONNECTOR">
         <priority value="INFO"/>
      </category>
      

    After you enable logging, the 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 lines in the OIM_HOME/xellerate/config/log.properties file:

      log4j.logger.XELLERATE=log_level
      log4j.logger.XL_INTG.SAPEPCONNECTOR=log_level
      
    2. In these lines, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.XELLERATE=INFO
      log4j.logger.XL_INTG.SAPEPCONNECTOR=INFO
      

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

    OAS_HOME/opmn/logs/default_group~home~default_group~1.log

  • Oracle WebLogic Server

    To enable logging:

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

      log4j.logger.XELLERATE=log_level
      log4j.logger.XL_INTG.SAPEPCONNECTOR=log_level
      
    2. In these lines, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.XELLERATE=INFO
      log4j.logger.XL_INTG.SAPEPCONNECTOR=INFO
      

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

2.3.1.4.2 Enabling Logging on Oracle Identity Manager Release 11.1.1

Note:

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

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

  • SEVERE.intValue()+100

    This level enables logging of information about fatal errors.

  • SEVERE

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

  • WARNING

    This level enables logging of information about potentially harmful situations.

  • INFO

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

  • CONFIG

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

  • FINE, FINER, FINEST

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

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

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='sapep-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="XL_INTG.SAPEPCONNECTOR" level="[LOG_LEVEL]" useParentHandlers="false">
           <handler name="sapep-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-4 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='sapep-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="XL_INTG.SAPEPCONNECTOR" level="NOTIFICATION:1" useParentHandlers="false">
           <handler name="sapep-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.5 Configuring the SAP Change Password Function

You can configure the Change Password function to modify password behavior in scenarios such as when a user profile on the target system gets locked or expires. For such scenarios, you can configure the system so that the administrator is not able to reset the password for a locked or expired user profile. This helps prevent discrepancies between data in Oracle Identity Manager and the target system.

To configure the Change Password function:

See Also:

Oracle Identity Manager Design Console Guide

  1. Open the Oracle Identity Manager Design Console.

  2. Expand the Process Management folder.

  3. Open the Process Definition form.

  4. Select the SAP EP Process process definition.

  5. Double-click the Password Updated task.

  6. On the Integration tab, specify values for the following parameters:

    • ValidityChange: You can specify either True or False.

      • True: If the user's validity period has expired, then it is extended to the date specified in the ValidTo parameter.

      • False: If the user's validity period has expired, then it does not extend the validity and the user's password cannot be changed.

    • lockChange: You can specify either True or False.

      • True: If the user is locked but not by the administrator, then the user is unlocked before the change of password. If the user is locked by the administrator, then the password cannot be changed.

      • False: If the user is locked, then the password cannot be changed.

    • ValidTo: Date to which the user's validity must be extended. The date format must be as follows:

      Apr 1 10 11:18:29 AM

      If this field is left empty, then the value is set to 1970-01-01, which is the default date.

      Note:

      The values specified are case-sensitive and must match the case in the SAP system.

2.3.1.6 Enabling Request-Based Provisioning

Note:

The feature described in this section is supported only on Oracle Identity Manager release 11.1.1. Perform the procedure described in this section only if you want to enable request-based provisioning.

In request-based provisioning, an end user creates a request for a resource or entitlement by using the Administrative and User Console. Administrators or other users can also create requests for a particular user. Requests for a particular resource or entitlement on the resource can be viewed and approved by approvers designated in Oracle Identity Manager.

Note:

Direct provisioning cannot be used if you enable request-based provisioning.

Enabling request-based provisioning involves performing the following procedures:

2.3.1.6.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 is the list of predefined request datasets in the DataSet directory on the installation media:

  • ModifyResourceSAP EP Resource Object.xml

  • ProvisionResourceSAP EP Resource Object.xml

Copy the files from the DataSets directory on the installation media to the OIM_HOME/DataSet/file directory.

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 about modifying request datasets.

2.3.1.6.2 Importing Request Datasets into the 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 the 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.

  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 values for the following:

    • Please enter your username [weblogic]

      Enter the user name used to log in to Oracle WebLogic Server.

      Sample value: WL_User

    • Please enter your password [weblogic]

      Enter the password used to log in to Oracle 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 the MDS.

2.3.1.6.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 LOTUSRO process definition.

  4. Select the Auto Save Form check box.

  5. Click the Save icon.

2.3.1.6.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.3, "Clearing Content Related to Connector Resource Bundles from the Server Cache" for instructions.

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

2.3.2 Deploying Web Services on the Target System

To be able to use Web services with the SAP Enterprise Portal connector, you must deploy the ConnectorService.par file as follows:

  1. Log in to SAP Enterprise Portal as the administrator.

  2. Click the System Administration tab, the Support secondary tab, select Portal Runtime and then select Administration Console.

  3. In the Archive Uploader region, browse to the ConnectorService.par file, and then click Upload. After the file is uploaded, an INFO message is displayed.

  4. From the list in the Archive Deployment Checker region, select ConnectorService, and then click Refresh.

2.3.3 Creating a Target System User Account for Connector Operations

Create a target system user account, and assign the super_admin_role and com.sap.pdk.JavaDeveloper roles to it. If the com.sap.pdk.JavaDeveloper role is not available, then obtain the PDK for Java from SAP to get that role required for the installation to work.

The SAPUMLocation parameter of the IT resource holds information about this user account. See Section 2.2.2.2, "Configuring the IT Resource" for information about this parameter.

If the specified roles are not assigned to this user account, then Oracle Identity Manager cannot connect to the target system.

2.3.4 Configuring SSL to Secure Communication Between Oracle Identity Manager and the Target System

This section discusses the following topics:

2.3.4.1 Configuring the Target System for SSL

For instructions on configuring the target system for SSL, visit the SAP Web site at

http://help.sap.com/erp2005_ehp_04/helpdata/DE/a6/98f73dbc570302e10000000a114084/frameset.htm

2.3.4.2 Configuring Oracle Identity Manager for SSL

Configuring Oracle Identity Manager for SSL involves importing the certificate that was created on the target system. To import the certificate:

  1. Copy the certificate of the target system into the JAVA_HOME/lib/security directory of the Oracle Identity Manager host computer.

  2. In a terminal window, change to the JAVA_HOME/bin directory, and then run the following command:

    keytool -import -alias ALIAS -file CERT_FILE_NAME -trustcacerts -keystore MY_CACERTS -storepass PASSWORD
    

    In this command:

    • ALIAS is the alias for the certificate.

    • CERT_FILE_NAME is the complete name and path of the certificate.

    • MY_CACERTS is the full path and name of the certificate store.

    • PASSWORD is the keystore password.

    The following is a sample command:

    keytool -import -alias sapep_trusted_cert -file JAVA_HOME/lib/security/globalsv.crt -trustcacerts -keystore JAVA_HOME/lib/security/cacerts -storepass changeit