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

config/adminP.properties

This file is used to specify a value for an AdminP command that is run on the Domino server.

configuration/IBM Lotus Notes Domino-CI.xml

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

config/attributemapping_prov.properties

This file contains the parameters required for provisioning.

config/attributemapping_recon.properties

This file contains the parameters required for reconciliation.

Files in the dataset directory

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

lib/xlLotusNotesProvision.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 release 9.1.0.x: OIM_HOME/xellerate/JavaTasks

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

lib/xlLotusNotesRecon.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 release 9.1.0.x: OIM_HOME/xellerate/ScheduleTask

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

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 release 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/config/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.

test/config/config.properties

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

test/scripts/lotusNotes.bat

This file contains the script required for running test calls from the Oracle Identity Manager server on Microsoft Windows platforms.

test/scripts/lotusNotes.sh

This file contains the script required for running test calls from the Oracle Identity Manager server on UNIX-based platforms.

test/config/config_unid.properties

This file is used to store the value of the UniqueID user attribute while using the testing utility.

Section 5.1, "Testing the Connector" provides information about using this file.

xml/xlLotusNotes_XellerateUser.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.

xml/xlLotusNotesConnector.xml

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

  • IT resource type

  • IT resource

  • Resource object

  • Process definition

  • Process tasks

  • Adapters

  • Process form

  • Lookup definitions


2.1.2 Determining the Release Number of the Connector

Note:

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

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

  2. Open the manifest.mf file in a text editor. The manifest.mf file is one of the files bundled inside the xlLotusNotesRecon.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 External Code Files

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.

Copy the following files into the JAVA_HOME/jre/lib/ext directory:

  • NCSO.jar from the LOTUS_HOME/lotus/Domino/data/domino/java directory

  • Notes.jar from the LOTUS_HOME/Domino/jvm/lib/ext directory

Here, java_installation is the JDK directory used for Oracle Identity Manager and LOTUS_HOME is the directory in which IBM Lotus Notes and Domino is installed.

Section 5.1, "Testing the Connector" describes the procedure to use the testing utility. Before running the testing utility, copy the NCSO.jar and Notes.jar files into the following directory:

  • For Oracle Identity Manager release 9.1.0.x:

    OIM_HOME/xellerate/ThirdParty

  • For Oracle Identity Manager release 11.1.1:

    OIM_HOME/server/ThirdParty

2.1.4 Creating a Target System Account for Connector Operations

Oracle Identity Manager uses a target system user account to provision to and reconcile data from the target system. For IBM Lotus Notes and Domino, this target system account must be a full access administrator account. See the target system documentation for creating an account of this type.

While performing the procedure described in Section 2.2.2, "Configuring the IT Resource," you specify the credentials of the administrator account as the values of the Admin and AdminPwd parameters.

2.2 Installation

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

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 IBM Lotus Notes Domino 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 IBM Lotus Notes Domino 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 Configuring the IT Resource

