Skip Headers
Oracle® Identity Manager Connector Guide for Siebel User Management
Release 9.0.4
Part Number E10445-06
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 Siebel 7.5 through Siebel CRM 8.1.1
External code For Siebel 7.5 through 7.7:

SiebelJI.jar, SiebelJI_Common.jar, and SiebelJI_enu.jar

For Siebel 7.8 through 8.1.1:

Siebel.jar and SiebelJI_enu.jar
Target system user account Create a target system user account with the rights required to perform reconciliation and provisioning operations. See "Creating the Target System User Account for Connector Operations" for more information.

2.2 Using External Code Files

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 ThirdParty directory to the corresponding directories on each node of the cluster.

If you are using Siebel 7.5 or 7.6 or 7.7, then copy the following files from the Siebel7.x_installation_directory/siebsrvr/CLASSES directory into the OIM_HOME/xellerate/ThirdParty directory:

If you are using Siebel 7.8 or 7.9 or 8.0, then copy the following files from the Siebelx.x_installation_directory/siebsrvr/CLASSES directory into the OIM_HOME/xellerate/ThirdParty directory:

2.3 Creating the Target System User Account for Connector Operations

Oracle Identity Manager uses a target system user account to provision to and reconcile data from the target system. To create this target system user account with the permissions required for performing connector operations:

Note:

The target system user account that you create for connector operations must also be created in the LDAP repository. As a security precaution, you must ensure that this account does not have access to areas protected by Oracle Access Manager.

  1. Create the user account on Siebel as follows:

    1. Log in to Siebel.

    2. Click the Site Map icon.

    3. Click Administration – User.

    4. Click Employees.

    5. Click New.

    6. Enter the following details for the account that you are creating:

      • Last Name

      • First Name

      • Job Title

      • User ID

      • Responsibility: Select Siebel Administrator.

      • Position: Select Siebel Administrator.

      • Organization: Select Default Organization.

      • Employee Type

  2. Create the user account on the Siebel database as follows:

    1. Open the Siebel home directory.

    2. Open the dbsrvr directory.

    3. Open one of the following directories:

      For IBM DB2 UDB: DB2

      For Microsoft SQL Server: MSSQL

      For Oracle Database: Oracle

    4. Open one of the following files in a text editor:

      For IBM DB2 UDB: grantusrdb2.sql

      For Microsoft SQL Server: addusrmsql.sql

      For Oracle Database: grantusroracle.sql

    5. In the file that you open:

      Specify the user ID of the user that you create in Step 1.

      Set a password for the user.

      Provide other required details.

    6. Run the script.

Additional Configuration Steps and Guidelines for the Target System

You must ensure that the following prerequisites are addressed and guidelines are followed:

