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

Part Number B32348-01
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:

If you want to configure the connector for multiple installations of BMC Remedy User Management, then perform the following procedure:

Step 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 or later
Target systems BMC Remedy AR System 6.0
External code The following JAR and DLL files from the BMC Remedy Admin Client installation directory:
arapi60.jar
arutil60.jar
arapi60.dll
arjni60.dll
arrpc60.dll
arutl60.dll
Target system user account User account that is a member of the APP-Administrator group

You provide the credentials of this user account while performing the procedure in the "Defining IT Resources" section.


Step 2: Configuring the Target System

Configuring the target system involves the following steps:

Creating a User

Use the User form to create a user with License Type=Fixed. This user account is used to create new (custom) forms.

Creating the SHR:DeletePeople Form

The SHR:DeletePeople form is used to store details of deleted users. This information is required during reconciliation.

To create the SHR:DeletePeople form:

  1. Open the ArAdmin tool.

    Connect to the BMC Remedy User Management server by using the Demo user ID. The password can be left blank.

  2. Click Forms.

  3. Click the SHR:People form.

  4. Select Save As from the File menu, and save this form as SHR:DeletePeople.

To create a database trigger for moving deleted user records from the SHR:People form to the SHR:DeletePeople form:

  1. Determine the names of the tables for the SHR:People and SHR:DeletePeople forms by running the following SELECT statement on the Oracle Database created for BMC Remedy.

    SELECT name,schemaid FROM arschema WHERE name LIKE 'SHR:People';
    
    
  2. Log in to the BMC Remedy Database by using SQL*Plus.

  3. At the SQL prompt, copy the SQL code from the following file in the installation media directory:

    BMCTrigger\Trigger.txt
    
    
  4. In the SQL code, replace the dummy table names, 57 and 608, with the table names that you determine by performing Step 1.

  5. Run the SQL code to create the trigger.

Enabling Encryption

This section discusses the following topics related to Remedy encryption:

Enabling Remedy Encryption

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.

Configuring Remedy Encryption Products

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 encryption is enabled, then you can set encryption to required or allowed. If this option is not in the ar.cfg (or ar.conf) file, then encryption is disabled by default. You can assign 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.

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.

Step 3: Copying the Connector Files and External Code

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 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
BMCTrigger\Trigger.txt
OIM_home\xellerate\BMCTrigger
lib\JavaTask\xlBMCRemedy.jar
OIM_home\xellerate\JavaTasks
lib\ScheduleTask\xlBMCRemedyRecon.jar
OIM_home\xellerate\ScheduleTask
Files in the resources directory
OIM_home\xellerate\connectorResources
xml\BMCConnector_DM.xml
OIM_home\xlclient

After you copy the connector files:

  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:

    arapi60.jar
    arutil60.jar
    arapi60.dll
    arjni60.dll
    arrpc60.dll
    arutl60.dll
    
    
  2. Include OIM_home\xellerate\ThirdParty in the PATH environment variable.

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 connectorResources directory and the JAR files to the corresponding directories on each node of the cluster.

Step 4: 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.

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.

To set the required input locale:

Note:

Depending on the operating system used, you may need to perform this procedure differently.
  1. Open Control Panel.

  2. Double-click Regional Options.

  3. On the Input Locales tab of the Regional Options dialog box, add the input locale that you want to use and then switch to the input locale.

Clearing Content Related to Connector Resource Bundles from the Server Cache

Whenever you add a new resource bundle in the OIM_home\xellerate\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.

  2. Enter one of the following commands:

    Note:

    You must perform Step 1 before you perform this step. If you run the command as follows, then an exception is thrown:
    OIM_home\xellerate\bin\batch_file_name
    
    • On Microsoft Windows:

      PurgeCache.bat ConnectorResourceBundle
      
      
    • On UNIX:

      PurgeCache.sh ConnectorResourceBundle
      
      

    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
    
    

Note:

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

Step 5: Importing the Connector XML File

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 locating files is displayed.

  4. Locate and open the BMCConnector_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 table in the "Defining IT Resources" section for information about the values to be specified.

  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 Tools Reference 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. Remove these nodes 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 "Step 6: Configuring Reconciliation" section.

