2 Deploying the Connector

This chapter is divided into the following sections:

2.1 Files and Directories on the Installation Media

The files and directories on the installation media are listed and described in Table 2-1.

Table 2-1 Files and Directories On the Installation Media

File in the Installation Media Directory Description

configuration/BMC RemedyTicket Reconciliation-CI.xml

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

config/attributemapping_prov.properties

This file contains the attributes required for provisioning.

config/attributemapping_recon.properties

This file contains the attributes 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/xlBMCRemedyTicket.jar

This JAR file contains the class files required for provisioning. During connector installation, this file is copied to the following location:

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

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

lib/xlBMCRemedyTicketRecon.jar

This JAR file contains the class files required for reconciliation. During connector installation, this file is copied to the following location:

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

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

File in the resources directory

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

  • For Oracle Identity Manager release 9.0.1 through 9.0.3.x and 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/config.properties

This file contains the parameters required to connect to the target system and test connector operations.

test/config/log.properties

This file is used to store log information from tests that you run.

test/scripts/BMCRemedyTicket.bat

test/scripts/BMCRemedyTicket.sh

This file is used to run the test utility.

xml/BMCTicketConnector_DM.xml

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

  • IT resource type

  • IT resource

  • Resource object

  • Process form

  • Process definition

  • Process tasks

  • Adapter tasks

  • Lookup definitions

  • Scheduled tasks

2.2 Determining the Release Number of the Connector

Note:

If you are using Oracle Identity Manager release 9.0.1 through 9.0.3.1 or 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 can use the following method to determine the release number of the connector:

  1. Extract the contents of the xlBMCRemedyTicket.jar file. This file is in the following directory on the installation media:

    OIM_HOME/xellerate/JavaTasks/xlBMCRemedyTicket.jar

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

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

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

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

  1. Copy the arapi70.jar and arutil70.jar files from the BMC Remedy Admin Client installation directory (for example, C:/Program Files/AR System) to the JAVA_HOME/jre/lib/ext directory. Here, JAVA_HOME is the location of the JDK directory for your application server.

  2. Copy the following files from the BMC Remedy Admin Client installation directory to the OIM_HOME/xellerate/ThirdParty directory for Oracle Identity Manager release 9.0.1 through 9.0.3.x or release 9.1.0.x, and the OIM_HOME/server/ThirdParty directory for Oracle Identity Manager release 11.1.1:

    Note:

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

    arapi70.dll

    arjni70.dll

    arrpc70.dll

    arutl70.dll

    icudt32.dll

    icuin32.dll

    icuuc32.dll

  3. Depending on the Oracle Identity Manager release you are using, include one of the following directories in the PATH environment variable:

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

      OIM_HOME/xellerate/ThirdParty

    • For Oracle Identity Manager release 11.1.1:

      OIM_HOME/server/ThirdParty

2.3.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 arapi70.jar and arutil70.jar files from the BMC Remedy Admin Client installation directory (for example, BMC_HOME/ar/mid-tier/WEB-INF/lib/) to the JAVA_HOME/jre/lib/ext directory. Here, JAVA_HOME is the location of the JDK directory for your application server.

  2. Copy the following files from the BMC Remedy Admin Client installation directory to the OIM_HOME/xellerate/ThirdParty directory for Oracle Identity Manager release 9.0.1 through 9.0.3.x or release 9.1.0.x, and the OIM_HOME/server/ThirdParty directory for Oracle Identity Manager release 11.1.1:

    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

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

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

      LD_LIBRARY_PATH=OIM_HOME/xellerate/ThirdParty
export LD_LIBRARY_PATH

    • For Oracle Identity Manager release 11.1.1:

      LD_LIBRARY_PATH=OIM_HOME/server/ThirdParty
export LD_LIBRARY_PATH

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

2.4.1 Running the Connector Installer

To run the Connector Installer:

  1. Copy the contents of the connector installation media directory 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 BMC Remedy Ticket Management RELEASE_NUMBER. This list displays the names and release numbers of connectors whose installation files you copy into the default connector installation directory in Step 1.

    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 Ticket 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 Oracle Identity Manager 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.7.2, "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.

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 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 Section 2.1, "Files and Directories on the Installation Media" for information about the files that you must copy and their destination locations on the Oracle Identity Manager server.

2.4.2 Copying Files to the Oracle Identity Manager Host Computer

After you run the Connector Installer, you must manually copy the files listed in Table 2-2.

Note:

If a particular destination directory does not exist on the Oracle Identity Manager host computer, then create it.

Table 2-2 Files to Be Copied to the Oracle Identity Manager Host Computer

Files on the Installation Media Destination Directory on the Oracle Identity Manager Release 9.1.0.x Host Computer Destination Directory on the Oracle Identity Manager Release 11.1.1 Host Computer

Files in the config directory

OIM_HOME/xellerate/XLIntegrations/BMCTICKET/config