You must specify values for the parameters of the Lotus Notes 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 LotusNotes 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-2 describes each parameter.

    Table 2-2 Parameters of the IT Resource

    Parameter Description

    AddBook

    Enter True if you want the server entry in the Domino Directory to be updated when the ID file is created. Otherwise, enter False.

    The default value is True.

    Note: The Domino Directory is the database that contains user personal documents, connection documents, server documents, and cross-certification files. This directory is also known as the public address book or names.nsf.

    Admin

    Enter the user ID of the administrator account that you create by performing the procedure described in Section 2.1.4, "Creating a Target System Account for Connector Operations."

    AdminPwd

    Enter the password of the administrator account that you create by performing the procedure described in Section 2.1.4, "Creating a Target System Account for Connector Operations."

    Create Mail DB File

    Enter True if you want a mail file to be created with the ID file when the Register New User function of IBM Lotus Notes and Domino is called. Otherwise, enter False.

    The default value is True.

    Create Mail DB File In Bckgrnd

    Enter True if you want the mail file to be created in the background. Otherwise, enter False.

    The default value is False.

    This parameter is taken into consideration only if the value of the Create Mail DB File parameter is True.

    Note: If you enter True as the value, then the connector cannot verify whether mail files are successfully created during Create User provisioning operations.

    Host

    Enter the host name or IP address of the IBM Lotus Notes and Domino server.

    Port

    Enter the TCP/IP port at which the IBM Lotus Notes and Domino server is listening.

    The default value is 63148.

    IDFilePath

    Enter the path for storing ID files.

    IDType

    Enter the type of ID files to be created.

    The value can be 172 (for HIERARCHICAL) or 173 (for CERTIFIER).

    The default value is 172.

    MailDBPath

    Enter the mail file path.

    MailOwnerAccess

    Enter the mail database ACL setting for the owner.

    The value can be one of the following:

    • 0 (for MANAGER)

    • 1 (for DESIGNER)

    • 2 (for EDITOR)

    The default value is 0.

    MailQuotaLimit

    Enter the maximum size of the user's e-mail database, in megabytes.

    The default value is 50.

    MailQuotaWarning

    Enter the size, in megabytes, at which the user's mail database issues a warning that the size limit may be exceeded.

    The default value is 40.

    MailServer

    Enter the canonical name of the server containing the user's mail file.

    Sample value: CN=ServerName/O=OrgName

    Note: You must enter a value for this parameter.

    MailSystem

    Specify the type of user's mail system.

    The value can be any one of the following:

    • 0 (for NOTES)

    • 3 (for INOTES)

    • 4 (for INTERNET)

    The default value is 0.

    MailTemplateName

    Enter the name of the template for the mail file.

    PasswordLength

    Enter the minimum number of characters that can be used in the password.

    The value can be any number. The default minimum length is 5.

    RegLog

    Enter the name of the log file to be used when creating IDs.

    The default value is log.nsf.

    RegServer

    Enter the canonical name of the server to be used when creating IDs and performing other registration functions.

    Sample value: CN=MyServer/O=MyOrg

    StoreAddBook

    Enter True to specify that the ID file is stored in the Domino Directory of the server. Otherwise, enter False.

    The default value is True.

    Sync Internet Password

    Enter True to specify that the user can use the same password for both local client-based access and Web-based access to IBM Lotus Notes and Domino. Otherwise, enter False.

    The default value is True.

    IsSecure

    Enter Yes to specify that the SSL feature is enabled. Otherwise, enter No.

    The default value is Yes.

    Note: It is recommended that you enable SSL to secure communication between Oracle Identity Manager and the target system.

    DenyAccessGroupName

    Enter the name of the group for users whose accounts have been disabled.

    Note:

    - If there is no Deny Access group on the IBM Lotus Notes and Domino installation, then you must create one by performing the procedure described in the "Creating a Deny Access Group" section.

    - If the target system contains more than one Deny Access group and you don't specify a value for the DenyAccessGroupName parameter, then disabled users automatically become members of the first Deny Access group that the connector finds.

    triggerAdminp

    Enter Yes to specify that the Trigger AdminP feature is enabled. Otherwise, enter No.

    The default value is Yes.

    isAgentInstalled

    Enter Yes if you want to enable support for encrypted e-mail on the target system. Otherwise, enter No.

    See Also: The "Enabling Modification of ID Files" section for more information about this parameter.

    TrustedTimeStamp

    This parameter is used for trusted source reconciliation. Starting with the first reconciliation run, this parameter stores the time stamp at which the reconciliation run ends.

    The default value is None. You can set the value to None whenever you want to perform a full reconciliation run. See Section 3.3.1, "Full Reconciliation vs. Incremental Reconciliation" for more information.

    NonTrustedTimeStamp

    This parameter is used for target resource reconciliation.

    Starting with the first reconciliation run, this parameter stores the time stamp at which the reconciliation run ends.

    The default value is None. You can set the value to None whenever you want to perform a full reconciliation run. See Section 3.3.1, "Full Reconciliation vs. Incremental Reconciliation" for more information.

    Max Retries

    Enter the number of times that the connector must retry connecting to the target server, in case the connection fails.

    The default value is 2.

    Delay

    Enter the delay (in milliseconds) before the connector must retry connecting to the target system, in case the connection fails.

    The default value is 10000.

    TerminatedGroupName

    Enter the name of the Terminated User group to which users who are deleted must be assigned.

    ImmediateDelete

    Use this parameter to specify how the Delete User provisioning operation must be performed. You can specify one of the following values:

    • Enter Yes if you want all references to the user (except for the mail and ID files) in the Domino Directory to be deleted before an administration process request is issued.

      Note:

      - A mail file is deleted only after the administrator approves the administration process request.

      - Deletion of ID files is not supported.

    • Enter No if you want to let the administration process make all required deletions.

    The default value is Yes.

    MailFileActionForDelete

    Use this parameter to specify how mail file deletion must be performed when a user is deleted.

    You can specify one of the following values:

    • Enter Delete All if you want the mail file on the user's home server and all replicas of the mail file to be deleted.

    • Enter Delete Home if you want the mail file on the user's home server to be deleted.

    • Enter Delete None if you do not want the user's mail file to be deleted.

    The default value is Delete All.

    User Info Update History Required

    Enter Yes to specify that history must be maintained for attributes such as short name, internet address, location, forward domain and comment attributes. Otherwise, enter No.

    The default value is Yes.

    See Section 2.3.1.5, "Enabling Storage of Change History for User Attributes" for more information about this parameter.

    Configuration Lookup

    This parameter is used to store the name of the configuration lookup definition.

    Default value: Lookup.Lotus.Configurations

    Note: See Section 2.3.1.5, "Enabling Storage of Change History for User Attributes" for information about this lookup definition. If you create another lookup definition to store connector configuration parameters, then specify the name of the new lookup definition as the value of this parameter.


  8. To save the values, click Update.

