This chapter describes how to work with Oracle Siebel CRM Knowledge Modules in Oracle Data Integrator.
This chapter includes the following sections:
Oracle Data Integrator is able to integrate Oracle Siebel CRM applications. It supports reverse-engineering of Siebel metadata as well as data extraction on Siebel Business Components tables and integration through EIM tables.
The Oracle Data Integrator Siebel Knowledge Modules (KMs) use mature integration methods for Siebel, in order to:
Reverse-Engineer Siebel data structures (Business Components and Business Objects)
Reverse-Engineer EIM (Enterprise Integration Manager) tables
Read data from Siebel using data-level integration
Read and write Siebel data using the EIM tables
These features are supported for Oracle and Microsoft SQL Server (MSSQL) databases used as backend databases for Siebel. In this chapter, <database> refers to any of these technologies.
Oracle Data Integrator provides two ways to extract data from Siebel:
Data extraction is performed directly on the Siebel Business Components tables. You can use a Siebel data model as a source of an integration interface by extracting data from the Siebel Database and integrate them into another system. Using Siebel as a source in these conditions is the same as using a regular table as a source in an integration interface. This integration method is read-only.
Reverse-engineering: To reverse-engineer Siebel Business Components, use the RKM Siebel <database> (<database> is the name of the database hosting the Siebel tables). This RKM allows for reverse-engineering of the Siebel data structures, enriching them with information retrieved from the Siebel dictionary.
Extracting: You have access to a range of knowledge modules to extract Siebel data from Siebel. The Generic SQL, Oracle Database or Microsoft SQL Server KMs can be used for this purpose.
Integration through EIM tables
The EIM tables are used to extract data from Siebel and load data to Siebel. EIM tables act as a staging area between the Siebel application and the other applications (another Siebel can be one of these applications). This method supports read and write.
Reverse-engineering: To reverse-engineer Siebel EIM tables, use the RKM Siebel EIM <database>. This RKM allows for reverse-engineering of the Siebel EIM tables, enriching them with information retrieved from the Siebel dictionary.
Extracting: Data extraction is performed on the EIM tables after executing automatically an export script to load these EIM tables from the Siebel application tables. To extract data from a Siebel EIM table and load it to any SQL staging area, use the LKM Siebel to SQL (EIM).
This LKM first generates the appropriate EIM Configuration file (.ifb – Interface Builder File) and runs the export process using the Server Manager. Then, it extracts selected data from the EIM Siebel table into the staging area.
Integrating: Data integration is performed to the EIM tables and then an import script is generated and executed to import data from the EIM tables into the Siebel application tables. To perform such integration, from the staging area, use the IKM SQL to Siebel Append (EIM).
This IKM first loads data from the staging area to the EIM table. Then, it generates the EIM configuration file (.ifb) and runs the import process using the server Manager.
Note:
Only EIM tables should be used to write into Siebel. Writing directly into the Siebel physical tables is not recommended.
Oracle Data Integrator provides the Knowledge Modules listed in Table 6-1 for handling Siebel CRM data. Theses specific Knowledge Modules for Oracle Siebel CRM provide integration and connectivity between Oracle Data Integrator and the Oracle Siebel CRM platform.
Table 6-1 Siebel CRM Knowledge Modules
| Knowledge Module | Description |
|---|---|
|
IKM SQL to Siebel Append (EIM) |
Integrates data into a Siebel EIM (Enterprise Integration Manager) table from any ANSI-SQL92 compliant staging area, then generates the appropriate EIM configuration files ( |
|
LKM Siebel to SQL (EIM) |
Loads data from a Siebel EIM (Enterprise Integration Manager) table to any ANSI-SQL92 compliant staging area.This module uses the run-time Agent to extract data from EIM (Enterprise Integration Manager) table to the staging area.It is able to generate the appropriate EIM configuration files ( |
|
RKM Siebel Oracle |
Reverse-engineering knowledge module for Siebel. Business Objects are reversed as sub-models, Business Components are reversed as datastores with their columns and their constraints (Primary and Foreign Keys). |
|
RKM Siebel EIM Oracle |
Reverse-engineering knowledge module for Siebel EIM (Enterprise Integration Manager) tables. Siebel projects are reversed as sub-models, EIM tables are reversed as datastores with their columns and Primary Keys. |
|
RKM Siebel MSSQL |
This RKM provides the same features as the RKM Siebel Oracle for Siebel installed on top of a Microsoft SQL Server database. |
|
RKM Siebel EIM MSSQL |
This RKM provides the same features as the RKM Siebel EIM Oracle for Siebel installed on top of a Microsoft SQL Server database. |
Make sure you have read the information in this section before you start working with the Siebel CRM data:
Before performing any installation you should read the system requirements and certification documentation to ensure that your environment meets the minimum installation requirements for the products you are installing.
The list of supported platforms and versions is available on Oracle Technical Network (OTN):
http://www.oracle.com/technology/products/oracle-data-integrator/index.html.
In order to use the Siebel EIM KMS, it is required that the Srvrmgr Siebel utility is installed on the machine hosting the run-time agent.
Oracle Data Integrator connects the database hosting the Siebel CRM data using JDBC connectivity. For detailed information on JDBC connectivity with Oracle and Microsoft SQL Server databases, see the "Oracle Database Connectivity Requirements" and "Microsoft SQL Server Connectivity Requirements" in the Oracle Fusion Middleware Connectivity and Knowledge Modules Guide for Oracle Data Integrator.
This step consists in declaring in Oracle Data Integrator the data server, as well as the physical and logical schemas that will be used to store the Siebel CRM data.
The Siebel CRM tables can be stored in an Oracle schema or a Microsoft SQL Server database.
Create a data server either for the Oracle technology or for the Microsoft SQL Server technology. See "Creating an Oracle Data Server" or "Creating a Microsoft SQL Server Data Server" in the Oracle Fusion Middleware Connectivity and Knowledge Modules Guide for Oracle Data Integrator.
This data server represents the database instance that stores the Siebel CRM data.
Create a physical schema under the data server that you have created in Section 6.3.1, "Create a Data Server". Use the standard procedure, as described in "Creating a Physical Schema" of the Oracle Fusion Middleware Developer's Guide for Oracle Data Integrator.
This schema must point to the Oracle schema or Microsoft SQL Server database that contains the Siebel tables or EIM data structures you want to reverse-engineer.
Note:
The Oracle schema or the Microsoft SQL Server database storing the Siebel CRM tables should not be defined as a work schema in the physical schema definition. Moreover, this schema or database must not be used as staging area for an interface.
Create for this physical schema a logical schema using the standard procedure, as described in "Creating a Logical Schema" of the Oracle Fusion Middleware Developer's Guide for Oracle Data Integrator and associate it in a given context.
Setting up a project using Siebel CRM features follows the standard procedure. See "Creating an Integration Project" of the Oracle Fusion Middleware Developer's Guide for Oracle Data Integrator.
Import the following KMs into your Oracle Data Integrator project:
RKM Siebel <database> or RKM Siebel EIM <database>
LKM Siebel to SQL (EIM)
IKM SQL to Siebel Append (EIM)
In addition to these specific Siebel CRM KMs, import the standard LKMs for the Oracle or Microsoft SQL Server technologies. See Oracle Database "Knowledge Modules" and Microsoft SQL Server "Knowledge Modules" in the Oracle Fusion Middleware Connectivity and Knowledge Modules Guide for Oracle Data Integratorfor a list of available KMs.
This section contains the following topics:
Create a Model based on the Oracle or Microsoft SQL Server technology and on the logical schema created when setting up the topology using the standard procedure, as described in "Creating a Model" of the Oracle Fusion Middleware Developer's Guide for Oracle Data Integrator.
The Siebel RKMs are able to reverse-engineer Siebel Business Components or Siebel EIM tables, enriching them with information retrieved from the Siebel dictionary.
The reverse-engineering process using the RKM Siebel <database> returns:
The installed Business Objects as sub-models
The Business Components as datastores with their columns and their constraints (Primary and Foreign Keys)
Comments on the reversed tables and columns
The reverse-engineering process using the RKM Siebel <database> EIM returns:
Projects as sub-models
EIM tables as datastores with their columns and their constraints (Primary and Foreign Keys).
To perform a Customized Reverse-Engineering of Siebel CRM tables with the Siebel CRM RKMs, use the usual procedure, as described in "Reverse-engineering a Model" of the Oracle Fusion Middleware Developer's Guide for Oracle Data Integrator. This section details only the fields specific to Siebel CRM tables:
In the Reverse tab of the Model, select depending on the integration method you want use, the RKM Siebel <database> or RKM Siebel EIM <database>.
The RKM options vary depending on the RKM selected in step 1. When using the:
RKM Siebel to Oracle or the RKM Siebel MSSQL,
specify the mask to filter the Business Objects to reverse-engineer in the Business Object option.
For example: Account, Acc%, Customer, Employee, %mpl%.
The percent sign (%) returns all Business Objects.
RKM Siebel EIM Oracle or the RKM Siebel EIM MSSQL, set the options as shown in Table 6-2.
Table 6-2 KM options for Siebel EIM Knowledge Modules
| Option | Description |
|---|---|
|
USE_PROJECT |
Set this option to YES to reverse-engineer projects as sub-models in Oracle Data Integrator. |
|
REPOSITORY |
Specify the Siebel Repository name. Default is Siebel Repository. |
|
PROJECT_NAME |
Specify the mask to filter the Siebel projects to reverse-engineer. For example: EIM Accounts and Quotes, EIM Activity, EIM A%. The percent sign (%) returns all Siebel projects |
Specify the reverse-engineering mask in the Mask field in order to select the tables to reverse. The Mask field, in the Reverse tab, filters reverse-engineered objects based on their name. The Mask field must not be empty and must contain at least the percentage symbol (%).
The reverse-engineering process returns the applications and tables as sub-models and datastores. You can use these Siebel CRM datastores as a source in an integration interface.
You can use Siebel Business Components tables as sources in interfaces. EIM tables can be used as sources or targets.
The KM choice for an interface determines the abilities and performance of this interface. The recommendations in this section help in the selection of the KM for different situations concerning loading and integrating Siebel CRM data.
After performing a reverse-engineering using the RKM Siebel <database>, you can use Siebel data tables as sources in integration interface.
Using Siebel CRM as a source in these conditions is identical to using an Oracle or Microsoft SQL Server datastore as a source in an integration interface. The generic SQL, Oracle Database, or Microsoft SQL Server KMs can be used for this purpose. See the following chapters in the Oracle Fusion Middleware Connectivity and Knowledge Modules Guide for Oracle Data Integratorfor more information:
To extract data from Siebel through the EIM tables, create an integration interface with EIM tables as a source. Select the LKM Siebel to SQL (EIM) and set the KM options as follows:
IFB_PATH: Specify the path where you want to create the EIM configuration file (.ifb).
SRVRMGR_PATH: Specify the location of the Siebel srvrmgr binary. This parameter is mandatory.
SIEBEL_GATEWAY: Specify the network address of the Gateway Server machine.
SIEBEL_ENTERPRISE: Indicate the name of the Enterprise Server.
SIEBEL_SERVER: Indicate the name of the Siebel Server.
SERVER_USER: Indicate the user name of the Server administrator.
SERVER_USER_PWD: Indicate the Server administrator password.
The LKM Siebel to SQL (EIM) automatically performs the following operations:
Generate an EIM Configuration File, describing the export process to the EIM tables.
Run the EIM process using for example the Siebel srvrmgr command line.
Extract, transform and load data from the EIM tables to the other application.
To insert data into Siebel through the EIM tables, create an integration interface with EIM tables as target. Select the IKM SQL to Siebel Append (EIM) and set the KM options as follows:
IFB_PATH: Specify the path where you want to create the EIM configuration file (.ifb).
SRVRMGR_PATH: Specify the location of the Siebel srvrmgr binary. This parameter is mandatory.
SIEBEL_GATEWAY: Specify the network address of the Gateway Server machine.
SIEBEL_ENTERPRISE: Indicate the name of the Enterprise Server.
SIEBEL_SERVER: Indicate the name of the Siebel Server.
SERVER_USER: Indicate the user name of the Server administrator.
SERVER_USER_PWD: Indicate the Server administrator password.
The IKM SQL to Siebel Append (EIM) automatically performs the following operations:
Load the appropriate EIM tables.
Generate an EIM Configuration File, describing the import process from the EIM tables.
Run the EIM process using for instance the Siebel srvrmgr command line.