Deploying the connector involves the following steps:
This section is divided into the following topics:
Section 2.1.1, "Files and Directories on the Installation Media"
Section 2.1.2, "Determining the Release Number of the Connector"
Table 2-1 describes the files and directories on the installation media.
Table 2-1 Files and Directories on the Installation Media
| File in the Installation Media Directory | Description |
|---|---|
|
configuration/SeibelConnector-CI.xml |
This XML file contains configuration information that is used during connector installation. |
|
lib/xlSiebel.jar |
This JAR file contains the class files required for provisioning. During connector installation, this file is copied to the following location:
|
|
lib/SiebelRecon.jar |
This JAR file contains the class files required for reconciliation. During connector installation, this file is copied to the following location:
|
|
Files 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:
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. |
|
Troubleshoot/TroubleShootingUtility.class |
This is the testing utility. |
|
Troubleshoot/global.properties |
This file contains the connection details that are required to connect to the target system. It also contains details about the commands to be run. |
|
Troubleshoot/log.properties |
This file is used to specify the log level and the directory in which the log file is to be created when you run the testing utility. |
|
This XML file contains definitions for the following connector components:
|
|
|
xml/SiebelEmpXLResourceObject.xml |
This file contains the configuration for the Xellerate User (OIM User). You import this file only if you plan to use the connector in trusted source reconciliation mode. |
|
xml/SiebelConnectorRequestDatasets.xml |
This file contains the request dataset for the connector. You import this file by using the Deployment Manager. |
Note:
The files in the Troubleshoot directory are used only to run tests on the connector.
Note:
If you are using Oracle Identity Manager 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 might have a deployment of an earlier release of the connector. While deploying the latest release, you might want to know the release number of the earlier release. To determine the release number of the connector that has already been deployed:
In a temporary directory, extract the contents of the following JAR file:
OIM_HOME/xellerate/JavaTasks/xlSiebel.jar
Open the manifest.mf file in a text editor. The manifest.mf file is one of the files bundled inside the xlSiebel.jar file.
In the manifest.mf file, the release number of the connector is displayed as the value of the Version property.
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 directory on each node of the cluster.
If you are using Siebel 7.5, 7.6, or 7.7, then perform one of the following steps:
For Oracle Identity Manager release 9.1.0.x:
Copy the following files from the SIEBEL_INSTALLATION_DIRECTORY/siebsrvr/CLASSES directory into the OIM_HOME/xellerate/ThirdParty directory:
SiebelJI.jar
SiebelJI_Common.jar
SiebelJI_enu.jar
For Oracle Identity Manager release 11.1.1:
Copy the following files from the SIEBEL_INSTALLATION_DIRECTORY/siebsrvr/CLASSES directory into the OIM_HOME/server/ThirdParty directory:
SiebelJI.jar
SiebelJI_Common.jar
SiebelJI_enu.jar
If you are using Siebel 7.8, 7.9, or 8.0, the perform one of the following steps:
For Oracle Identity Manager release 9.1.0.x:
Copy the following files from the SIEBEL_INSTALLATION_DIRECTORY/siebsrvr/CLASSES directory into the OIM_HOME/xellerate/ThirdParty directory:
Siebel.jar
SiebelJI_enu.jar
For Oracle Identity Manager release 11.1.1:
Copy the following files from the SIEBEL_INSTALLATION_DIRECTORY/siebsrvr/CLASSES directory into the OIM_HOME/server/ThirdParty directory:
Siebel.jar
SiebelJI_enu.jar
Depending on the Oracle Identity Manager release that you are using, perform the procedure described in one of the following sections:
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:
To run the Connector Installer:
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
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
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.
From the Connector List list, select Siebel Connector 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:
In the Alternative Directory field, enter the full path and name of that directory.
To repopulate the list of connectors in the Connector List list, click Refresh.
From the Connector List list, select Seibel Connector RELEASE_NUMBER.
Click Load.
To start the installation process, click Continue.
The following tasks are performed in sequence:
Configuration of connector libraries
Import of the connector XML files (by using the Deployment Manager)
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.
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:
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.3.1.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.
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.
Configuring the scheduled tasks that are created when you installed the connector
Note:
In Oracle Identity Manager release 11.1.1, a scheduled job is an instance of a scheduled task. In this guide, the term scheduled task used in the context of Oracle Identity Manager release 9.1.0.x is the same as the term scheduled job in the context of Oracle Identity Manager release 11.1.1.
See Oracle Fusion Middleware System Administrator's Guide for Oracle Identity Manager for more information about scheduled tasks and scheduled jobs.
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 Table 2-1 for information about the files that you must copy and their destination locations on the Oracle Identity Manager host computer.
You must specify values for the parameters of the SIEBEL IT Resource IT resource as follows:
Log in to the Oracle Identity Manager Administrative and User Console.
If you are using Oracle Identity Manager release 9.1.0.x, expand Resource Management, and then click Manage IT Resource.
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.
In the IT Resource Name field on the Manage IT Resource page, enter SIEBEL IT Resource and then click Search.
Click the edit icon for the IT resource.
From the list at the top of the page, select Details and Parameters.
Specify values for the parameters of the IT resource. Table 2-2 describes the parameters that are used to generate a Siebel Internet Session Network API (SISNAPI) connection.
Note:
See Siebel Object Interfaces Reference Guide for more information about the Siebel object interface and extension events.
Table 2-2 IT Resource Parameters and Values
| Parameter | Description | Sample/Default Value |
|---|---|---|
|
EnterpriseServer |
Name of the Siebel Enterprise server. |
|
|
GatewayServer |
|
|
|
GatewayServerPort |
|
|
|
Language |
Language. |
You can specify any one of the following: For English: For Brazilian Portuguese: For French: For German: For Italian: For Japanese: For Korean: For Simplified Chinese: For Spanish: For Traditional Chinese: |
|
ObjectManager |
Name of the Siebel application object manager. |
The following names are examples for the Siebel Call Center application: For English: For Brazilian Portuguese: For French: For German: For Italian: For Japanese: For Korean: For Simplified Chinese: For Spanish: For Traditional Chinese: |
|
Password |
Password of the target system user account that you want to use for connector operations. See Section 2.3.2, "Creating the Target System User Account for Connector Operations" for more information. |
|
|
SiebelServer |
Name of the target Siebel server. |
|
|
UserName |
User ID of the target system user account that you want to use for connector operations. See Section 2.3.2, "Creating the Target System User Account for Connector Operations" for more information. |
|
|
Encryption |
Type of encryption for secure communication. Note: The value of this parameter is case-sensitive. |
If encryption is required, then specify |
|
Version |
Version of the target system supported by this connector. |
|
|
TimeStamp |
For the first reconciliation run, the time-stamp 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 time-stamp values: For English: For French: For Japanese: |
|
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 include the AND (&) and OR (|) logical operators. For more information about this parameter, see Section 3.4.2, "Limited Reconciliation." |
|
|
SSO |
Enter |
|
|
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 |
|
|
Configuration Lookup |
Name of the lookup definition that holds connector configuration entries used during reconciliation and provisioning. |
|
To save the values, click Update.
The following sections discuss postinstallation procedures:
Configuring Oracle Identity Manager involves performing the following procedures:
Note:
In a clustered environment, you must perform this step on each node of the cluster.
Section 2.3.1.2, "Clearing Content Related to Connector Resource Bundles from the Server Cache"
Section 2.3.1.4, "Setting Up Lookup Definitions in Oracle Identity Manager"
Section 2.3.1.5, "Adding the Dependent (LDAP Connector) Resource Object for Provisioning"
Section 2.3.1.6, "Setting Up the Lookup.Configuration.Siebel Lookup Definition"
Section 2.3.1.7, "Configuring Trusted Source Reconciliation"
Section 2.3.1.8, "Configuring Oracle Identity Manager for Request-Based Provisioning"
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.
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.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:
In a command window, perform one of the following steps:
If you are using Oracle Identity Manager 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.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
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.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.
Depending on the Oracle Identity Manager release you are using, perform the procedure described in one of the following sections:
Section 2.3.1.3.1, "Enabling Logging on Oracle Identity Manager Release 9.1.0.x"
Section 2.3.1.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.
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 might 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:
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
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:
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>
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:
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
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
Oracle WebLogic Server
To enable logging:
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
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.
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:
Edit the logging.xml file as follows:
Add the following blocks in the file:
<log_handler name='siebel' 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="XL_INTG.SIEBEL" level="[LOG_LEVEL]" useParentHandlers="false">
<handler name="siebel"/>
<handler name="console-handler"/>
</logger>
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='siebel' 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="XL_INTG.SIEBEL" level="NOTIFICATION:1" useParentHandlers="false"> <handler name="siebel"/> <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.
Save and close the file.
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.
Restart the application server.
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:
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:
Log in to the Design Console.
Expand Administration, and double-click Lookup Definition.
Search for and open the lookup definition.
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.
Click Save.
Note:
The connector for the LDAP solution must be installed before you can perform this procedure.
Add the dependent (LDAP connector) resource object for provisioning as follows:
Log in to the Design Console.
Expand the Resource Management folder, and double-click Resource Objects.
Search for and open the Siebel resource object.
On the Depends On tab, click Assign.
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.
Click the Save icon, and then close the dialog box.
Click the Save icon on the Siebel resource object.
The Lookup.Configuration.Siebel lookup definition is created when you deploy the connector. You must set values for some of the entries in this lookup definition. To set values for these entries:
On the Design Console, expand Administration and then double-click Lookup Definition.
Search for and open the Lookup.Configuration.Siebel lookup definition.
Set values for the entries specified in Table 2-4.
Note:
You must not change any of the Code Key values of this lookup definition.
Table 2-4 Entries in the Lookup.Configuration.Siebel Lookup Definition
| Code Key | Decode Description |
|---|---|
|
BusinessCompOfMultiValueGroups |
This entry holds the names of business components of multivalued group attributes. If you add a multivalued group attribute by performing the procedure described in Chapter 4, "Extending the Functionality of the Connector", then you must append the name of the business component to the default value of the BusinessCompOfMultiValueGroups entry. Use the comma (,) as the delimiter when you append a value. Default value: |
|
Constants Lookup |
This entry holds the name of the constants lookup definition. Default value: |
|
MultiValueAttributesDelimiter |
This entry holds the name of the delimiter that you want to use to separate values in the BusinessCompOfMultiValueGroups, MultiValueAttributesFields, and MultiValueAttrsOnProcessForm entries. Default value: , (the comma character) |
|
MultiValueAttributesFields |
This entry holds the names of multivalued attributes that are reconciled and provisioned. If you add a multivalued attribute by performing the procedure described in Chapter 4, "Extending the Functionality of the Connector", then you must append the name of the attribute to the default value of the MultiValueAttributesFields entry. Use the comma (,) as the delimiter when you append a value. Default value: |
|
MultiValueAttrsOnProcessForm |
This entry holds the list of multivalued attributes on the process form. Default value: |
|
Provisioning Attribute Map |
This entry holds the name of the lookup definition that stores attribute mappings for provisioning. Default value: |
|
Reconciliation Attribute Map |
This entry holds the name of the lookup definition that stores attribute mappings for reconciliation. Default value: |
|
TargetDateFormat |
Enter the date format supported by the target system. This date format is used by the connector during reconciliation to parse date values fetched from the target system. Default value: |
While configuring the connector, the target system can be designated as a trusted source or target resource. If you designate the target system as a trusted source, then during a reconciliation run:
For each newly created user on the target system, an OIM User is created.
Updates made to each user on the target system are propagated to the corresponding OIM User.
If you designate the target system as a target resource, then during a reconciliation run:
For each account created on the target system, a resource is assigned to the corresponding OIM User.
Updates made to each account on the target system are propagated to the corresponding resource.
Note:
Skip this section if you do not want to designate the target system as a trusted source for reconciliation.
Configuring trusted source reconciliation involves the following steps:
Import the XML file for trusted source reconciliation, SiebelEmpXLResourceObject.xml, by using the Deployment Manager. This section describes the procedure to import the XML file.
Set the IsTrusted scheduled task attribute to True. You specify a value for this attribute while configuring the user reconciliation scheduled task, which is described later in this guide.
To import the XML file for trusted source reconciliation:
Log in to the Oracle Identity Manager Administrative and User Console.
If you are using Oracle Identity Manager release 9.1.0.x, then:
Click the Deployment Management link on the left navigation pane.
Click the Import link under Deployment Management. A dialog box for opening files is displayed.
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 System Management region, click Import Deployment Manager File. A dialog box for opening files is displayed.
Locate and open the SiebelEmpXLResourceObject.xml file, which is located in the directory.
For Oracle Identity Manager release 9.1.0.x:
OIM_HOME/xellerate/ConnectorDefaultDirectory/Siebel_9.0.4.15.0/xml
For Oracle Identity Manager release 11.1.1:
OIM_HOME/server/ConnectorDefaultDirectory/Siebel_9.0.4.15.0/xml
Details of this XML file are shown on the File Preview page.
Click Add File. The Substitutions page is displayed.
Click Next. The Confirmation page is displayed.
Click Import.
In the message that is displayed, click Import to confirm that you want to import the XML file and then click OK.
After you import the XML file for trusted source reconciliation, you must set the value of the IsTrusted reconciliation scheduled task attribute to True. This procedure is described in Section 3.4.4, "User Reconciliation Scheduled Task."
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 creates a request for a resource by using the Administrative and User Console. Administrators or other users can also create requests for a particular user. Requests for a particular resource on the resource 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 (account) on the target system.
Note:
Direct provisioning allows the provisioning of multiple target system accounts on the target system.
Direct provisioning cannot be used if you enable request-based provisioning.
To configure request-based provisioning, perform the following procedures:
Note:
You can perform this procedure instead of the procedures described in Section 2.3.1.8.2, "Copying Predefined Request Datasets" and Section 2.3.1.8.3, "Importing Request Datasets into MDS".
See Oracle Fusion Middleware Administrator's Guide for Oracle Identity Manager for detailed information about importing objects from an XML file using the Deployment Manager.
A request dataset is an XML file that specifies the information to be submitted by the requester during a provisioning operation. These request datasets specify information about the default set of attributes for which the requester must submit information during a request-based provisioning operation.
To import a request dataset XML file by using the Deployment Manager:
Log in to the Oracle Identity Manager Administrative and User Console.
Click the Deployment Management link on the left navigation bar.
Click the Import link under Deployment Management.
A dialog box for opening files is displayed.
Locate and open the request dataset XML file, SiebelConnectorRequestDatasets.xml, which is in the xml directory of the installation media.
Details of this XML file are shown on the File Preview page.
Click Add File.
The Substitutions page is displayed.
Click Next.
The Confirmation page is displayed.
Click Import.
Close the Deployment Manager dialog box.
The request dataset is imported into Oracle Identity Manager.
Predefined request datasets are shipped with this connector. The following are the predefined request dataset available in the DataSets directory on the installation media:
ProvisionResourceSiebel Resource Object.xml
ModifyResourceSiebel Resource Object.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\SiebelStd
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.
You can configure request-based provisioning by importing the request datasets into into the metadata store (MDS) by using the Oracle Identity Manager MDS Import utility.
To import a request dataset definition into MDS:
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.3.1.8.2, "Copying Predefined Request Datasets," if you copy the files to the E:\MyDatasets\custom\connector\SiebelStd directory, then set the value of the metada_from_loc property to E:\MyDatasets.
In a command window, change to the OIM_HOME\server\bin directory.
Run one of the following commands:
On Microsoft Windows
weblogicImportMetadata.bat
On UNIX
weblogicImportMetadata.sh
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.
To enable the Auto Save Form feature:
Log in to the Design Console.
Expand Process Management, and then double-click Process Definition.
Search for and open the Siebel Process process definition.
Select the Auto Save Form check box.
Click the Save icon.
Run the PurgeCache utility to clear content belonging to the Metadata category from the server cache. See Section 2.3.1.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.
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.
Create the user account on Siebel as follows:
Log in to Siebel.
Click the Site Map icon.
Click Administration – User.
Click Employees.
Click New.
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
Create the user account on the Siebel database as follows:
Open the Siebel home directory.
Open the dbsrvr directory.
Open one of the following directories:
For IBM DB2 UDB: DB2
For Microsoft SQL Server: MSSQL
For Oracle Database: Oracle
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
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.
Run the script.
Additional Configuration Steps and Guidelines for the Target System
Siebel can be configured to use either a database or an LDAP repository to store user information. If an LDAP repository is used, then you must ensure that the following prerequisites are addressed:
If Microsoft Active Directory is used as the LDAP repository, then use the ADSI Security Adapter. Ensure that the Propagate Change attribute of the ADSI Security Adapter is set to False on Siebel.
If any other LDAP repository is used, then use the LDAP Security Adapter.
Note:
Only LDAP solutions for which there are predefined Oracle Identity Manager connectors are supported.
Users must first be created in the LDAP repository and then created on the target system. This also means that users created through provisioning operations performed on Oracle Identity Manager must first be created in the LDAP repository and then created on the target system.
Ensure that the credential attribute is correctly set for users created in the LDAP repository. For example, on Microsoft Active Directory the credential attribute is the Office attribute. The format for Office attribute values is as follows:
username=USER_ID_OF_SIEBEL_ACCOUNT password=PASSWORD_OF_SIEBEL_ACCOUNT
The following is a sample value:
username=jdoe password=Ke42r0s
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:
Section 2.3.3.2, "Configuring the Siebel Web Server Extension for RSA Encryption"
Section 2.3.3.3, "Enabling RSA Encryption for the Siebel Call Center Application"
Section 2.3.3.4, "Starting the Siebel Software Configuration Wizard"
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 on Siebel:
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 Section 2.3.3.4, "Starting the Siebel Software Configuration Wizard."
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.
Review the settings, and exit the wizard.
Restart the server.
After you configure the target system for RSA encryption, perform the same procedure to configure the Siebel Web Server Extension for RSA encryption.
To enable RSA encryption for the Siebel Call Center Application:
Start the Siebel Call Center Application.
Navigate to Sitemap, Server Administration, Components, and Component Parameters.
Query for Call Center Object Manager (ENU) in the Server Component-Parameter List applet.
In the applet, select the Encryption Type parameter and select RSA. If RSA encryption is not required, then select None instead of RSA.
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:
Click Start.
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:
In a command window, navigate to the bin subdirectory component to configure components in the SIEBEL_ROOT directory. For example, D://sea700/siebsrvr/bin.
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, replace LANGUAGE with the language in which the Siebel Software Configuration Wizard must run. For example, replace LANGUAGE with 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.