2.3 Postinstallation

The following sections discuss postinstallation procedures:

2.3.1 Configuring Oracle Identity Manager

Configuring Oracle Identity Manager involves the following procedures:

Note:

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

2.3.1.1 Configuring Trusted Source Reconciliation

You can configure the connector to designate the target system as a target resource or trusted source.

Note:

You can skip this section if you do not want to designate the target system as a trusted source for reconciliation. As mentioned earlier in this guide, it is recommended that you do not configure the target system as both a trusted source and target resource.

The following is a summary of the steps involved in configuring trusted source reconciliation:

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

    Note:

    Only one target system can be designated as a trusted source. If you import the xlLotusNotes_XellerateUser.xml file while you have another trusted source configured, then both connector reconciliations would stop working.

  2. Specify values for the attributes of the Lotus Notes trusted User Reconciliation scheduled task. This procedure 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.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 xlLotusNotes_XellerateUser.xml file located in the following directory:

    • For Oracle Identity Manager release 9.1.0.x:

      OIM_HOME/xellerate/ConnectorDefaultDirectory/IBM_Lotus_9.0.4.14.0/xml

    • For Oracle Identity Manager release 11.1.1:

      OIM_HOME/server/ConnectorDefaultDirectory/IBM_Lotus_9.0.4.14.0/xml

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

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

2.3.1.2 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.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 release 9.1.0.x and 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 release 9.1.0.x:

    OIM_HOME/xellerate/bin/SCRIPT_FILE_NAME
    

    For Oracle Identity Manager release 11.1.1:

    OIM_HOME/server/bin/SCRIPT_FILE_NAME
    
  2. Enter one of the following commands:

    Note:

    You can use the PurgeCache utility to purge the cache for any content category. Run PurgeCache.bat CATEGORY_NAME on Microsoft Windows or PurgeCache.sh CATEGORY_NAME on UNIX. The CATEGORY_NAME argument represents the name of the content category that must be purged.

    For example, the following commands purge Metadata entries from the server cache:

    PurgeCache.bat MetaData

    PurgeCache.sh MetaData

    • For Oracle Identity Manager release 9.1.0.x:

      On Microsoft Windows: PurgeCache.bat ConnectorResourceBundle

      On UNIX: PurgeCache.sh ConnectorResourceBundle

      Note:

      You can ignore the exception that is thrown when you perform Step 2. This exception is different from the one mentioned in Step 1.

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

      OIM_HOME/xellerate/config/xlconfig.xml

    • For Oracle Identity Manager release 11.1.1:

      On Microsoft Windows: PurgeCache.bat All

      On UNIX: PurgeCache.sh All

      When prompted, enter the user name and password of an account belonging to the SYSTEM ADMINISTRATORS group. In addition, you are prompted to enter the service URL in the following format:

      t3://OIM_HOST_NAME:OIM_PORT_NUMBER
      

      In this format:

      • Replace OIM_HOST_NAME with the host name or IP address of the Oracle Identity Manager host computer.

      • Replace OIM_PORT_NUMBER with the port on which Oracle Identity Manager is listening.

    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 Release 9.1.0.x