OIM_HOME/server/XLIntegrations/BMCTICKET/config

Files in the test/config directory

OIM_HOME/xellerate/XLIntegrations/BMCTICKET/config

OIM_HOME/server/XLIntegrations/BMCTICKET/config

Files in the test/scripts directory

OIM_HOME/xellerate/XLIntegrations/BMCTICKET/scripts

OIM_HOME/server/XLIntegrations/BMCTICKET/scripts

2.4.3 Configuring the IT Resource

You must specify values for the parameters of the BMCTicket 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 BMCTicket 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
    SeverName IP address or computer name of the BMC Remedy server.
    Port TCP/IP port at which the BMC Remedy server is listening

    The default value is 0.
    LastReconTime Starting with the first reconciliation run, this parameter stores the time-stamp value at which the reconciliation run ends.

    The default value is None.
    IsSecure Specifies whether or not the encryption feature is enabled

    The value can be YES or NO. The default value is NO.
    FormNameHelpDesk Name of the form/view in the target system from which details of newly created and updated Ticket can be obtained

    The default value is HPD:Help Desk.
    FormNameInterface Name of the form/view in the target system from which details of newly created tickets can be obtained

    The default value is HPD:IncidentInterface_Create.
    NoOfTrials The maximum number of times the connector tries to connect to the target system.

    The default value is 2.
    DelayBetweenTrials The time gap to connect to Target system when timeout occurs.

    The default value is 2000.
    FullNameOfUser Full name of the user who is trying to connect to the target system.

  8. To save the values, click Update.

2.5 Installing the Connector on Oracle Identity Manager Release 9.0.1 Through 9.0.3.x

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

2.5.1 Copying the Connector Files

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

Note:

See Section 2.1, "Files and Directories on the Installation Media" for more information about files in the following table.
File in the Installation Media Directory Destination Directory
Files in the config directory

Files in the test/config directory

 OIM_HOME/xellerate/XLIntegrations/BMCTICKET/config
lib/xlBMCRemedyTicket.jar OIM_HOME/xellerate/JavaTasks
lib/xlBMCRemedyTicketRecon.jar OIM_HOME/xellerate/ScheduleTask
File in the resources directory OIM_HOME/xellerate/connectorResources
Files in the test/scripts directory OIM_HOME/xellerate/XLIntegrations/BMCTICKET/scripts
xml/BMCTicketConnector_DM.xml OIM_HOME/xlclient

2.5.2 Importing the Connector XML File

As mentioned in Section 2.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 BMCTicketConnector_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 BMCTicket IT resource is displayed.

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

  9. Click Next. The Provide IT Resource Instance Data page for a new instance of the BMCRemedyTicket 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.

2.5.3 Compiling Adapters

Note:

You must perform the procedure described in this section if you want to use the provisioning features of Oracle Identity Manager for this target system.

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

See Also:

Section 1.6.4, "Provisioning Functions" for a listing of the provisioning functions that are available with this connector

  • adpBMCCreateTicket

  • adpBMCUpdateTicket

  • adpBMCTKTUserId

  • adpBMCUpdateLookupTicket

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. If Oracle Identity Manager is installed in a clustered environment, then 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.6 Configuring the Target System

Configuring the target system involves the following steps:

2.6.1 Customizing the HPD:IncidentInterface_Create and HPD:Help Desk Forms for Each Target Application

Each target application must have a custom ticket form in BMC Remedy. To create a custom ticket form for a target application, you can use one of the following methods:

  • Create a copy of the HPD:IncidentInterface_Create and HPD:Help Desk forms.

  • Create a view that is based on the HPD:IncidentInterface_Create and HPD:Help Desk forms.

Before you create a copy or view of the HPD:IncidentInterface_Create or HPD:Help Desk form, you must perform the following steps:

See Also:

Action request system 7.1 Developing ARSystem Application:Basic for more information about adding fields on forms and to create views

  1. Add the OIMUserId field on the HPD:IncidentInterface_Create or HPD:Help Desk form as follows:

    1. Log in to BMC Remedy Administrator.

    2. Click Filters.

    3. Open the form.

    4. If you are adding the field on the HPD:Help Desk form, then click the Contact tab.

    5. Create a Character field and place the field as required.

    6. Open the Field Properties dialog box for the character field that you create.

    7. Click the Display tab.

    8. In the Label field, enter OIMUserID.

    9. Click the Permissions tab, and then assign the Public permission.

    10. Close the Field Properties page.

    11. Save the changes made to the form.

  2. Update the HPD:HII:CreateIncident_100'! filter as follows so that it pushes values from the HPD: IncidentInerface_Create form to the HPD:Help Desk form:

    1. Log in to BMC Remedy Administrator.

    2. Click Filters.

    3. Open the HPD:HII:CreateIncident_100`! filter.

    4. Click the If-Action(1) tab.

    5. In the Fields region:

      • From the Name menu, select OIMUserID.

      • From the Value menu, select OIMUserID.

    6. Save the filter, and then close it.

  3. Update the value of the OIMUserId field in the attributemapping_prov.properties and attributemapping_recon.properties files.

    These files are in the following directory:

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

      OIM_HOME/xellerate/XLIntegrations/BMCTICKET/config

    • For Oracle Identity Manager release 11.1.1:

      OIM_HOME/server/XLIntegrations/BMCTICKET/config

    In the attributemapping_prov.properties file, search for the following line:

    OIMUserId=<database ID>

    In this line, replace <database ID> with the database ID. For example:

    OIMUserId=536870915

    In the attributemapping_recon.properties file, search for the following line:

    Ticket.OIMUserId=<database ID>

    In this line, replace <database ID> with the database ID. For example:

    Ticket.OIMUserId=536870915

After you make these changes, create a copy or view of the form for each target system. In each view or copy, add fields to provide information about the following:

  • Target application name

  • Access information for target application modules

  • User-specific details

2.6.2 Enabling Encryption

This section discusses the following topics related to Remedy encryption:

2.6.2.1 Enabling 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.

Sample Encryption Product Settings in the Configuration File

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 AR System 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.6.2.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.7 Configuring Oracle Identity Manager

Configuring Oracle Identity Manager involves the following procedures:

2.7.1 Changing to the Required Input Locale

Note:

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

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

Note:

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

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.0.1 through 9.0.3.x and 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.0.1 through 9.0.3.x or 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.0.1 through 9.0.3.x or 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.0.1 through 9.0.3.x or 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.7.3 Enabling Logging

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

2.7.3.1 Enabling Logging on Oracle Identity Manager Release 9.0.1 through 9.0.3.x or 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 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 might 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.

  • IBM WebSphere Application Server

    To enable logging:

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

      log4j.logger.Adapter.BMCTicket=log_level

    2. In this line, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.Adapter.BMCTicket=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.BMCTicket">
   <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.BMCTicket">
   <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 line in the OIM_HOME/xellerate/config/log.properties file:

      log4j.logger.Adapter.BMCTicket=log_level

    2. In this line, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.Adapter.BMCTicket=INFO

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

      log4j.logger.Adapter.BMCTicket=log_level

    2. In this line, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.Adapter.BMCTicket=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

2.7.3.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='bmcticket-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.BMCTICKET" level="[LOG_LEVEL]" useParentHandlers="false">
     <handler name="bmcticket-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='bmcticket-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.BMCTICKET" level="NOTIFICATION:1" useParentHandlers="false">
     <handler name="bmcticket-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.7.4 Configuring Oracle Identity Manager for Request-Based Provisioning

Note:

Perform the procedure described in this section only if you are using Oracle Identity Manager release 11.1.1 and you want to configure request-based provisioning.

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

The following are features of request-based provisioning:

  • A user can be provisioned only one resource (ticket) on the target system.

    Note:

    Direct provisioning allows the provisioning of multiple tickets on the target system.

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

To configure request-based provisioning, perform the following procedures:

2.7.4.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 are the predefined request datasets available in the dataset directory on the installation media:

  • provisionresource_bmcticketro.xml

  • modifyprovisionedresource_bmcticketro.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\BMCTM

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.7.4.2 Importing Request Datasets into 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 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.7.4.1, "Copying Predefined Request Datasets," if you copy the files to the E:\MyDatasets\custom\connector\BMCTM 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 the following values:

    • Please enter your username [weblogic]

      Enter the username used to log in to the WebLogic server

      Sample value: WL_User

    • Please enter your password [weblogic]

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

2.7.4.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 BMCTicketProcess process definition.

  4. Select the Auto Save Form check box.

  5. Click the Save icon.

2.7.4.4 Running the PurgeCache Utility

Run the PurgeCache utility to clear content belonging to the Metadata category from the server cache. See Section 2.7.2, "Clearing Content Related to Connector Resource Bundles from the Server Cache" for instructions.

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

2.7.5 Updating the Lookup.BMCTKT.QueryAttribute Lookup Definition

During reconciliation, the scheduled task runs a query (or filter) on the target system to fetch records that meet reconciliation criteria. This filter is based on the Status attribute of the scheduled task and the Last Modified Timestamp parameter of the IT resource. The Lookup.BMCTKT.QueryAttribute lookup definition is used to hold details of this scheduled task attribute and IT resource parameter. The following are the entries in this lookup definition:

Code Key Decode
Status ScheduledTask,Status
LastReconTime ITResource,Last Modified Date,Date

In the second Decode value, Last Modified Date is the name of the target system column. If the name of this column is different on your target system installation, then:

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

  2. Search for and open the Lookup.BMCTKT.QueryAttribute lookup definition.

  3. In the Decode value for LastReconTime, make the required change in the column name.

    For example, if the name of this column is Modified On on your target system, then change the Decode value to the following:

    ITResource,Modified On,Date

  4. Click the Save icon.