Skip Headers
Oracle® Identity Manager Connector Guide for BMC Remedy User Management
Release 9.0.4

Part Number E10422-04
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
View PDF

2 Deploying the Connector

Deploying the connector involves the following steps:

2.1 Verifying Deployment Requirements

The following table lists the deployment requirements for the connector.

Item Requirement
Oracle Identity Manager Oracle Identity Manager release 8.5.3.1 or later
Target systems BMC Remedy AR System 7.x

Note: The target system does not support SSL communication.

External code files The set of required files depends on the operating system on which Oracle Identity Manager is running. See "Copying the Connector Files and External Code Files" for more information.
Target system user account User account that is a member of the APP-Administrator group

You provide the credentials of this user account while defining the IT resource. The procedure is described later in this guide.

If the specified privileges were not assigned to the target system user account, then the following message would be displayed:

You do not have write access.


2.2 Copying the External Code Files

Depending on the operating system on which Oracle Identity Manager is running, perform the procedure described in one of the following sections:

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.2.1 Oracle Identity Manager Running on Microsoft Windows

To copy external code files on Oracle Identity Manager running on Microsoft Windows:

  1. Copy the following files from the BMC Remedy Admin Client installation directory (for example, C:/Program Files/AR System) to the OIM_HOME/xellerate/ThirdParty directory:

    Note:

    If you do not have these files in your target system installation directory, then check with your vendor.

    arapi70.jar

    arutil70.jar

    arapi70.dll

    arjni70.dll

    arrpc70.dll

    arutl70.dll

    icudt32.dll

    icuin32.dll

    icuuc32.dll

  2. Include OIM_HOME/xellerate/ThirdParty in the PATH environment variable.

2.2.2 Oracle Identity Manager Running on Linux or Solaris

To copy external code files on Oracle Identity Manager running on Linux or Solaris:

  1. Copy the following files from the BMC Remedy Admin Client installation directory (for example, BMC_HOME/ar/mid-tier/WEB-INF/lib/) to the OIM_HOME/xellerate/ThirdParty directory:

    Note:

    If you do not have these files in your target system installation directory, then check with your vendor.

    These.so files are different for different (for example, x86 and SPARC) platforms. Ensure that you use the.so files that are specific to the type of platform on which Oracle Identity Manager is running.

    libarjni70.so

    libarutiljni70.so

    libicudatabmc.so

    libicudatabmc.so.32

    libicui18nbmc.so

    libicui18nbmc.so.32

    libicuiobmc.so

    libicuiobmc.so.32

    libicuucbmc.so

    libicuucbmc.so.32

    arapi70.jar

    arutil70.jar

  2. Add the following lines at the end of the system profile file:

    LD_LIBRARY_PATH=OIM_HOME/xellerate/ThirdParty
    export LD_LIBRARY_PATH
    

2.3 Installing the Connector on Oracle Identity Manager Release 9.1.0 or Later

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

2.3.1 Running the Connector Installer