Note:

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

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

  • ALL

    This level enables logging for all events.

  • DEBUG

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

  • INFO

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

  • WARN

    This level enables logging of information about potentially harmful situations.

  • ERROR

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

  • FATAL

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

  • OFF

    This level disables logging for all events.

The file in which you set the log level and the log file path depend on the application server that you use:

  • 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.ADAPTER.LOTUSNOTES=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.ADAPTER.LOTUSNOTES=INFO
      

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

  • 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.ADAPTER.LOTUSNOTES=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.ADAPTER.LOTUSNOTES=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="XELLERATE">
         <priority value="log_level"/>
      </category>
      
      <category name="XL_INTG.LOTUSNOTES">
         <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.LOTUSNOTES">
         <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 lines in the OIM_HOME/xellerate/config/log.properties file:

      log4j.logger.XELLERATE=log_level
      log4j.logger.XL_INTG.LOTUSNOTES=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.LOTUSNOTES=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.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-3.

Table 2-3 Log Levels and ODL Message Type:Level Combinations

Log Level ODL Message Type:Level

SEVERE.intValue()+100

INCIDENT_ERROR:1

SEVERE

ERROR:1

WARNING

WARNING:1

INFO

NOTIFICATION:1

CONFIG

NOTIFICATION:16

FINE

TRACE:1

FINER

TRACE:16

FINEST

TRACE:32


The configuration file for OJDL is logging.xml, which is located at the following path:

DOMAIN_HOME/config/fmwconfig/servers/OIM_SERVER/logging.xml

Here, DOMAIN_HOME and OIM_SERVER are the domain name and server name specified during the installation of Oracle Identity Manager.

To enable logging in Oracle WebLogic Server:

  1. Edit the logging.xml file as follows:

    1. Add the following blocks in the file:

      <log_handler name='lotusnotes-handler' level='[LOG_LEVEL]' class='oracle.core.ojdl.logging.ODLHandlerFactory'>
      <property name='logreader:' value='off'/>
           <property name='path' value='[FILE_NAME]'/>
           <property name='format' value='ODL-Text'/>
           <property name='useThreadName' value='true'/>
           <property name='locale' value='en'/>
           <property name='maxFileSize' value='5242880'/>
           <property name='maxLogSize' value='52428800'/>
           <property name='encoding' value='UTF-8'/>
         </log_handler>
      
      <logger name="ADAPTER.LOTUSNOTES" level="[LOG_LEVEL]" useParentHandlers="false">
           <handler name="lotusnotes-handler"/>
           <handler name="console-handler"/>
         </logger>
      
    2. Replace both occurrences of [LOG_LEVEL] with the ODL message type and level combination that you require. Table 2-3 lists the supported message type and level combinations.

      Similarly, replace [FILE_NAME] with the full path and name of the log file in which you want log messages to be recorded.

      The following blocks show sample values for [LOG_LEVEL] and [FILE_NAME]:

      <log_handler name='lotusnotes-handler' level='NOTIFICATION:1' class='oracle.core.ojdl.logging.ODLHandlerFactory'>
      <property name='logreader:' value='off'/>
           <property name='path' value='F:\MyMachine\middleware\user_projects\domains\base_domain1\servers\oim_server1\logs\oim_server1-diagnostic-1.log'/>
           <property name='format' value='ODL-Text'/>
           <property name='useThreadName' value='true'/>
           <property name='locale' value='en'/>
           <property name='maxFileSize' value='5242880'/>
           <property name='maxLogSize' value='52428800'/>
           <property name='encoding' value='UTF-8'/>
         </log_handler>
       
      <logger name="ADAPTER.LOTUSNOTES" level="NOTIFICATION:1" useParentHandlers="false">
           <handler name="lotusnotes-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 Enabling Storage of Change History for User Attributes

Note:

This section describes an optional procedure. Perform this procedure only if you want to enable storing of change history for some user attributes on the target system.

You use the HISTORY_REQUIRED_FOR_ATTRIBUTES entry of the Lookup.Lotus.Configurations lookup definition to specify the attributes for which the target system must maintain change history. You can specify any combination of the following attributes:

  • ShortName

  • InternetAddress

  • Location

  • MailAddress (that is, the ForwardDomain attribute on the target system)

  • Comment