Defining IT Resources

You must specify values for the BMC IT resource parameters listed in the following table.

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 Login Name.

IsDebug Specifies whether or not debugging statements must be displayed

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

TimeStamp For the first reconciliation run, specify the value None for this parameter. From the next reconciliation run time onward, this parameter stores the time at which the last reconciliation run was completed.

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.

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

The value is SHR:DeletePeople.

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

The value is SHR:People.


After you specify values for these IT resource parameters, proceed to Step 9 of the procedure to import connector XML files.

Step 6: Configuring Reconciliation

Configuring reconciliation involves the following steps:

Configuring Trusted Source Reconciliation

Note:

Perform this step of the procedure only if you want to configure trusted source reconciliation. Only one connector can be configured for trusted source reconciliation. If you configure trusted source reconciliation for this connector while you have another trusted source configured, then both connector reconciliations would stop working.

Refer to Oracle Identity Manager Connector Framework Guide for conceptual information about reconciliation configurations.

Use the Oracle Identity Manager Design Console to configure trusted source reconciliation as follows:

  1. In the Resource Objects form, select the fields that you want to reconcile as follows:

    1. Expand the Resource Management folder.

    2. Double-click Resource Objects.

    3. Enter Xellerate User in the Name field and then click the Query icon.

    4. Double-click Xellerate User in the list that is displayed.

    5. On the Object Reconciliation tab, add reconciliation fields as required. You must add all the reconciliation fields that are required to provide input for mandatory fields on the Xellerate User form, for example, fields such as User Login and First Name. However, you need not specify a value in the Password field, although it is a mandatory field.

  2. In the Process Definition form, create reconciliation field mappings as follows:

    1. Expand the Process Management folder.

    2. Double-click Process Definition.

    3. Enter Xellerate User in the Name field and then click the Query icon.

    4. On the Reconciliation Field Mappings tab, add reconciliation field mappings as required. All the mandatory fields of the User Defined process form must be mapped.

  3. In the Reconciliation Rules form, create a rule for the Xellerate User object as follows:

    1. Expand the Development Tools folder.

    2. Double-click Reconciliation Rules.

    3. Create a rule for the Xellerate User object, with a rule element as required.

      See:

      Oracle Identity Manager Design Console Guide for instructions
    4. Select the Active check box to enable the rule.

Creating the Reconciliation Scheduled Tasks

Configuring reconciliation involves creating scheduled tasks for lookup fields and user reconciliations. To create these scheduled tasks:

  1. Open the Oracle Identity Manager Design Console.

  2. Expand the Xellerate Administration folder.

  3. Select Task Scheduler.

  4. Click Find. The details of the predefined scheduled tasks are displayed on two different tabs.

  5. For the first scheduled task, enter a number in the Max Retries field. This number represents the number of times Oracle Identity Manager must attempt to complete the task before assigning the ERROR status to the task.

  6. Ensure that the Disabled and Stop Execution check boxes are not selected.

  7. In the Start region, double-click the Start Time field. From the date-time editor that is displayed, select the date and time at which you want the task to run.

  8. In the Interval region, set the following schedule parameters:

    • To set the task to run on a recurring basis, select the Daily, Weekly, Recurring Intervals, Monthly, or Yearly option.

      If you select the Recurring Intervals option, then you must also specify the time interval at which you want the task to run on a recurring basis.

    • To set the task to run only once, select the Once option.

  9. Provide values for the attributes of the scheduled task. Refer to the "Specifying Values for the Scheduled Task Attributes" section for information about the values to be specified.

    See Also:

    Oracle Identity Manager Design Console Guide for information about adding and removing task attributes
  10. Click Save. The scheduled task is created. The INACTIVE status is displayed in the Status field, because the task is not currently running. The task is run at the date and time that you set in Step 7.

  11. Repeat Steps 5 through 10 to define the second scheduled task.

After you define both scheduled tasks, proceed to the "Step 7: Compiling Adapters" section.

Specifying Values for the Scheduled Task Attributes

This section provides information about the attribute values to be specified for the following scheduled tasks:

Lookup Fields Reconciliation Scheduled Task

You must specify values for the following attributes of the lookup fields reconciliation scheduled task.

