2 Deploying the Connector

Deploying the connector involves the following steps:

2.1 Configuring the Target System

For using this connector, you do not need to perform any configuration steps on the target system.

2.2 Copying the Connector Files

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

See Also:

"Files and Directories on the Installation Media" for more information about these files

File in the Installation Media Directory Destination Directory 
lib/xliExchange.jar

OIM_HOME/xellerate/JavaTasks
OIM_HOME/xellerate/ScheduleTask

Files in the resources directory

 
OIM_HOME/xellerate/connectorResources

Files in the xml directory

 
OIM_HOME/xellerate/XLIntegrations/Exchange/xml

Note:

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

2.3 Configuring the Oracle Identity Manager Server

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

Note:

In a clustered environment, you must perform this step on each node of the cluster.

2.3.1 Changing to the Required Input Locale

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

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

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

While performing the instructions described in the "Copying the Connector Files" section, you copy files from the resources directory on the installation media into the OIM_HOME/xellerate/connectorResources directory. Whenever you add a new resource bundle in the connectorResources directory or make a change in an existing resource bundle, you must clear content related to connector resource bundles from the server cache.

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

  1. In a command window, change to the OIM_HOME/xellerate/bin directory.

    Note:

    You must perform Step 1 before you perform Step 2. An exception is thrown if you run the command described in Step 2 as follows:

    OIM_HOME/xellerate/bin/batch_file_name

  2. Enter one of the following commands:

    • On Microsoft Windows:

      PurgeCache.bat ConnectorResourceBundle

    • On UNIX:

      PurgeCache.sh ConnectorResourceBundle

    Note:

    You can ignore the exception that is thrown when you perform Step 2.

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

    OIM_HOME/xellerate/config/xlConfig.xml

2.3.3 Enabling Logging

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

  • ALL

    This level enables logging for all events.

  • DEBUG

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

  • INFO

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

  • WARN

    This level enables logging of information about potentially harmful situations.

  • ERROR

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

  • FATAL

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

  • OFF

    This level disables logging for all events.

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

  • Oracle WebLogic

    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.EXCHANGE=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.EXCHANGE=INFO

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

  • IBM WebSphere

    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.EXCHANGE=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.EXCHANGE=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.EXCHANGE">
   <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.EXCHANGE">
   <priority value="INFO"/>
</category>

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

    JBoss_home/server/default/log/server.log

  • OC4J

    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.EXCHANGE=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.EXCHANGE=INFO

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

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

2.4 Importing the Connector XML Files

As mentioned in the "Files and Directories on the Installation Media" section, 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 files 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 xliExchangeObject_DM.xml file, which is in the OIM_HOME/xellerate/XLIntegrations/Exchange/xml directory. Details of this XML file are shown on the File Preview page.

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

  6. Click Next. The Confirmation page is displayed.

  7. Click Next. The Provide IT Resource Instance Data page for the IT resource is displayed.

  8. Specify values for the parameters of the IT resource. Refer to the following table for information about the values to be specified:

    Parameter Description

    Store Group Name

    Store group name

    Sample value: MyStorageGroup

    Last Modified Time Stamp

    Time at which the last reconciliation run for new and modified mailboxes was completed

    This is in the timestamp format YYYYMMDDHHMMSSZ. At the end of each reconciliation run, the value is updated with the target system time stamp at that instance.

    You must not enter a value for this parameter.

    Last Deleted Time Stamp

    Time at which the last reconciliation run for deleted mailboxes was completed

    This is in the timestamp format YYYYMMDDHHMMSSZ. At the end of each reconciliation run for deleted mailboxes, the value is updated with the target system time stamp at that instance.

    You must not enter a value for this parameter.

    Server Name

    Host name of the Microsoft Windows computer on which Microsoft Exchange is installed

    Sample value: W2K_HOST

    Note: The value must be specified in uppercase.

    Store Name

    Mail store name

    Note: The value that you specify is displayed in the Mail Store field on the process form during provisioning. This is a read-only field.

    Sample value: MyMailStore

    Note:

    When you perform provisioning operations, you must select this IT resource from the list displayed on the process form.

  9. Click Next. The Provide IT Resource Instance Data page for a new instance of the Exchange Server IT resource type is displayed.

  10. If you want to use the same combination of the Server Name, Store Group Name, and Store Name parameters for both provisioning and reconciliation, then click Skip and proceed to Step 13 in this procedure.

  11. If you want to specify a different combination of the Server Name, Store Group Name, and Store Name parameters for reconciliation, then use the Provide IT Resource Instance Date page to create another IT resource.

    Refer to the following table for reconciliation-specific information about the values that you must specify for the parameters of the new IT resource:

    Parameter Description

    Store Group Name

    If you want to fetch mailboxes from a specific store group, then enter the name of the store group.

    If you want to fetch mailboxes from all store groups, then enter the asterisk (*) character.

    Default value: *

    Last Modified Time Stamp

    Time at which the last reconciliation run was completed

    This is in the timestamp format YYYYMMDDHHMMSSZ. At the end of each reconciliation run, the value is updated with the target system timestamp at that instance.

    You need not specify a value for this parameter.

    Server Name

    If you want to fetch mailboxes from a specific Exchange server, then enter the name of the Exchange server.

    If you want to fetch mailboxes from all configured Microsoft Exchange installations, then enter the asterisk (*) character.

    Default value: *

    Store Name

    If you want to fetch mailboxes from a specific mail store, then enter the name of the mail store.

    If you want to fetch mailboxes from all mail stores, then enter the asterisk (*) character.

    Note: The value that you specify is displayed in the Mail Store field on the process form during provisioning. This is a read-only field.

    Default value: *

    Note:

    When you perform provisioning operations, you must not select this IT resource from the list displayed on the process form.

  12. Click Skip to specify that you do not want to define another IT resource. The Confirmation page is displayed.

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

  14. Click Import. The connector XML file is imported into Oracle Identity Manager.

  15. Perform the same procedure to import the xliExchangeSchedulerTask_DM.xml file, which is in the OIM_HOME/xellerate/XLIntegrations/Exchange/xml directory.

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