To specify the attributes for which change history must be maintained:

  1. On the Design Console, expand Administration and then double-click Lookup Definition.

  2. Search for and open the Lookup.Lotus.Configurations lookup definition.

  3. In the Decode column for the HISTORY_REQUIRED_FOR_ATTRIBUTES entry, enter any combination of the following attributes in a comma-delimited list:

    • ShortName

    • Location

    • InternetAddress

    • MailAddress (that is, the ForwardDomain attribute on the target system)

    • Comment

    For example: ShortName,InternetAddress,MailAddress

  4. Click the Save icon.

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 available in the dataset directory on the installation media:

  • ProvisionResource_LOTUSRO.xml

  • ModifyProvisionedResource_LOTUSRO.xml

Copy these files from the installation media to any directory on the Oracle Identity Manager host computer. It is recommended that you create a directory structure as follows:

/custom/connector/RESOURCE_NAME

For example:

E:\MyDatasets\custom\connector\LotusNotes

Note:

Until you complete the procedure to configure request-based provisioning, ensure that there are no other files or directories inside the parent directory in which you create the directory structure. In the preceding example, ensure that there are no other files or directories inside the E:\MyDatasets directory.

The directory structure to which you copy the dataset files is the MDS location into which these files are imported after you run the Oracle Identity Manager MDS Import utility. The procedure to import dataset files is described in the next section.

Depending on your requirement, you can modify the file names of the request datasets. In addition, you can modify the information in the request datasets. See Oracle Fusion Middleware Developer's Guide for Oracle Identity Manager for information on modifying request datasets.

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

    Note:

    While setting up the properties in the weblogic.properties file, ensure that the value of the metadata_from_loc property is the parent directory of the /custom/connector/RESOURCE_NAME directory. For example, while performing the procedure in Section 2.3.1.6.1, "Copying Predefined Request Datasets," if you copy the files to the E:\MyDatasets\custom\connector\LotusNotes directory, then set the value of the metada_from_loc property to E:\MyDatasets.

  2. In a command window, change to the OIM_HOME/server/bin directory.

  3. Run one of the following commands:

    • On Microsoft Windows

      weblogicImportMetadata.bat
      
    • On UNIX

      weblogicImportMetadata.sh
      
  4. When prompted, enter 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 MDS at the following location:

    /custom/connector/RESOURCE_NAME

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 Configuring the Target System

Configuring the target system involves performing the following steps:

2.3.2.1 Creating a Deny Access Group

When you disable a user account in IBM Lotus Notes and Domino, that user automatically becomes a member of a Deny Access group. When you reenable the user account, the user is removed from the Deny Access group. The same process is followed when you disable a user account through Oracle Identity Manager. For the Disable User operation to work, there must be at least one Deny Access group in the target system.

If there is no Deny Access group on the IBM Lotus Notes and Domino installation, then you must create one as follows:

  1. Log in to the Lotus Notes client as the administrator.

  2. On the People & Groups tab, click the Groups folder on the left pane.

  3. Click Add Group.

  4. On the New Group tab, provide the following values:

    • Category: Select Administration along with.

    • Group name: Specify a name for the group, for example, noaccess.

    • Group type: Select Deny List Only.

  5. Click Save & Close.

  6. On the Configuration tab, click All Server Documents on the left pane.

  7. On the right pane, double-click the row for the server that you are using.

  8. Open the Security tab.

  9. In the Server Access section, double-click Not Access Server.

  10. In the Select Names dialog box, use the Add button to add the group that you create in Step 4 and then click OK.

  11. Click Save & Close.

The Deny Access group that you create can be viewed by performing Steps 6 through 9.

While configuring the IT resource, you specify the name of the Deny Access group (for example, noaccess) that you create in Step 4 as the value of the DenyAccessGroupName IT resource parameter.

2.3.2.2 Enabling Modification of ID Files

Note:

If you do not want to support encrypted e-mail on the target system, then you can skip this section.

When you create a user account in IBM Lotus Notes and Domino, an ID file is automatically generated for the user account. This ID file holds the encryption key for the user, and it is automatically used when encrypted e-mail is sent or received.

If an administrator changes the user's password in Oracle Identity Manager, then a new ID file is created. This new ID file cannot be used to open existing sent and received encrypted e-mail. From this point onward, existing encrypted e-mail becomes inaccessible.

To avoid this situation:

  1. Configure an agent on IBM Lotus Notes and Domino that modifies existing ID files when the password is updated. This section describes the procedure to configure an agent.

  2. Set the value of the isAgentInstalled IT resource parameter to Yes to indicate that an agent has been configured on IBM Lotus Notes and Domino. This parameter is described later in this guide.