2.4 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.4.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 Seibel Connector 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 Seibel Connector 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 0.

  7. If all three tasks of the connector installation process are successful, then a message indicating successful installation is displayed. In addition, a list of the steps that you must perform after the installation is displayed. These steps are as follows:

    1. Ensuring that the prerequisites for using the connector are addressed

      Note:

      At this stage, run the PurgeCache utility to load the server cache with content from the connector resource bundle in order to view the list of prerequisites. 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.

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 1-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 "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 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 SIEBEL IT Resource 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 SIEBEL IT Resource 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 Sample/Default Value
    EnterpriseServer Name of the Enterprise server siebel
    GatewayServer Name of the Gateway server STS_TESTING
    GatewayServerPort Listening port number for the SCBroker component 2321
    Language Language You can specify any one of the following:

    For English: ENU

    For Brazilian Portuguese: PTB

    For French: FRA

    For German: DEU

    For Italian: ITA

    For Japanese: JPN

    For Korean: KOR

    For Simplified Chinese: CHS

    For Spanish: ESP

    For Traditional Chinese: CHT
    ObjectManager Name of the object manager You can specify any one of the following:

    For English: eSCCObjMgr_enu

    For Brazilian Portuguese: eSCCObjMgr_ptb

    For French: eSCCObjMgr_fra

    For German: eSCCObjMgr_deu

    For Italian: eSCCObjMgr_ita

    For Japanese: eSCCObjMgr_jpn

    For Korean: eSCCObjMgr_kor

    For Simplified Chinese: eSCCObjMgr_chs

    For Spanish: eSCCObjMgr_esp

    For Traditional Chinese: eSCCObjMgr_cht
    Password Password of the target system user account that you want to use for connector operations

    See "Creating the Target System User Account for Connector Operations" for more information.

    		 sadmin
    SiebelServer Name of the target system server STS_TESTING
    UserName User ID of the target system user account that you want to use for connector operations

    See "Creating the Target System User Account for Connector Operations" for more information.

    		 sadmin
    Encryption Type of encryption for secure communication

    Note: The value of this parameter is case-sensitive.

    		 If encryption is required, then specify RSA. Otherwise, specify None.
    Version Version of the target system supported by this connector 7.5 or 7.8
    TimeStamp For the first reconciliation run, the times-tamp value is not set. For subsequent rounds of reconciliation, the time at which the previous round of reconciliation was completed is stored in this parameter. The following are sample timestamp values:

    For English: Jun 01, 2006 at 10:00:00 GMT+05:30

    For French: juil. 01, 2006 at 10:00:00 GMT+05:30

    For Japanese: 6 01, 2006 at 10:00:00 GMT+05:30
    CustomizedReconQuery Query condition on which reconciliation must be based

    If you specify a query condition for this parameter, then the target system records are searched based on the query condition.

    If you want to reconcile all the target system records, then do not specify a value for this parameter.

    The query can be composed with the AND (&) and OR (|) logical operators.

    For more information about this parameter, refer to the "Partial Reconciliation" section.

    		 First Name=John&Last Name=Doe
    SSO Enter yes to specify that the target system is configured to use a SSO solution for authentication. Otherwise, enter no. no
    Trusted Token Enter the trusted token value that you specify while configuring the target system to communicate with the SSO system. If you have not configured SSO authentication, then enter no. no

  8. To save the values, click Update.

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

Installing the connector on any Oracle Identity Manager release between releases 8.5.3.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.

See Also:

"Files and Directories on the Installation Media" for more information about these files
File in the Installation Media Directory Destination Directory 
lib/xlSiebel.jar

OIM_HOME/xellerate/JavaTasks

lib/SiebelRecon.jar

OIM_HOME/xellerate/ScheduleTask
Files in the resources directory 
OIM_HOME/xellerate/connectorResources
Files in the Troubleshoot directory 
OIM_HOME/xellerate/Siebel/Troubleshoot
Files in the xml directory 
OIM_HOME/xellerate/Siebel/xml

Note:

In a clustered environment, copy the JAR files and the contents of the connectorResources directory to the corresponding directories on each node of the cluster.

2.5.2 Importing the Connector XML Files

As mentioned in the "Files and Directories on the Installation Media" section, the connector XML file contains definitions of the components of the connector. By importing the connector XML file, you create these components in Oracle Identity Manager.