To run the Connector Installer:

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

    OIM_HOME/xellerate/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 Oracle Identity Manager Administrative and User Console.

  3. Click Deployment Management, and then click Install Connector.

  4. From the Connector List list, select BMC Remedy User Management 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 BMC Remedy User Management 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 XML files (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 1.

  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. Refer to "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

      Record the names of the scheduled tasks displayed on this page. The procedure to configure these scheduled tasks is described later in this guide.

You must manually copy the following files to the specified destination directories:

File in the Installation Media Directory Destination Directory
Files in the config directory

Files in the test/config directory

OIM_HOME/xellerate/XLIntegrations/BMC/config
Files in the test/scripts directory
OIM_HOME/xellerate/XLIntegrations/BMC/scripts

Installing the Connector in an Oracle Identity Manager Cluster

While installing Oracle Identity Manager in a clustered environment, 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 1-1 for information about the files that you must copy and their destination locations on the Oracle Identity Manager server.

2.3.2 Configuring the IT Resource

Note:

Perform this procedure if you are installing the connector on Oracle Identity Manager release 9.1.0 or later.

You must specify values for the parameters of the BMC IT resource as follows:

  1. Log in to the Administrative and User Console.

  2. Expand Resource Management.

  3. Click Manage IT Resource.

  4. In the IT Resource Name field on the Manage IT Resource page, enter BMC 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. The following table describes each parameter:

    Parameter Description
    UserName User ID that is used to connect to the target system

    The default value is Demo.

    Password Password for the user ID that is used to connect to the target system
    ServerName IP address or computer name of the BMC Remedy User Management server
    Port TCP/IP port at which the BMC Remedy User Management server is listening

    The default value is 0.

    TrustedField Unique identification key for searching user records

    The default value is Person ID.

    TrustedTimeStamp This parameter is used for trusted source reconciliation.

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

    The default value is None. Do not change it.

    NonTrustedTimeStamp This parameter is used for target resource reconciliation.

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

    The default value is None. Do not change it.

    IsSecure Specifies whether or not the encryption feature is enabled

    The value can be YES or NO. The default value is NO.

    DeleteUserFormName Name of the form in the target system from which details of deleted users can be obtained

    The value is CTM:People.

    FormName Name of the form in the target system from which details of newly created and updated users can be obtained

    The value is CTM:People.

    NumberOfTrials Number of times the connection to the target system must be retried before the InvocationTargetException is thrown

    Default value: 2

    DelayBetweenTrials Time difference between subsequent retries (in milliseconds)

    Default value: 20000

    SupportGroupFormName Name of the form on the target system from which details of newly created and updated support group for a user can be obtained

    The value is CTM:Support Group Association.

    SupportGroupTrustedField Unique identification key for searching support group records for a user.

    The default value is Support Group Association ID.


  8. To save the values, click Update.

2.4 Installing the Connector on Oracle Identity Manager Release 8.5.3.1 Through 9.0.3.1

Installing the connector on any Oracle Identity Manager release between releases 8.5.3.1 and 9.0.3 involves the following procedures:

2.4.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:

The directory paths given in the first column of this table correspond to the location of the connector files in the following directory on the installation media:
Help Desk/BMC Remedy/BMC Remedy User Management

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

File in the Installation Media Directory Destination Directory
Files in the config directory

Files in the test/config directory

OIM_HOME/xellerate/XLIntegrations/BMC/config
lib/JavaTask/xlBMCRemedy.jar
OIM_HOME/xellerate/JavaTasks
File in the resources directory
OIM_HOME/xellerate/connectorResources
Files in the test/scripts directory
OIM_HOME/xellerate/XLIntegrations/BMC/scripts
xml/BMCConnector_DM.xml
xml/BMCXellerateUser_DM.xml
OIM_HOME/xlclient

2.4.2 Importing the Connector XML File

As mentioned in the "Files and Directories That Comprise the Connector" 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 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 BMCXellerateUser_DM.xml file, which is in the OIM_HOME/xlclient 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 BMC IT resource is displayed.

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

    Parameter Description
    UserName User ID that is used to connect to the target system

    The default value is Demo.

    Password Password for the user ID that is used to connect to the target system
    ServerName IP address or computer name of the BMC Remedy User Management server
    Port TCP/IP port at which the BMC Remedy User Management server is listening

    The default value is 0.

    TrustedField Unique identification key for searching user records

    The default value is Person ID.

    TrustedTimeStamp This parameter is used for trusted source reconciliation.

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

    The default value is None. Do not change it.

    NonTrustedTimeStamp This parameter is used for target resource reconciliation.

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

    The default value is None. Do not change it.

    IsSecure Specifies whether or not the encryption feature is enabled

    The value can be YES or NO. The default value is NO.

    DeleteUserFormName Name of the form in the target system from which details of deleted users can be obtained

    The value is CTM:Delete.

    FormName Name of the form in the target system from which details of newly created and updated users can be obtained

    The value is CTM:People.

    NumberOfTrials Number of times the connection to the target system must be retried before the InvocationTargetException is thrown

    Default value: 2

    DelayBetweenTrials Time difference between subsequent retries (in milliseconds)

    Default value: 20000

    SupportGroupFormName Name of the form on the target system from which details of newly created and updated support group for a user can be obtained

    The default value is CTM:Support Group Association.

    SupportGroupTrustedField Unique identification key for searching support group records for a user.

    The default value is Support Group Association ID.


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

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

    See Also:

    If you want to define another IT resource, then refer to Oracle Identity Manager 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.

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

2.5 Configuring the Target System

Configuring the target system involves the following steps:

2.5.1 Enabling Encryption

This section discusses the following topics related to Remedy encryption:

2.5.1.1 Configuring Remedy Encryption

To enable encryption and set encryption options, you must include server encryption options in the ar.conf file (UNIX) or the ar.cfg file (Microsoft Windows). You can do this by using a text editor.

You can set the Encrypt-Security-Policy encryption option. This is an integer value that indicates whether or not encryption is enabled. If this option is not in the ar.cfg (or ar.conf) file, then encryption is disabled by default. If encryption is enabled, then you can set encryption to any one of the following values to this option:

  • 0: Encryption is allowed. Clients and servers with or without encryption enabled on them can connect to this AR System server.

  • 1: Encryption is required. Only clients and servers that have encryption enabled on them can connect to this AR System server.

  • 2: Encryption is disallowed. Regardless of whether or not encryption is enabled, clients and servers can communicate without encryption.

The following table explains sample settings for the options that you can add in the ar.conf (or ar.cfg) file.

Option Settings Significance
Encrypt-Security-Policy: 1 Encryption is required.
Encrypt-Public-Key-Expire: 86400 Public key duration is 1 day (86400 seconds).
Encrypt-Symmetric-Data-Key-Expire: 2700 Symmetric data encryption key duration is 45 minutes (2700 seconds).
Encrypt-Public-Key-Algorithm: 5 Public key encryption key strength is RSA-1024 (Performance Security).
Encrypt-Data-Encryption-Algorithm: 2 Symmetric data encryption key strength is RC4 128-bit (Performance Security).

If you do not set these options, then the default values are used. Defaults for the level of encryption depend on the encryption product that you are using.

To enable Remedy encryption:

  1. Exit or stop all AR System processes that are running.

    To do this, open Control Panel, Administrator Tools, and Services. Stop each AR System process that is running.

  2. In the ar.conf file (for UNIX) or the ar.cfg file (for Microsoft Windows), add the Encrypt-Security-Policy option with a setting of 0 (encryption is allowed) or 1 (encryption is required). Add other options in the file as required.

    The default UNIX directory for the ar.conf file is ar_install_dir/conf. In Microsoft Windows, the ar.cfg file is stored in the ar_install_dir\conf directory. Here, ar_install_dir is the installation directory for ARSystem on the AR server.

    Caution:

    If you set the Encrypt-Security-Policy option to 1 (encryption is required), then communication is not allowed for any server or client that has not been upgraded to use encryption.
  3. Restart the AR System server.

2.5.1.2 AR System Encryption Error Messages

When the AR System server is started, it checks encryption licensing and encryption configuration settings, if encryption is enabled. If the appropriate Remedy Encryption product licenses are not detected or if invalid configuration settings are detected, then one or more of the following error messages are displayed.

Error Number Error Message and Description
9010 Encryption is enabled, but the encryption library is not found.

Install the Remedy Encryption product.

9012 No encryption license.

Add the encryption license for the Remedy Encryption product that you are using.

9013 The encryption license does not match the type of Remedy Encryption product that is installed.

Obtain the license for the type of Remedy Encryption product that is installed.

9006 The encryption library does not support the specified public key encryption algorithm.

Set the Encryption-Public-Key-Algorithm option in the ar.cfg (or ar.conf) file to a value that is supported by the type of AR System Encryption product that is installed.

9007 The encryption library does not support the specified data encryption algorithm.

Set the Encrypt-Data-Encryption-Algorithm option in the ar.cfg (or ar.conf) file to a value that is supported by the type of AR System Encryption product that is installed.


If encryption is disabled, then encryption error checking does not occur and encryption errors are bypassed. Error messages are listed in the order in which they are detected.

2.6 Configuring the Oracle Identity Manager Server

Configuring the Oracle Identity Manager server involves the following procedures:

Note:

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

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

When you perform the deployment procedure, files from the resources directory on the installation media are copied 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.6.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 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:

  • BEA WebLogic Server

    To enable logging:

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

      log4j.logger.Adapter.BMCRemedy=log_level
      
    2. In this line, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.Adapter.BMCRemedy=INFO
      

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

    WebLogic_home/user_projects/domains/domain_name/server_name/server_name.log
    
  • IBM WebSphere Application Server

    To enable logging:

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

      log4j.logger.Adapter.BMCRemedy=log_level
      
    2. In this line, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.Adapter.BMCRemedy=INFO
      

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

    WebSphere_home/AppServer/logs/server_name/startServer.log
    
  • JBoss Application Server

    To enable logging:

    1. In the JBoss_home/server/default/conf/log4j.xml file, locate the following lines:

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

      <category name="Adapter.BMCRemedy">
         <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 line in the OIM_HOME/xellerate/config/log.properties file:

      log4j.logger.Adapter.BMCRemedy=log_level
      
    2. In this line, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.Adapter.BMCRemedy=INFO
      

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

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