This chapter discusses how to configure and deploy Siebel CRM Integration to Oracle Incentive Compensation (Siebel CRM to OIC).
This chapter includes the following sections:
To run AIA Pre-Built Integrations Installer you must have Oracle Data Integrator (ODI) access with Supervisor privileges.
For installation purposes, the ODI software must reside at the same server where Foundation Pack is installed. Once the PIP installation is complete, the ODI software can be installed onto another server (if desired) connecting to the master and work repositories used during the PIP installation.
You can use an existing master repository if it exists on an Oracle database and its ID is not 0. If the ID is 0, AIA advises you to create another master repository.
You can use an existing work repository if it exists on an Oracle database and its ID is not 1 or 778. If the ID is 1 or 778, AIA advises you to create another repository and not to use 1 or 778 as the Work Repository ID.
When you run the DCW, it inserts or updates the ODI artifacts into these repositories.
AIA recommends that you make a backup copy of master and work repositories before you start the installation process.
For information about creating Oracle Data Integrator master and work repositories, see Oracle Fusion Middleware Developer's Guide for Oracle Data Integrator, "Administering the Oracle Data Integrator Repositories."
Perform the following steps to apply the required patches to your ODI 11.1.1.5.0.
To install prerequisite installer patch #10288265:
Access My Oracle Support: https://support.oracle.com
Navigate to the Patches & Updates tab
In the Patch Name or Number field, write 10288265
Select your platform
Click Search
Download and install patch #10288265
Access My Oracle Support: https://support.oracle.com
Navigate to the Patches & Updates tab
In the Patch Name or Number field, write 12837214
Select your platform
Click Search
Download and install patch #12837214
After applying the patches, launch the ODI Installer:
Go to Topology.
Go to Physical Architecture.
Find the XML technologies and expand it.
You should see data sources for all DVM's used in your ODI flows.
Select each DVM data source.
Go to the JDBC tab.
Append this to the end of the URL "&back_compat_specific_keywords=true"
Test the data source to make sure the connection is successful.
Save your changes.
For a screenshot of this screen in ODI Installer, see Appendix B, "Oracle Data Integrator Screen".
The DCW screens prompt you to enter the data required for successful configuration of Siebel CRM to OIC integration. Enter the details of the Siebel CRM to OIC screens below, take a printout and keep it ready when you run the DCW. This action enables faster and error free configuration.
All artifacts associated with the PIP infrastructure components deploy to the PIP server. This screen contains the following fields:
Table 27-1 PIP Server Details Screen Fields
| Field | Description |
|---|---|
|
Admin Host Name |
Specifies where the admin server resides. This can be a remote server or the same system where the AIA Pre-Built Integrations Installer is launched. Example: The Admin Host Name is _________________________________ |
|
Admin Port |
This is the port number on which the Weblogic Admin server is started. To find this value contact the WebLogic administrator. Example: The Admin Port is _____________________________________ |
|
Domain Name |
This is WebLogic server domain corresponding to the Admin Server. Example: The Domain Name is _______________________________ |
|
Admin User |
This value is the WebLogic admin user name. To find this value contact your WebLogic administrator. The Admin User is __________________________________ |
|
Admin Password |
This value is the WebLogic admin password. To find this value contact your WebLogic administrator. The password is _____________________________________ |
|
Managed Server |
After you enter the Admin Host Name, Admin Port and Admin User, this field populates with managed servers for the domain. Select the managed server from the list. If you are deploying the PIP to a SOA cluster, you should select the cluster name in this field. The Managed Server is _______________________________ |
|
Managed Port |
This field is automatically updated after you select the managed server. If you have configured a SOA Cluster, the SOA Cluster port appears in the list. |
Use this screen to enter details related to your Oracle E-Business Suite server instance.
The screen contains the following fields:
Table 27-2 Oracle E-Business Suite Server Details Screen Fields
| Field | Description |
|---|---|
|
E-Business Suite Version |
This is the version of the E-Business Suite Application. The valid value for Siebel CRM to OIC is |
|
E-Business Suite Host Name |
Specifies the fully qualified system name of the Oracle E-Business Suite application. Example: E-Business Suite Host Name is ___________________________ |
|
E-Business Suite Port |
This value is the Oracle E-Business Suite application port. To find this value, contact your administrator. Example: E-Business Suite Port is ______________________________ |
|
E-Business Suite User Name |
To find this value, contact your administrator. E-Business Suite User Name is __________________________ |
|
E-Business Suite Password |
To find this value, contact your administrator. E-Business Suite Password is ___________________________ |
|
Workflow Business Event System Name |
This is the Workflow Business Event System Name of E-Business Suite Server. For example: This field is optional. Workflow Business Event System Name is _________________ |
Use this screen to enter details related to your Oracle E-Business Suite database instance.
The screen contains the following fields:
Table 27-3 Oracle E-Business Suite Database Details Screen Fields
| Field | Description |
|---|---|
|
E-Business Suite Database Host |
Specifies the system name. To find this value, contact the database administrator. Example: E-Business Suite Database Host is ________________________ |
|
E-Business Suite Database Port |
To find this value, contact the database administrator. Example: E-Business Suite Database Port is _______________________ |
|
E-Business Suite Database Username |
To find this value, contact the database administrator. Example: E-Business Suite Database Username is ___________________ |
|
E-Business Suite Database Password |
To find this value, contact the database administrator. E-Business Suite Database Password is ____________________ |
|
E-Business Suite Database SID (System ID) |
To find this value, contact the database administrator. Example: E-Business Suite Database SID is _________________________ |
|
Database Schema |
To find this value, contact the database administrator. Example: Database Schema is __________________________________ Note: All the database credentials are used for creating the connection pool URL (universal resource locator) and data source URLs. |
Use this screen to enter details related to your Siebel CRM server instance.
The screen contains the following fields:
Table 27-4 Siebel CRM Server Details Screen Fields
| Field | Description |
|---|---|
|
Siebel Host name |
Specifies the fully qualified system name of the Siebel CRM application. Example: Siebel Host name is ____________________________ |
|
Siebel HTTP Port |
This is the value of the Siebel CRM application port. To find this value, contact your administrator. Example: Note: Enter Siebel HTTP Port is _____________________________. |
|
Siebel EAI Application User |
This value is the Siebel application user used to make EAI web service calls. To find this value, contact your administrator. Siebel EAI Application User is __________________________ |
|
Siebel EAI Application Password |
To find this value, contact the database administrator. Siebel EAI Application Password is ________________________ |
|
Siebel Enterprise Server Name |
To find this value, contact the database administrator. Siebel Enterprise Server Name is _________________________ |
|
Siebel Version |
This is the version of the Siebel CRM application. Valid values for Siebel CRM to OIC are 7.8.2.x SIA, 8.0.0.x SIA, and 8.1.1.x SIA. Other versions are not supported for the AIA 11.5 release. Note: See My Oracle Support for the latest updates to supported versions. |
Use this screen to enter details related to your Siebel CRM database instance.
The screen contains the following fields:
Table 27-5 Siebel CRM Database Details Screen Fields
| Field | Description |
|---|---|
|
Siebel Database Host |
Specifies the system name. To find this value, contact the database administrator. Example: Siebel Database Host is _________________________________ |
|
Siebel Database Port |
To find this value, contact the database administrator. Example: Siebel Database Port is _________________________________ |
|
Siebel Database Username |
To find this value, contact the database administrator. Example: Siebel Database Username is ____________________________ |
|
Siebel Database Password |
To find this value, contact your administrator. Siebel Database Password is _____________________________ |
|
Siebel Database SID |
To find this value, contact the database administrator. Example: Siebel Database SID is _________________________________ |
Oracle Data Integration Access Information is captured in three screens. Use these screens to enter details to access ODI. The screens contain the following fields:
Table 27-6 Oracle Data Integrator Access Details Screen Fields
| Field | Description |
|---|---|
|
Path to Oracle Data Integrator |
This value is the fully qualified path to the ODI HOME, including the agent folder in the oracledi directory. The default is the environment variable ODI_HOME. Linux example: Path to ODI is ____________________________ Note: The existence of the ODI software is validated by checking whether odiparams.sh (or .bat) exists in the ODI_HOME/agent/bin directory. |
|
ODI User |
Enter the user name to access ODI. Example: ODI user is ______________________________ |
|
ODI Password |
Enter the password to access ODI. Example: ODI password is ___________________________ |
|
Path for exported DVMs |
Enter the path to the directory to export domain value mappings (DVMs). Example: One of the steps for setting up the PIP is to export some DVMs to a location. The Installer must have this location to configure ODI artifacts during the install. It is recommended to choose this location in the same server where the ODI software runs. Path for Exported DVMs is _______________________ |
Use this screen to enter details to access the Oracle Data Integrator master repository. The screen contains the following fields:
Table 27-7 Oracle Data Integrator Master Repository Details Screen Fields
| Field | Description |
|---|---|
|
Database Host Name |
To find this value, contact your database administrator. Example: ODI Master Repository Database Host Name is _________________ |
|
Database Port Number |
To find this value, contact your database administrator. Example: ODI Master Repository Database Port Number is_________________ |
|
Database Username |
To find this value, contact your database administrator. Example: ODI Master Repository Database Username is _________________ |
|
Database Password |
To find this value, contact your database administrator. Example: ODI Master Repository Database Password is _________________ |
|
Database SID |
To find this value, contact your database administrator. Example: ODI Master Repository Database SID is _________________ |
The install process imports the Siebel CRM to OIC ODI artifacts into an ODI work repository. You can provide an existing ODI work repository or provide an empty one. It is recommended to use an empty repository.
Use this screen to enter details related to the ODI work repository. The screen contains the following fields:
Table 27-8 Oracle Data Integrator Work Repository Details for Siebel CRM to OIC Screen Fields
| Field | Description |
|---|---|
|
ODI Work Repository Name |
Enter the name you gave to the ODI work repository for Siebel CRM to OIC Artifacts. Example: ODI Work Repository Name is: _________________________ |
|
ODI Work Repository ID |
Enter the ID number that you used for the ODI work repository. It should be between 1 and 899. Example: Do not use 900. Also do not use the ID used for other work repositories. ODI Work Repository ID is: ______________ |
This section discusses the integration configuration and deployment process. There are two steps:
Configure your integration using the deployment DCW.
Deploy the integration to the Fusion Middleware server.
The section discusses configuration process. The screens that appear prompt you to enter the data that is required for successful configuration of Siebel CRM to OIC integration. Keep the completed worksheets Siebel CRM to OIC screens ready before you launch the DCW.
To configure Siebel CRM to OIC:
Navigate to <AIA_Instance>/bin and run the command source aiaenv.sh for Linux based systems and aiaenv.bat for Microsoft Windows to configure the environment.
Navigate to <AIA_HOME>/bin and run the command ./aiaconfig.sh for Linux based systems and aiaconfig.bat for Microsoft Windows.
This launches the AIA DCW.
Click Next.
Select the Siebel CRM to OIC
Click Next.
To specify PIP Server details:
Enter information related to your PIP server in the PIP Server Details screen.
Click Next.
To specify Oracle E-Business Suite server details:
Enter your Oracle E-Business Suite server connection information in the E-Business Suite Server Details screen.
Click Next.
To specify Oracle E-Business Suite database details:
Enter your Oracle E-Business Suite database connection information in the E-Business Suite Database Details screen.
Click Next.
To specify Siebel CRM application details:
Enter your Siebel CRM application information in the Application Details - Siebel CRM screen.
Click Next.
To specify Siebel CRM database details:
Enter your Siebel CRM database connection information in the Siebel CRM Database Details screen.
Click Next.
To specify Oracle Data Integrator access details:
Enter information about your Oracle Data Integrator access installation in the Oracle Data Integrator Access Information screens.
Oracle Data Integration access information is captured in three screens. Enter the following information in the screens.
Specify the ODI Home.
Click Next.
Enter ODI User and ODI Password.
Click Next.
Specify the Path for exported DVMs.
Click Next.
To specify Oracle Data Integrator master repository details:
Enter information about your Oracle Data Integrator master repository installation in the Oracle Data Integrator Master Repository screen.
Click Next.
To specify Oracle Data Integrator work repository details for Siebel CRM to OIC:
Enter information about your Oracle Data Integrator work repository installation in the Oracle Data Integrator Work Repository for Siebel CRM to OIC screen.
Click Next.
Review the configuration information on the Configuration Summary screen.
Note:
If you want to make changes to the configuration, use the navigation pane on the left and select the screen you want to edit.You can create a response file based on the input provided in the DCW and use it in future when you want to deploy the PIP. You can configure using the steps described in Configuring using the Response File. Click Save Response File and save the response file with the name and location of your choice.
Click Configure to accept the configuration.
The system displays progress of the configuration in the Configuration Progress screen.
The system displays any warnings or errors as necessary. You can review the configuration log for additional details. The configuration log location is displayed in Configuration Progress screen.
When the configuration process completes without errors, the AIA DCW displays the Configuration Complete screen.
Click Finish to close the DCW.
To configure using the response file:
Open the response file.
When you create a response file through OUI, passwords get stored as <SECURE>.
Replace the password fields with actual passwords in the response file.
Navigate to <AIA_Instance>/bin and run the command source aiaenv.sh for Linux based systems and aiaenv.bat for Microsoft Windows to configure the environment.
Navigate to <AIA_HOME>/bin and run the command ./aiaconfig.sh <Response File Location and Name> for Linux based systems and aiaconfig.bat <Response File Location and Name> for Microsoft Windows.
To deploy the PIP to Fusion Middleware server:
Navigate to <AIA_Instance>/bin and run the command source aiaenv.sh for Linux based systems and aiaenv.bat for Microsoft Windows to configure the environment.
Run the command for your platform.
Note:
When you copy and paste the command in the command line, ensure that there is space between .xml and -. Ensure that there is space between these two when you run undeployment command too.Table 27-9 Deployment Commands for the Siebel CRM to OIC Integration
| Platform | Deployment Command |
|---|---|
|
Linux Solaris SPARC IBM AIX Based Systems HP-UX |
ant -f <AIA_HOME>/Infrastructure/Install/AID/AIAInstallDriver.xml -DPropertiesFile=<AIA_HOME>/aia_instances/<AIA_INSTANCE>/config/AIAInstallProperties.xml -DDeploymentPlan=<AIA_HOME>/pips/SiebelOIC/DeploymentPlans/SiebelOICDP.xml -DSupplementaryDeploymentPlan=<AIA_HOME>/pips/SiebelOIC/DeploymentPlans/SiebelOICSupplementaryDP.xml -l <AIA_HOME>/pips/SiebelOIC/DeploymentPlans/SiebelOIC.log |
|
Microsoft Windows |
ant -f <AIA_HOME>\Infrastructure\Install\AID\AIAInstallDriver.xml -DPropertiesFile=<AIA_HOME>\aia_instances\<AIA_INSTANCE>\config\AIAInstallProperties.xml -DDeploymentPlan=<AIA_HOME>\pips\SiebelOIC\DeploymentPlans\SiebelOICDP.xml -DSupplementaryDeploymentPlan=<AIA_HOME>\pips\SiebelOIC\DeploymentPlans\SiebelOICSupplementaryDP.xml -l <AIA_HOME>\pips\SiebelOIC\DeploymentPlans\SiebelOIC.log |
Note:
In Windows 2008, 2008 R2 and Vista, run the command prompt as an administrator (elevated mode). If the command prompt is invoked in normal mode, the PIPs are not displayed.Review the log file in the location specified in the command to verify successful deployment.
Oracle AIA ships artifacts in AIA Lifecycle Workbench which can be used in your integrations. These artifacts are created using FMW technologies such as BPEL and Mediator and are natively supported by AIA Foundation Pack tools such as Project Lifecycle Workbench, Harvester, Deployment Generator, AIA Deployment Driver (ADD). These are called native artifacts and they include SOA artifact types such as composites, DataSources, DVM, xRef, and so on. These artifacts can be modified or new natively supported artifacts can be added using the AIA Lifecyle Workbench and a BOM.xml file can be generated.
AIA PIP development teams, most often, also require deployment of artifact types that are beyond what is supported by the Project Lifecycle Workbench and AIA Harvester. For instance, integration may require artifacts such as, Java applications, Shell Scripts, ANT based build scripts which constitute part of integration landscape in addition to the artifacts that are delivered by AIA. AIA also supports deployment of these supplementary artifacts. However, you must modify and add new non native artifacts outside AIA Lifecycle Workbench.
For more information on deploying artifacts, see Oracle Fusion Middleware Developer's Guide for Oracle Application Integration Architecture Foundation Pack, "Generating Deployment Plans and Deploying Artifacts".
This section discusses the postdeployment configurations for Siebel CRM to OIC Integration. This section includes the following:
Associating the Oracle Data Integrator Console with the Work Repository
Populating the COMPENSATION_ORGANIZATION_ID Cross-Reference Manually
The Oracle Data Integrator Console must be associated with the work repository that is created for the Siebel CRM to OIC integration.
For information on associating the Oracle Data Integrator Console with the work repository, see Oracle Fusion Middleware Developer's Guide for Oracle Data Integrator, "Creating a Repository Connection" in "Performing Administrative Operations."
The COMPENSATION_ORGANIZATION_ID cross-reference table dynamically maps values between Siebel CRM and Oracle Incentive Compensation.
An example of the COMPENSATION_ORGANIZATION_ID cross-reference table is shown here:
Table 27-10 COMPENSATION_ORGANIZATION_ID Cross-Reference Table
| EBS_01 | SEBL_01 | COMMON |
|---|---|---|
|
204 |
1CE-2MN |
204 |
|
204 |
1CE-2UU |
204 |
|
911 |
88-25CI5 |
88-25CI5 |
Manually populate the COMPENSATION_ORGANIZATION_ID cross-reference in the XREF_DATA table in the AIA XREF schema.
For information on populating the COMPENSATION_ORGANIZATION_ID cross-reference manually, see Oracle Fusion Middleware Developer's Guide for Oracle SOA Suite, "Populating Cross-Reference Tables."
Execute the CREATESIEBELVIEWS - 001 scenario to create Siebel views.
Start Oracle Data Integrator Console by logging into http://<hostname>:<port>/odiconsole.
On the Browse tab, click Runtime, Scenarios, All Scenarios, and then select CREATESIEBELVIEWS - 001. Right-click, then select Execute.
To verify the Siebel CRM to OIC deployment:
Open the log files from the following location and look for warnings and error messages:
For Linux, Solaris SPARC, HP-UX and IBM AIX Based Systems: Review the install log located at <AIA_HOME>/aia_instances/<instance name>/logs to verify that the PIP is successfully installed.
For Microsoft Windows: Review the install log located at <AIA_HOME>\aia_instances\<instance name>\logs to verify that the PIP is successfully installed.
Start Oracle Data Integrator Console by logging into http://<hostname>:<port>/odiconsole, and confirm that the Siebel CRM to OIC components are present.
Obtain the user name and password from your system administrator.
On the Browse tab, click Design Time, Projects, and confirm that the following projects are present:
SiebelCRMToEbizOICSalesOrderProject
SiebelCRMToEbizORMProject
On the Browse tab, click Runtime, Scenarios, All Scenarios, and confirm that the following scenarios are present:
LOADACTIONCODEDVM
LOADAIACONFIGURATIONPROPERTIES
LOADBUTOPREPROCESSFLAGDVM
LOADCOUNTRYDVM
LOADCURRENCYCODEDVM
LOADSTATEDVM
LOADUNITOFMEASUREDVM
LOAD_SIEBELRESOURCEDATATOEBIZ_PKG
LOAD_SIEBELSALESORDERDATATOEBIZ_PKG
LOAD_SIEBELSALESREPDATATOEBIZ_PKG
LOAD_SIEBELUSERDATATOEBIZ_PKG
On the Browse tab, click Topology, Data Servers and confirm that the following data servers are present:
AIAConfigurationProperties
AIADS
EbizDS
OICBUToPreProcessFlagDVM
OICCountryDVM
OICCurrencyDVM
OICSalesOrderActionCodeDVM
OICStateDVM
OICUnitOfMeasureDVM
SiebelDS
On the Browse tab, click Topology, Schemas and confirm that the following logical schemas are present:
AIAConfigurationProperties
ESB_XREF
EbizOIC
OICBUToPreProcessFlagDVM
OICCountryDVM
OICCurrencyDVM
OICSalesOrderActionCodeDVM
OICStateDVM
OICUnitOfMeasureDVM
SiebelCRM
On the Browse tab, click Topology, Contexts and confirm that the SiebelCRMToEbizOICContext context is present.
On the Browse tab, click Topology, Agents, Physical Agents and confirm that the SiebelCRMToEbizOICAgent physical agent is present.
On the Browse tab, click Topology, Agents, Logical Agents and confirm that the SiebelCRMToEbizOICAgent logical agent is present.
For implementation, see Siebel CRM Integration to Oracle Incentive Compensation Implementation Guide.
To undeploy the PIP from Fusion Middleware Server:
Navigate to <AIA_Instance>/bin and run the command source aiaenv.sh for Linux based systems and aiaenv.bat for Microsoft Windows to configure the environment.
Run the command for your platform.
Table 27-11 Undeployment Command for the Siebel CRM to OIC Integration
| Platform | Undeployment Command |
|---|---|
|
Linux Solaris SPARC IBM AIX Based Systems. HP-UX |
ant Uninstall -f <AIA_HOME>/Infrastructure/Install/AID/AIAInstallDriver.xml -DPropertiesFile=<AIA_HOME>/aia_instances/<AIA_Instance_name>/config/AIAInstallProperties.xml -DDeploymentPlan=<AIA_HOME>/pips/SiebelOIC/DeploymentPlans/SiebelOICUndeployDP.xml -l <AIA_HOME>/pips/SiebelOIC/DeploymentPlans/SiebelOICUndeployDP.log |
|
Microsoft Windows |
ant Uninstall -f <AIA_HOME>\Infrastructure\Install\AID\AIAInstallDriver.xml -DPropertiesFile=<AIA_HOME>\aia_instances\<AIA_Instance_name>\config\AIAInstallProperties.xml -DDeploymentPlan=<AIA_HOME>\pips\SiebelOIC\DeploymentPlans\SiebelOICUndeployDP.xml -l <AIA_HOME>\pips\SiebelOIC\DeploymentPlans\SiebelOICUndeployDP.log |
Restart the SOA server.
Uninstall the PIP following the instructions in Chapter 36, "Uninstalling Oracle AIA".