To import the connector XML files into Oracle Identity Manager:

  1. Open the Oracle Identity Manager Administrative and User Console.

  2. Click the Deployment Management link on the left navigation bar.

  3. Click the Import link under Deployment Management. A dialog box for opening files is displayed.

  4. Locate and open the SiebelEmpResourceObject.xml file, which is in the OIM_HOME/xellerate/Siebel/xml directory. Details of this XML file are shown on the File Preview page.

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

  6. Click Next. The Confirmation page is displayed.

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

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

    Parameter Description Sample/Default Value
    EnterpriseServer Name of the Enterprise server siebel
    GatewayServer Name of the Gateway server STS_TESTING
    GatewayServerPort Listening port number for the SCBroker component 2321
    Language Language You can specify any one of the following:

    For English: ENU

    For Brazilian Portuguese: PTB

    For French: FRA

    For German: DEU

    For Italian: ITA

    For Japanese: JPN

    For Korean: KOR

    For Simplified Chinese: CHS

    For Spanish: ESP

    For Traditional Chinese: CHT
    ObjectManager Name of the object manager You can specify any one of the following:

    For English: eSCCObjMgr_enu

    For Brazilian Portuguese: eSCCObjMgr_ptb

    For French: eSCCObjMgr_fra

    For German: eSCCObjMgr_deu

    For Italian: eSCCObjMgr_ita

    For Japanese: eSCCObjMgr_jpn

    For Korean: eSCCObjMgr_kor

    For Simplified Chinese: eSCCObjMgr_chs

    For Spanish: eSCCObjMgr_esp

    For Traditional Chinese: eSCCObjMgr_cht
    Password Password of the target system user account that you want to use for connector operations

    See "Creating the Target System User Account for Connector Operations" for more information.

    		 sadmin
    SiebelServer Name of the target system server STS_TESTING
    UserName User ID of the target system user account that you want to use for connector operations

    See "Creating the Target System User Account for Connector Operations" for more information.

    		 sadmin
    Encryption Type of encryption for secure communication

    Note: The value of this parameter is case-sensitive.

    		 If encryption is required, then specify RSA. Otherwise, specify None.
    Version Version of the target system supported by this connector 7.5 or 7.8
    TimeStamp For the first reconciliation run, the times-tamp value is not set. For subsequent rounds of reconciliation, the time at which the previous round of reconciliation was completed is stored in this parameter. The following are sample timestamp values:

    For English: Jun 01, 2006 at 10:00:00 GMT+05:30

    For French: juil. 01, 2006 at 10:00:00 GMT+05:30

    For Japanese: 6 01, 2006 at 10:00:00 GMT+05:30
    CustomizedReconQuery Query condition on which reconciliation must be based

    If you specify a query condition for this parameter, then the target system records are searched based on the query condition.

    If you want to reconcile all the target system records, then do not specify a value for this parameter.

    The query can be composed with the AND (&) and OR (|) logical operators.

    For more information about this parameter, refer to the "Partial Reconciliation" section.

    		 First Name=John&Last Name=Doe
    SSO Enter yes to specify that the target system is configured to use a SSO solution for authentication. Otherwise, enter no. no
    Trusted Token Enter the trusted token value that you specify while configuring the target system to communicate with the SSO system. If you have not configured SSO authentication, then enter no. no

  9. Click Next. The Provide IT Resource Instance Data page for a new instance of the SIEBEL IT Resource Definition 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.6 Configuring the Oracle Identity Manager Server

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

Note:

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

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

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

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

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

    Note:

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

  2. Enter one of the following commands:

    • On Microsoft Windows:

      PurgeCache.bat ConnectorResourceBundle

    • On UNIX:

      PurgeCache.sh ConnectorResourceBundle

    Note:

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

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

    OIM_HOME/xellerate/config/xlConfig.xml

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

  • Oracle WebLogic Server

    To enable logging:

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

      log4j.logger.XELLERATE=log_level
log4j.logger.XL_INTG.SIEBEL=log_level

    2. In these lines, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.XELLERATE=INFO
log4j.logger.XL_INTG.SIEBEL=INFO

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

  • IBM WebSphere Application Server

    To enable logging:

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

      log4j.logger.XELLERATE=log_level
log4j.logger.XL_INTG.SIEBEL=log_level

    2. In these lines, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.XELLERATE=INFO
log4j.logger.XL_INTG.SIEBEL=INFO

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

    WEBSPHERE_HOME/AppServer/logs/SERVER_NAME/SystemOut.log

  • JBoss Application Server

    To enable logging:

    1. In the JBOSS_HOME/server/default/conf/log4j.xml file, add the following lines if they are not already present in the file:

      <category name="XELLERATE">
   <priority value="log_level"/>
</category>

      <category name="XL_INTG.SIEBEL">
   <priority value="log_level"/>
</category>

    2. In the second XML code line of each set, replace log_level with the log level that you want to set. For example:

      <category name="XELLERATE">
   <priority value="INFO"/>
</category>

      <category name="XL_INTG.SIEBEL">
   <priority value="INFO"/>
</category>

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

    JBOSS_HOME/server/default/log/server.log

  • Oracle Application Server

    To enable logging:

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

      log4j.logger.XELLERATE=log_level
log4j.logger.XL_INTG.SIEBEL=log_level

    2. In these lines, replace log_level with the log level that you want to set.

      For example:

      log4j.logger.XELLERATE=INFO
log4j.logger.XL_INTG.SIEBEL=INFO

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

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

2.6.4 Setting Up Lookup Definitions in Oracle Identity Manager