Note:

Attribute values are predefined in the connector XML file that you import. Specify values only for those attributes that you want to change.
Attribute Description Value
ServerName Name of the IT resource instance BMC
TargetRO Name of the resource object BMCRO
LookUpCodeKey Name of the lookup code The value can be any one of the following:
  • Region

  • Site

  • Department

  • PagerSoftware

  • PrimaryCenterCode

  • ManagerName

  • State

  • Country

LookUpFieldCode Name of the lookup field The value can be any one of the following:
  • Lookup.BMC.Region

  • Lookup.BMC.Site

  • Lookup.BMC.Department

  • Lookup.BMC.PagerSw

  • Lookup.BMC.PrimaryCenterCode

  • Lookup.BMC.ManagerName

  • Lookup.BMC.State

  • Lookup.BMC.Country


After you specify values for these scheduled task attributes, proceed to Step 10 of the procedure to create scheduled tasks.

User Reconciliation Scheduled Task

You must specify values for the following attributes of the user reconciliation scheduled task.

Note:

Attribute values are predefined in the connector XML file that you import. Specify values only for those attributes that you want to change.
Attribute Description Value
ServerName Name of the IT resource instance BMC
IsTrusted Specifies whether or not reconciliation is to be carried out in trusted mode YES or NO

The default is NO.

TargetRO Name of the resource object BMCRO
XellerateOrganisation Default value for the Oracle Identity Manager Organization name

This value is used to create the Xellerate User in trusted mode.

Xellerate Users

After you specify values for these scheduled task attributes, proceed to Step 10 of the procedure to create scheduled tasks.

Step 7: Compiling Adapters

The following adapters are imported into Oracle Identity Manager when you import the connector XML file:

You must compile these adapters before you can use them to provision accounts on the target system.

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.

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.

Note:

To compile one adapter at a time, use the Adapter Factory form. Refer to Oracle Identity Manager Tools Reference Guide for information about using the Adapter Factory and Adapter Manager forms.

Configuring the Connector for Multiple Installations of the Target System

Note:

Perform this procedure only if you want to configure the connector for multiple installations of BMC Remedy User Management. Refer to Oracle Identity Manager Design Console Guide for detailed instructions on performing each step of this procedure.

To configure the connector for multiple installations of the target system:

  1. Create and configure one resource object for each target system installation.

    The Resource Objects form is in the Resource Management folder. The BMCRO resource object is created when you import the connector XML file. You can use this resource object as the template for creating the remaining resource objects.

  2. Create and configure one IT resource for each resource object.

    The IT Resources form is in the Resource Management folder. The BMC IT resource is created when you import the connector XML file. You can use this IT resource as the template for creating the remaining IT resources, of the same resource type.

  3. Design one process form for each resource object.

    The Form Designer form is in the Development Tools folder. The UD_BMC process form is created when you import the connector XML file. You can use this process form as the template for creating the remaining process forms.

  4. Create and configure one process definition for each resource object.

    The Process Definition form is in the Process Management folder. The BMCPROCESS process definition is created when you import the connector XML file. You can use this process definition as the template for creating the remaining process definitions.

    While creating each process definition, the following steps that you must perform are specific to this procedure:

    • From the Object Name lookup field, select the resource object that you create in Step 1.

    • From the Table Name lookup field, select the process form that you create in Step 3.

    • While mapping the adapter variables for the IT Resource data type, ensure that you select the IT resource that you create in Step 2 from the Qualifier list.

  5. Configure reconciliation for each target system installation. Refer to the "Step 6: Configuring Reconciliation" section for instructions. Note that only the values of the following attributes are to be changed for each reconciliation scheduled task:

    • TargetRO

    • ServerName

    • IsTrusted

    Set the IsTrusted attribute to YES for the BMC Remedy User Management installation that you want to designate as a trusted source. You can designate either a single or multiple installations of BMC Remedy User Management as the trusted source. For the remaining BMC Remedy User Management installations, set this attribute to NO.

  6. If required, modify the fields to be reconciled for the Xellerate User resource object.

When you use the Administrative and User Console to perform provisioning, you can specify the IT resource corresponding to the BMC Remedy User Management installation to which you want to provision the user.