To configure the agent on IBM Lotus Notes and Domino:

  1. Log in to the Lotus Domino Administrator client.

  2. Depending on the target system version that you use, perform one of the following steps:

    • For IBM Lotus Notes and Domino Server 6.5, 7.x:

      From the File menu, select Database and then select Open.

    • For IBM Lotus Domino Server 8.0.x, and 8.5:

      From the File menu, select Application and then select Open.

  3. In the Open Database dialog box, select the name of the Domino server from the Server list.

  4. In the FileName field, enter names.nsf and then click Open.

    Note:

    The IBM Lotus Notes Domino connector does not support multiple Notes Address Books. Only the default address book (names.nsf) is supported.

  5. From the View menu, select Agents.

  6. Click New Agent.

  7. On the first tab of the Agent dialog box (indicated by a bulb icon), enter the following values:

    Name: Enter changePassword.

    Comment: Enter Change password of the ID file.

    Target: Select All documents in database.

  8. On the second tab of the Agent dialog box (indicated by a key icon), select Allow restricted operations from the Set runtime security level list.

  9. Close the dialog box.

  10. On the changePassword-Agent tab, select LotusScript from the second list.

  11. From the menu on the Objects pane, select the [Options] method.

  12. Open the following file in the installation media directory:

    script/lotusagent.txt

  13. Copy the LotusScript code from the lotusagent.txt file to the right pane of the Lotus Notes client window.

  14. From the File menu, select Save.

You specify the credentials of a Lotus Notes administrator account in the IT resource definition. After you configure the agent on IBM Lotus Notes and Domino, you must ensure that this Lotus Notes administrator account has the permissions required to update the ID files as follows:

  1. Log in to the Lotus Domino Administrator client.

  2. Depending on the target system version that you use, perform one of the following steps:

    • For IBM Lotus Notes and Domino Server 6.5, 7.x:

      From the File menu, select Database and then select Open.

    • For IBM Lotus Domino Server 8.0.x, 8.5:

      From the File menu, select Application and then select Open.

  3. Select the Lotus Notes administrator account that you are using to connect to the Domino server.

  4. In the Access Control List dialog box, select Manager from the Access list and then select the Delete documents check box.

  5. Click OK.

2.3.2.3 Additional Functionality Changes Related to the ID Files

The following fields have been added on the user process form:

  • ID File Name

    You can use the ID File Name field to specify a name for the ID file while creating a user account.

  • Old Password

    The Old Password field stores the latest password of the user in encrypted form. The value of this field is changed automatically during Create Password and Update Password provisioning operations.

    Note:

    After reconciliation, for user accounts for which the password has been changed on the target system, the users must manually enter the new password in this field on Oracle Identity Manager.

2.3.2.4 Ensuring That the Domino IIOP (DIIOP) Task Is Running

To ensure that the Domino IIOP (DIIOP) task is running, open the IBM Lotus Notes and Domino console and run the Load DIIOP command.

If the DIIOP task was not running, then it is started after you run the command. If it was running, then a message that the task has already been started is displayed.

2.3.3 Configuring SSL

Note:

To set up SSL connectivity between Oracle Identity Manager and the IBM Lotus Notes and Domino server:

  1. Ensure that the DIIOP and HTTP tasks are running on the IBM Lotus Notes and Domino server for SSL communication.

    Note:

    If you have already performed the procedure described in the "Configuring the Target System" section, then the DIIOP task is already running.

  2. On the IBM Lotus Notes and Domino server, create a key ring using the Server Certificate Admin (certsrv.nsf) database. Move the two key ring files, keyfile.kyr and keyfile.sth, to the data directory of the server.

  3. Restart the DIIOP task to generate a file named TrustedCerts.class in the IBM Lotus Notes and Domino data directory. The following is the typical path where this file may be found:

    LOTUS_HOME/Domino/data/domino/java

    Here, LOTUS_HOME is the directory in which IBM Lotus Notes and Domino is installed.

  4. Package the TrustedCerts.class file in the TrustedCerts.jar file.

  5. Move the TrustedCerts.jar file to the JAVA_HOME\jre\lib\ext directory on Oracle Identity Manager host. Here, JAVA_HOME is the JDK installation directory that is used by Oracle Identity Manager.