The following lookup definitions are created in Oracle Identity Manager when you deploy the connector:

  • Lookup.Siebel.EmployeeTypeCode

    During a provisioning operation, you use this lookup definition to set one of the following employee types for the user:

    • Contractor

    • Employee

    • Intern

  • Lookup.Siebel.PreferredCommunications

    During a provisioning operation, you use this lookup definition to set one of the following communication modes for the user:

    • Email

    • Fax

    • Pager

    • Phone

    • Wireless Message

  • Lookup.Siebel.UserType

    During a provisioning operation, you use this lookup definition to set one of the following user types for the user:

    • Employee

    • User

You must enter values in this lookup definition before you can use it during provisioning operations. To enter values in a lookup definition:

  1. Log in to the Design Console.

  2. Expand Administration, and double-click Lookup Definition.

  3. Search for and open the lookup definition.

  4. Enter Code Key and Decode values for each of entry.

    For each lookup definition, the Code Key and Decode values must be items from the lists given earlier in this section. The target system supports only these values.

  5. Click Save.

2.6.5 Adding the Dependent (LDAP Connector) Resource Object for Provisioning

Note:

The connector for the LDAP solution must be installed before you can perform this procedure.

Adding the dependent (LDAP connector) resource object for provisioning as follows:

  1. Log in to the Design Console.

  2. Expand the Resource Management folder, and double-click Resource Objects.

  3. Search for and open the Siebel resource object.

  4. On the Depends On tab, click Assign.

  5. In the dialog box that is displayed, select the resource object for the LDAP connector and use the right arrow icon to move it from the Unassigned Objects list to the list on the right. Then, click OK.

  6. Click the Save icon, and then close the dialog box.

  7. Click the Save icon on the Siebel resource object.

2.7 Configuring the Target System for Encryption

Note:

Perform this procedure only if you want to use RSA encryption on the target system.

You can configure encryption to secure communication between the target system server and Oracle Identity Manager. This section discusses the following topics related to configuring encryption:

2.7.1 Configuring the Target System for RSA Encryption

This section describes how to configure the target system to use RSA encryption for Siebel Internet Session API (SISNAPI) communication between the target system server and Oracle Identity Manager.

To enable RSA encryption for the target system:

  1. Start the Siebel Software Configuration Wizard.

    This wizard is started automatically when you install the target system. If required, you can start it manually by following instructions given in the "Starting the Siebel Software Configuration Wizard" section.

  2. On the Encryption Type page of the wizard, select the RSA option to specify that you want to use the RSA Security Systems 128-bit strong encryption feature for the target system components.

  3. Review the settings, and exit the wizard.

  4. Restart the server.

2.7.2 Configuring the Siebel Web Server Extension for RSA Encryption

After you configure the target system for RSA encryption, perform the same procedure to configure the Siebel Web Server Extension for RSA encryption.

2.7.3 Enabling RSA Encryption for the Siebel Call Center Application

To enable RSA encryption for the Siebel Call Center Application:

  1. Start the Siebel Call Center Application.

  2. Navigate to Sitemap, Server Administration, Components, and Component Parameters.

  3. Query for Call Center Object Manager (ENU) in the Server Component-Parameter List applet.

  4. In the applet, select the Encryption Type parameter and select RSA. If RSA encryption is not required, then select None instead of RSA.

2.7.4 Starting the Siebel Software Configuration Wizard

This section provides information about starting the Siebel Software Configuration Wizard.

The Siebel Software Configuration Wizard opens automatically after the installation of most server components. If required, you can use one of the following methods to manually start the wizard on a Microsoft Windows computer:

  • From the Microsoft Windows desktop:

    1. Click Start.

    2. Select Programs, Siebel Servers 7.0, and Configure Server_Type, where Server_Type is the server you want to configure. For example, Server_Type can be Siebel Gateway.

  • From a command window:

    1. In a command window, navigate to the bin subdirectory component to configure components in the SIEBEL_ROOT directory. For example, D://sea700/siebsrvr/bin.

    2. Depending on the component that you want to configure, enter one of the following commands:

      • To configure the Siebel Database Server, enter the following command:

        ssincfgw -l LANGUAGE -v y

      • To configure any component except the Siebel Database Server, enter the following command:

        ssincfgw -l LANGUAGE

      In these commands, LANGUAGE is the language in which the Siebel Software Configuration Wizard must run. For example, ENU for U.S. English or DEU for German. When you run any one of these commands, a menu of configuration modules for each installed component is displayed.

Go to previous page
Previous		 Go to next page
Next
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